UNPKG

21.4 kBJSONView Raw
1{
2 "project": {
3 "name": "jquery.nanoscroller",
4 "description": "A jQuery plugin that offers a simplistic way of implementing Lion OS scrollbars.",
5 "version": "0.8.6",
6 "url": "http://jamesflorentino.github.com/nanoScrollerJS/"
7 },
8 "files": {
9 "bin/javascripts/jquery.nanoscroller.js": {
10 "name": "bin/javascripts/jquery.nanoscroller.js",
11 "modules": {},
12 "classes": {
13 "NanoScroll": 1
14 },
15 "fors": {},
16 "namespaces": {}
17 }
18 },
19 "modules": {},
20 "classes": {
21 "NanoScroll": {
22 "name": "NanoScroll",
23 "shortname": "NanoScroll",
24 "classitems": [],
25 "plugins": [],
26 "extensions": [],
27 "plugin_for": [],
28 "extension_for": [],
29 "file": "bin/javascripts/jquery.nanoscroller.js",
30 "line": 354,
31 "params": [
32 {
33 "name": "element",
34 "description": "the main element",
35 "type": "HTMLElement|Node"
36 },
37 {
38 "name": "options",
39 "description": "nanoScroller's options",
40 "type": "Object"
41 }
42 ],
43 "is_constructor": 1
44 }
45 },
46 "classitems": [
47 {
48 "file": "bin/javascripts/jquery.nanoscroller.js",
49 "line": 19,
50 "description": "a classname for the pane element.",
51 "itemtype": "property",
52 "name": "paneClass",
53 "type": "String",
54 "default": "'nano-pane'",
55 "class": "NanoScroll"
56 },
57 {
58 "file": "bin/javascripts/jquery.nanoscroller.js",
59 "line": 27,
60 "description": "a classname for the slider element.",
61 "itemtype": "property",
62 "name": "sliderClass",
63 "type": "String",
64 "default": "'nano-slider'",
65 "class": "NanoScroll"
66 },
67 {
68 "file": "bin/javascripts/jquery.nanoscroller.js",
69 "line": 35,
70 "description": "a classname for the content element.",
71 "itemtype": "property",
72 "name": "contentClass",
73 "type": "String",
74 "default": "'nano-content'",
75 "class": "NanoScroll"
76 },
77 {
78 "file": "bin/javascripts/jquery.nanoscroller.js",
79 "line": 43,
80 "description": "a setting to enable native scrolling in iOS devices.",
81 "itemtype": "property",
82 "name": "iOSNativeScrolling",
83 "type": "Boolean",
84 "default": "false",
85 "class": "NanoScroll"
86 },
87 {
88 "file": "bin/javascripts/jquery.nanoscroller.js",
89 "line": 51,
90 "description": "a setting to prevent the rest of the page being\nscrolled when user scrolls the `.content` element.",
91 "itemtype": "property",
92 "name": "preventPageScrolling",
93 "type": "Boolean",
94 "default": "false",
95 "class": "NanoScroll"
96 },
97 {
98 "file": "bin/javascripts/jquery.nanoscroller.js",
99 "line": 60,
100 "description": "a setting to disable binding to the resize event.",
101 "itemtype": "property",
102 "name": "disableResize",
103 "type": "Boolean",
104 "default": "false",
105 "class": "NanoScroll"
106 },
107 {
108 "file": "bin/javascripts/jquery.nanoscroller.js",
109 "line": 68,
110 "description": "a setting to make the scrollbar always visible.",
111 "itemtype": "property",
112 "name": "alwaysVisible",
113 "type": "Boolean",
114 "default": "false",
115 "class": "NanoScroll"
116 },
117 {
118 "file": "bin/javascripts/jquery.nanoscroller.js",
119 "line": 76,
120 "description": "a default timeout for the `flash()` method.",
121 "itemtype": "property",
122 "name": "flashDelay",
123 "type": "Number",
124 "default": "1500",
125 "class": "NanoScroll"
126 },
127 {
128 "file": "bin/javascripts/jquery.nanoscroller.js",
129 "line": 84,
130 "description": "a minimum height for the `.slider` element.",
131 "itemtype": "property",
132 "name": "sliderMinHeight",
133 "type": "Number",
134 "default": "20",
135 "class": "NanoScroll"
136 },
137 {
138 "file": "bin/javascripts/jquery.nanoscroller.js",
139 "line": 92,
140 "description": "a maximum height for the `.slider` element.",
141 "itemtype": "property",
142 "name": "sliderMaxHeight",
143 "type": "Number",
144 "default": "null",
145 "class": "NanoScroll"
146 },
147 {
148 "file": "bin/javascripts/jquery.nanoscroller.js",
149 "line": 100,
150 "description": "an alternate document context.",
151 "itemtype": "property",
152 "name": "documentContext",
153 "type": "Document",
154 "default": "null",
155 "class": "NanoScroll"
156 },
157 {
158 "file": "bin/javascripts/jquery.nanoscroller.js",
159 "line": 108,
160 "description": "an alternate window context.",
161 "itemtype": "property",
162 "name": "windowContext",
163 "type": "Window",
164 "default": "null",
165 "class": "NanoScroll"
166 },
167 {
168 "file": "bin/javascripts/jquery.nanoscroller.js",
169 "line": 117,
170 "itemtype": "property",
171 "name": "SCROLLBAR",
172 "type": "String",
173 "static": 1,
174 "final": 1,
175 "access": "private",
176 "tagname": "",
177 "class": "NanoScroll"
178 },
179 {
180 "file": "bin/javascripts/jquery.nanoscroller.js",
181 "line": 126,
182 "itemtype": "property",
183 "name": "SCROLL",
184 "type": "String",
185 "static": 1,
186 "final": 1,
187 "access": "private",
188 "tagname": "",
189 "class": "NanoScroll"
190 },
191 {
192 "file": "bin/javascripts/jquery.nanoscroller.js",
193 "line": 135,
194 "itemtype": "property",
195 "name": "MOUSEDOWN",
196 "type": "String",
197 "final": 1,
198 "access": "private",
199 "tagname": "",
200 "class": "NanoScroll"
201 },
202 {
203 "file": "bin/javascripts/jquery.nanoscroller.js",
204 "line": 143,
205 "itemtype": "property",
206 "name": "MOUSEENTER",
207 "type": "String",
208 "final": 1,
209 "access": "private",
210 "tagname": "",
211 "class": "NanoScroll"
212 },
213 {
214 "file": "bin/javascripts/jquery.nanoscroller.js",
215 "line": 151,
216 "itemtype": "property",
217 "name": "MOUSEMOVE",
218 "type": "String",
219 "static": 1,
220 "final": 1,
221 "access": "private",
222 "tagname": "",
223 "class": "NanoScroll"
224 },
225 {
226 "file": "bin/javascripts/jquery.nanoscroller.js",
227 "line": 160,
228 "itemtype": "property",
229 "name": "MOUSEWHEEL",
230 "type": "String",
231 "final": 1,
232 "access": "private",
233 "tagname": "",
234 "class": "NanoScroll"
235 },
236 {
237 "file": "bin/javascripts/jquery.nanoscroller.js",
238 "line": 168,
239 "itemtype": "property",
240 "name": "MOUSEUP",
241 "type": "String",
242 "static": 1,
243 "final": 1,
244 "access": "private",
245 "tagname": "",
246 "class": "NanoScroll"
247 },
248 {
249 "file": "bin/javascripts/jquery.nanoscroller.js",
250 "line": 177,
251 "itemtype": "property",
252 "name": "RESIZE",
253 "type": "String",
254 "final": 1,
255 "access": "private",
256 "tagname": "",
257 "class": "NanoScroll"
258 },
259 {
260 "file": "bin/javascripts/jquery.nanoscroller.js",
261 "line": 185,
262 "itemtype": "property",
263 "name": "DRAG",
264 "type": "String",
265 "static": 1,
266 "final": 1,
267 "access": "private",
268 "tagname": "",
269 "class": "NanoScroll"
270 },
271 {
272 "file": "bin/javascripts/jquery.nanoscroller.js",
273 "line": 194,
274 "itemtype": "property",
275 "name": "ENTER",
276 "type": "String",
277 "static": 1,
278 "final": 1,
279 "access": "private",
280 "tagname": "",
281 "class": "NanoScroll"
282 },
283 {
284 "file": "bin/javascripts/jquery.nanoscroller.js",
285 "line": 203,
286 "itemtype": "property",
287 "name": "UP",
288 "type": "String",
289 "static": 1,
290 "final": 1,
291 "access": "private",
292 "tagname": "",
293 "class": "NanoScroll"
294 },
295 {
296 "file": "bin/javascripts/jquery.nanoscroller.js",
297 "line": 212,
298 "itemtype": "property",
299 "name": "PANEDOWN",
300 "type": "String",
301 "static": 1,
302 "final": 1,
303 "access": "private",
304 "tagname": "",
305 "class": "NanoScroll"
306 },
307 {
308 "file": "bin/javascripts/jquery.nanoscroller.js",
309 "line": 221,
310 "itemtype": "property",
311 "name": "DOMSCROLL",
312 "type": "String",
313 "static": 1,
314 "final": 1,
315 "access": "private",
316 "tagname": "",
317 "class": "NanoScroll"
318 },
319 {
320 "file": "bin/javascripts/jquery.nanoscroller.js",
321 "line": 230,
322 "itemtype": "property",
323 "name": "DOWN",
324 "type": "String",
325 "static": 1,
326 "final": 1,
327 "access": "private",
328 "tagname": "",
329 "class": "NanoScroll"
330 },
331 {
332 "file": "bin/javascripts/jquery.nanoscroller.js",
333 "line": 239,
334 "itemtype": "property",
335 "name": "WHEEL",
336 "type": "String",
337 "static": 1,
338 "final": 1,
339 "access": "private",
340 "tagname": "",
341 "class": "NanoScroll"
342 },
343 {
344 "file": "bin/javascripts/jquery.nanoscroller.js",
345 "line": 248,
346 "itemtype": "property",
347 "name": "KEYDOWN",
348 "type": "String",
349 "static": 1,
350 "final": 1,
351 "access": "private",
352 "tagname": "",
353 "class": "NanoScroll"
354 },
355 {
356 "file": "bin/javascripts/jquery.nanoscroller.js",
357 "line": 257,
358 "itemtype": "property",
359 "name": "KEYUP",
360 "type": "String",
361 "static": 1,
362 "final": 1,
363 "access": "private",
364 "tagname": "",
365 "class": "NanoScroll"
366 },
367 {
368 "file": "bin/javascripts/jquery.nanoscroller.js",
369 "line": 266,
370 "itemtype": "property",
371 "name": "TOUCHMOVE",
372 "type": "String",
373 "static": 1,
374 "final": 1,
375 "access": "private",
376 "tagname": "",
377 "class": "NanoScroll"
378 },
379 {
380 "file": "bin/javascripts/jquery.nanoscroller.js",
381 "line": 275,
382 "itemtype": "property",
383 "name": "BROWSER_IS_IE7",
384 "type": "Boolean",
385 "static": 1,
386 "final": 1,
387 "access": "private",
388 "tagname": "",
389 "class": "NanoScroll"
390 },
391 {
392 "file": "bin/javascripts/jquery.nanoscroller.js",
393 "line": 284,
394 "itemtype": "property",
395 "name": "BROWSER_SCROLLBAR_WIDTH",
396 "type": "Number",
397 "static": 1,
398 "default": "null",
399 "access": "private",
400 "tagname": "",
401 "class": "NanoScroll"
402 },
403 {
404 "file": "bin/javascripts/jquery.nanoscroller.js",
405 "line": 319,
406 "description": "Returns browser's native scrollbar width",
407 "itemtype": "method",
408 "name": "getBrowserScrollbarWidth",
409 "return": {
410 "description": "the scrollbar width in pixels",
411 "type": "Number"
412 },
413 "static": 1,
414 "access": "private",
415 "tagname": "",
416 "class": "NanoScroll"
417 },
418 {
419 "file": "bin/javascripts/jquery.nanoscroller.js",
420 "line": 384,
421 "description": "Prevents the rest of the page being scrolled\nwhen user scrolls the `.nano-content` element.",
422 "itemtype": "method",
423 "name": "preventScrolling",
424 "params": [
425 {
426 "name": "event",
427 "description": "",
428 "type": "Event"
429 },
430 {
431 "name": "direction",
432 "description": "Scroll direction (up or down)",
433 "type": "String"
434 }
435 ],
436 "access": "private",
437 "tagname": "",
438 "class": "NanoScroll"
439 },
440 {
441 "file": "bin/javascripts/jquery.nanoscroller.js",
442 "line": 412,
443 "description": "Enable iOS native scrolling",
444 "itemtype": "method",
445 "name": "nativeScrolling",
446 "access": "private",
447 "tagname": "",
448 "class": "NanoScroll"
449 },
450 {
451 "file": "bin/javascripts/jquery.nanoscroller.js",
452 "line": 427,
453 "description": "Updates those nanoScroller properties that\nare related to current scrollbar position.",
454 "itemtype": "method",
455 "name": "updateScrollValues",
456 "access": "private",
457 "tagname": "",
458 "class": "NanoScroll"
459 },
460 {
461 "file": "bin/javascripts/jquery.nanoscroller.js",
462 "line": 456,
463 "description": "Updates CSS styles for current scroll position.\nUses CSS 2d transfroms and `window.requestAnimationFrame` if available.",
464 "itemtype": "method",
465 "name": "setOnScrollStyles",
466 "access": "private",
467 "tagname": "",
468 "class": "NanoScroll"
469 },
470 {
471 "file": "bin/javascripts/jquery.nanoscroller.js",
472 "line": 489,
473 "description": "Creates event related methods",
474 "itemtype": "method",
475 "name": "createEvents",
476 "access": "private",
477 "tagname": "",
478 "class": "NanoScroll"
479 },
480 {
481 "file": "bin/javascripts/jquery.nanoscroller.js",
482 "line": 603,
483 "description": "Adds event listeners with jQuery.",
484 "itemtype": "method",
485 "name": "addEvents",
486 "access": "private",
487 "tagname": "",
488 "class": "NanoScroll"
489 },
490 {
491 "file": "bin/javascripts/jquery.nanoscroller.js",
492 "line": 624,
493 "description": "Removes event listeners with jQuery.",
494 "itemtype": "method",
495 "name": "removeEvents",
496 "access": "private",
497 "tagname": "",
498 "class": "NanoScroll"
499 },
500 {
501 "file": "bin/javascripts/jquery.nanoscroller.js",
502 "line": 642,
503 "description": "Generates nanoScroller's scrollbar and elements for it.",
504 "itemtype": "method",
505 "name": "generate",
506 "chainable": 1,
507 "access": "private",
508 "tagname": "",
509 "class": "NanoScroll"
510 },
511 {
512 "file": "bin/javascripts/jquery.nanoscroller.js",
513 "line": 677,
514 "itemtype": "method",
515 "name": "restore",
516 "access": "private",
517 "tagname": "",
518 "class": "NanoScroll"
519 },
520 {
521 "file": "bin/javascripts/jquery.nanoscroller.js",
522 "line": 691,
523 "description": "Resets nanoScroller's scrollbar.",
524 "itemtype": "method",
525 "name": "reset",
526 "chainable": 1,
527 "example": [
528 "\n $(\".nano\").nanoScroller();"
529 ],
530 "class": "NanoScroll"
531 },
532 {
533 "file": "bin/javascripts/jquery.nanoscroller.js",
534 "line": 774,
535 "itemtype": "method",
536 "name": "scroll",
537 "access": "private",
538 "tagname": "",
539 "example": [
540 "\n $(\".nano\").nanoScroller({ scroll: 'top' });"
541 ],
542 "class": "NanoScroll"
543 },
544 {
545 "file": "bin/javascripts/jquery.nanoscroller.js",
546 "line": 796,
547 "description": "Scroll at the bottom with an offset value",
548 "itemtype": "method",
549 "name": "scrollBottom",
550 "params": [
551 {
552 "name": "offsetY",
553 "description": "",
554 "type": "Number"
555 }
556 ],
557 "chainable": 1,
558 "example": [
559 "\n $(\".nano\").nanoScroller({ scrollBottom: value });"
560 ],
561 "class": "NanoScroll"
562 },
563 {
564 "file": "bin/javascripts/jquery.nanoscroller.js",
565 "line": 815,
566 "description": "Scroll at the top with an offset value",
567 "itemtype": "method",
568 "name": "scrollTop",
569 "params": [
570 {
571 "name": "offsetY",
572 "description": "",
573 "type": "Number"
574 }
575 ],
576 "chainable": 1,
577 "example": [
578 "\n $(\".nano\").nanoScroller({ scrollTop: value });"
579 ],
580 "class": "NanoScroll"
581 },
582 {
583 "file": "bin/javascripts/jquery.nanoscroller.js",
584 "line": 834,
585 "description": "Scroll to an element",
586 "itemtype": "method",
587 "name": "scrollTo",
588 "params": [
589 {
590 "name": "node",
591 "description": "A node to scroll to.",
592 "type": "Node"
593 }
594 ],
595 "chainable": 1,
596 "example": [
597 "\n $(\".nano\").nanoScroller({ scrollTo: $('#a_node') });"
598 ],
599 "class": "NanoScroll"
600 },
601 {
602 "file": "bin/javascripts/jquery.nanoscroller.js",
603 "line": 852,
604 "description": "To stop the operation.\nThis option will tell the plugin to disable all event bindings and hide the gadget scrollbar from the UI.",
605 "itemtype": "method",
606 "name": "stop",
607 "chainable": 1,
608 "example": [
609 "\n $(\".nano\").nanoScroller({ stop: true });"
610 ],
611 "class": "NanoScroll"
612 },
613 {
614 "file": "bin/javascripts/jquery.nanoscroller.js",
615 "line": 875,
616 "description": "Destroys nanoScroller and restores browser's native scrollbar.",
617 "itemtype": "method",
618 "name": "destroy",
619 "chainable": 1,
620 "example": [
621 "\n $(\".nano\").nanoScroller({ destroy: true });"
622 ],
623 "class": "NanoScroll"
624 },
625 {
626 "file": "bin/javascripts/jquery.nanoscroller.js",
627 "line": 904,
628 "description": "To flash the scrollbar gadget for an amount of time defined in plugin settings (defaults to 1,5s).\nUseful if you want to show the user (e.g. on pageload) that there is more content waiting for him.",
629 "itemtype": "method",
630 "name": "flash",
631 "chainable": 1,
632 "example": [
633 "\n $(\".nano\").nanoScroller({ flash: true });"
634 ],
635 "class": "NanoScroll"
636 }
637 ],
638 "warnings": []
639}
\No newline at end of file