prettydocs_rails 1.1.16
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/LICENSE +57 -0
- data/README.md +91 -0
- data/Rakefile +34 -0
- data/app/assets/javascripts/prettydocs.js +6 -0
- data/app/assets/stylesheets/prettydocs.scss +6 -0
- data/lib/prettydocs_rails.rb +24 -0
- data/lib/prettydocs_rails/engine.rb +10 -0
- data/lib/prettydocs_rails/version.rb +3 -0
- data/vendor/assets/images/demo/appkit-account-billing-thumb.jpg +0 -0
- data/vendor/assets/images/demo/appkit-account-billing.jpg +0 -0
- data/vendor/assets/images/demo/appkit-account-drive-thumb.jpg +0 -0
- data/vendor/assets/images/demo/appkit-account-drive.jpg +0 -0
- data/vendor/assets/images/demo/appkit-account-messages-thumb.jpg +0 -0
- data/vendor/assets/images/demo/appkit-account-messages.jpg +0 -0
- data/vendor/assets/images/demo/appkit-account-profile-thumb.jpg +0 -0
- data/vendor/assets/images/demo/appkit-account-profile.jpg +0 -0
- data/vendor/assets/images/demo/appkit-account-reminders-thumb.jpg +0 -0
- data/vendor/assets/images/demo/appkit-account-reminders.jpg +0 -0
- data/vendor/assets/images/demo/appkit-account-settings-thumb.jpg +0 -0
- data/vendor/assets/images/demo/appkit-account-settings.jpg +0 -0
- data/vendor/assets/images/demo/appkit-activities-thumb.jpg +0 -0
- data/vendor/assets/images/demo/appkit-activities.jpg +0 -0
- data/vendor/assets/images/demo/appkit-chart-chartjs-thumb.jpg +0 -0
- data/vendor/assets/images/demo/appkit-chart-chartjs.jpg +0 -0
- data/vendor/assets/images/demo/appkit-chart-flot-thumb.jpg +0 -0
- data/vendor/assets/images/demo/appkit-chart-flot.jpg +0 -0
- data/vendor/assets/images/demo/appkit-chart-inline-thumb.jpg +0 -0
- data/vendor/assets/images/demo/appkit-chart-inline.jpg +0 -0
- data/vendor/assets/images/demo/appkit-chart-morris-thumb.jpg +0 -0
- data/vendor/assets/images/demo/appkit-chart-morris.jpg +0 -0
- data/vendor/assets/images/demo/appkit-dashboard-1-thumb.jpg +0 -0
- data/vendor/assets/images/demo/appkit-dashboard-1.jpg +0 -0
- data/vendor/assets/images/demo/appkit-dashboard-2-thumb.jpg +0 -0
- data/vendor/assets/images/demo/appkit-dashboard-2.jpg +0 -0
- data/vendor/assets/images/demo/appkit-dashboard-3-thumb.jpg +0 -0
- data/vendor/assets/images/demo/appkit-dashboard-3.jpg +0 -0
- data/vendor/assets/images/demo/appkit-dashboard-4-thumb.jpg +0 -0
- data/vendor/assets/images/demo/appkit-dashboard-4.jpg +0 -0
- data/vendor/assets/images/demo/appkit-discussion-thumb.jpg +0 -0
- data/vendor/assets/images/demo/appkit-discussion.jpg +0 -0
- data/vendor/assets/images/demo/appkit-discussions-thumb.jpg +0 -0
- data/vendor/assets/images/demo/appkit-discussions.jpg +0 -0
- data/vendor/assets/images/demo/appkit-inbox-thumb.jpg +0 -0
- data/vendor/assets/images/demo/appkit-inbox.jpg +0 -0
- data/vendor/assets/images/demo/appkit-member-thumb.jpg +0 -0
- data/vendor/assets/images/demo/appkit-member.jpg +0 -0
- data/vendor/assets/images/demo/appkit-members-thumb.jpg +0 -0
- data/vendor/assets/images/demo/appkit-members.jpg +0 -0
- data/vendor/assets/images/demo/appkit-pricing-thumb.jpg +0 -0
- data/vendor/assets/images/demo/appkit-pricing.jpg +0 -0
- data/vendor/assets/images/demo/appkit-project-thumb.jpg +0 -0
- data/vendor/assets/images/demo/appkit-project.jpg +0 -0
- data/vendor/assets/images/demo/appkit-projects-thumb.jpg +0 -0
- data/vendor/assets/images/demo/appkit-projects.jpg +0 -0
- data/vendor/assets/images/demo/appkit-tickets-thumb.jpg +0 -0
- data/vendor/assets/images/demo/appkit-tickets.jpg +0 -0
- data/vendor/assets/images/demo/appkit-timeline-thumb.jpg +0 -0
- data/vendor/assets/images/demo/appkit-timeline.jpg +0 -0
- data/vendor/assets/images/demo/appkit-widgets-thumb.jpg +0 -0
- data/vendor/assets/images/demo/appkit-widgets.jpg +0 -0
- data/vendor/assets/images/demo/author-profile.png +0 -0
- data/vendor/assets/images/demo/elegant-icon-font.jpg +0 -0
- data/vendor/assets/images/demo/fontawesome-icons.png +0 -0
- data/vendor/assets/images/demo/theme-atom.png +0 -0
- data/vendor/assets/images/demo/theme-college-green.png +0 -0
- data/vendor/assets/images/demo/theme-decibel.png +0 -0
- data/vendor/assets/images/demo/theme-delta.png +0 -0
- data/vendor/assets/images/demo/theme-devaid.png +0 -0
- data/vendor/assets/images/demo/theme-developer.png +0 -0
- data/vendor/assets/images/demo/theme-devstudio.png +0 -0
- data/vendor/assets/images/demo/theme-epicure.png +0 -0
- data/vendor/assets/images/demo/theme-matrimony.png +0 -0
- data/vendor/assets/images/demo/theme-onboard.png +0 -0
- data/vendor/assets/images/demo/theme-tempo.png +0 -0
- data/vendor/assets/images/demo/theme-trades.png +0 -0
- data/vendor/assets/images/demo/theme-velocity.png +0 -0
- data/vendor/assets/images/empty.gif +0 -0
- data/vendor/assets/javascripts/ekko-lightbox.js +602 -0
- data/vendor/assets/javascripts/jquery-match-height/CHANGELOG.md +24 -0
- data/vendor/assets/javascripts/jquery-match-height/LICENSE +21 -0
- data/vendor/assets/javascripts/jquery-match-height/README.md +170 -0
- data/vendor/assets/javascripts/jquery-match-height/bower.json +26 -0
- data/vendor/assets/javascripts/jquery-match-height/jquery.matchHeight-min.js +10 -0
- data/vendor/assets/javascripts/jquery-match-height/jquery.matchHeight.js +298 -0
- data/vendor/assets/javascripts/jquery-match-height/matchHeight.jquery.json +32 -0
- data/vendor/assets/javascripts/jquery-match-height/test.css +265 -0
- data/vendor/assets/javascripts/jquery-match-height/test.html +288 -0
- data/vendor/assets/javascripts/jquery-match-height/test.js +33 -0
- data/vendor/assets/javascripts/jquery-scrollTo/CHANGELOG +178 -0
- data/vendor/assets/javascripts/jquery-scrollTo/LICENSE +22 -0
- data/vendor/assets/javascripts/jquery-scrollTo/README.md +151 -0
- data/vendor/assets/javascripts/jquery-scrollTo/bower.json +28 -0
- data/vendor/assets/javascripts/jquery-scrollTo/composer.json +32 -0
- data/vendor/assets/javascripts/jquery-scrollTo/demo/css/style.css +150 -0
- data/vendor/assets/javascripts/jquery-scrollTo/demo/css/style.old.css +69 -0
- data/vendor/assets/javascripts/jquery-scrollTo/demo/index.html +252 -0
- data/vendor/assets/javascripts/jquery-scrollTo/demo/index.old.html +128 -0
- data/vendor/assets/javascripts/jquery-scrollTo/jquery.scrollTo.js +210 -0
- data/vendor/assets/javascripts/jquery-scrollTo/jquery.scrollTo.min.js +7 -0
- data/vendor/assets/javascripts/jquery-scrollTo/package.json +20 -0
- data/vendor/assets/javascripts/jquery-scrollTo/tests/ElemMaxY-compat.html +21 -0
- data/vendor/assets/javascripts/jquery-scrollTo/tests/ElemMaxY-quirks.html +20 -0
- data/vendor/assets/javascripts/jquery-scrollTo/tests/WinMaxY-compat.html +19 -0
- data/vendor/assets/javascripts/jquery-scrollTo/tests/WinMaxY-quirks.html +18 -0
- data/vendor/assets/javascripts/jquery-scrollTo/tests/WinMaxY-to-iframe-compat.html +20 -0
- data/vendor/assets/javascripts/jquery-scrollTo/tests/WinMaxY-to-iframe-quirks.html +19 -0
- data/vendor/assets/javascripts/jquery-scrollTo/tests/WinMaxY-with-iframe-compat.html +11 -0
- data/vendor/assets/javascripts/jquery-scrollTo/tests/WinMaxY-with-iframe-quirks.html +10 -0
- data/vendor/assets/javascripts/jquery-scrollTo/tests/index.html +24 -0
- data/vendor/assets/javascripts/jquery-scrollTo/tests/test.js +21 -0
- data/vendor/assets/javascripts/main.js +47 -0
- data/vendor/assets/javascripts/prism.js +18 -0
- data/vendor/assets/stylesheets/ekko-lightbox.scss +2 -0
- data/vendor/assets/stylesheets/prism.scss +163 -0
- data/vendor/assets/stylesheets/styles.scss +1267 -0
- metadata +267 -0
@@ -0,0 +1,33 @@
|
|
1
|
+
/* see test.html for example matchHeight usage */
|
2
|
+
|
3
|
+
/* testing page code only, you wont need this! */
|
4
|
+
|
5
|
+
(function() {
|
6
|
+
|
7
|
+
$(function() {
|
8
|
+
bindTestOptions();
|
9
|
+
});
|
10
|
+
|
11
|
+
var bindTestOptions = function() {
|
12
|
+
resetTestOptions();
|
13
|
+
$('.option').change(resetTestOptions);
|
14
|
+
};
|
15
|
+
|
16
|
+
var resetTestOptions = function() {
|
17
|
+
// update test options
|
18
|
+
$('.option').each(function() {
|
19
|
+
var $this = $(this);
|
20
|
+
$('body').toggleClass($this.val(), $this.prop('checked'));
|
21
|
+
});
|
22
|
+
|
23
|
+
// update byRow option
|
24
|
+
var byRow = $('body').hasClass('test-rows');
|
25
|
+
$.each($.fn.matchHeight._groups, function() {
|
26
|
+
this.byRow = byRow;
|
27
|
+
});
|
28
|
+
|
29
|
+
// update all heights
|
30
|
+
$.fn.matchHeight._update();
|
31
|
+
};
|
32
|
+
|
33
|
+
})();
|
@@ -0,0 +1,178 @@
|
|
1
|
+
2.1.1
|
2
|
+
[Fix]
|
3
|
+
- Slight change so define function is not minified (#91)
|
4
|
+
|
5
|
+
2.1.0
|
6
|
+
[Enhancement]
|
7
|
+
- Avoid animating a needless axis
|
8
|
+
[Feature]
|
9
|
+
- Implemented interrupt setting, if true will stop animating on user (manual) scroll (#67)
|
10
|
+
|
11
|
+
2.0.1
|
12
|
+
[Fix]
|
13
|
+
- Fixed "queue" setting conflicts with $().animate(), forced to always get there as true
|
14
|
+
|
15
|
+
2.0.0
|
16
|
+
[Feature]
|
17
|
+
- All settings are passed to jQuery.animate() meaning it now supports even more settings
|
18
|
+
[Enhancement]
|
19
|
+
- $(window)._scrollable() is no longer needed, the element is always the window
|
20
|
+
- Delegating to jQuery the get/set of element/window scroll positions.
|
21
|
+
[Compat]
|
22
|
+
- Dropped support for $.scrollTo.window() and $(window)._scrollable()
|
23
|
+
[Fix]
|
24
|
+
- Now works consistenly on Chrome 40
|
25
|
+
- Now works correctly on Windows Phone
|
26
|
+
- Now works correctly on Android Browsers
|
27
|
+
- Now works correctly on iOS Browsers
|
28
|
+
|
29
|
+
1.4.14
|
30
|
+
[Misc]
|
31
|
+
- Internal both() function will handle nulls correctly
|
32
|
+
|
33
|
+
1.4.13
|
34
|
+
[Misc]
|
35
|
+
- Support for CommonJS / NPM added by durango
|
36
|
+
|
37
|
+
1.4.12
|
38
|
+
[Fix]
|
39
|
+
- Fixed selector matching body fails on window scrolling
|
40
|
+
|
41
|
+
1.4.11
|
42
|
+
[Misc]
|
43
|
+
- Reverted changes from 1.4.10
|
44
|
+
|
45
|
+
1.4.10
|
46
|
+
[Enhancement]
|
47
|
+
- Giving the plugin an AMD module id so it can be required (f.e by localScroll)
|
48
|
+
|
49
|
+
1.4.9
|
50
|
+
[Enhancement]
|
51
|
+
- "offset" setting can now be a function as well (#60)
|
52
|
+
|
53
|
+
1.4.8
|
54
|
+
[Enhancement]
|
55
|
+
- Added support for AMD
|
56
|
+
|
57
|
+
1.4.7
|
58
|
+
[Misc]
|
59
|
+
- Changed spacing
|
60
|
+
- Changed licensing to MIT
|
61
|
+
- Repo is compliant with official jquery plugins repository
|
62
|
+
|
63
|
+
1.4.6
|
64
|
+
[Fix]
|
65
|
+
- Fixed first argument of onAfter and onAfterFirst was original target and should be "parsed" target
|
66
|
+
|
67
|
+
1.4.5
|
68
|
+
[Fix]
|
69
|
+
- Fixed passing a negative scroll value crashes
|
70
|
+
|
71
|
+
1.4.4
|
72
|
+
[Change]
|
73
|
+
- Re-released as 1.4.4 to avoid issues with bower
|
74
|
+
|
75
|
+
1.4.3.1
|
76
|
+
[Fix]
|
77
|
+
- Fixed $.scrollTo(0) broken on 1.4.3
|
78
|
+
|
79
|
+
1.4.3
|
80
|
+
[Enhancement]
|
81
|
+
- Limit calculations can be disabled by setting the option 'limit' to false.
|
82
|
+
- Null target or unmatching selector don't break and fail silently
|
83
|
+
[Misc]
|
84
|
+
- Removed support for the deprecated setting 'speed'
|
85
|
+
[Fix]
|
86
|
+
- Removed $.browser.webkit so the plugin works with jQuery +1.8
|
87
|
+
|
88
|
+
1.4.2
|
89
|
+
[Feature]
|
90
|
+
- The plugin support percentages as target ('50%' or {top:'50%', left:'45%'})
|
91
|
+
- Exposed the max() calculation as $.scrollTo.max
|
92
|
+
[Enhancement]
|
93
|
+
- Renamed $.fn.scrollable to $.fn._scrollable to avoid conflicts with other plugins
|
94
|
+
[Fix]
|
95
|
+
- Fixing max calculations for regular DOM elements
|
96
|
+
|
97
|
+
1.4.1
|
98
|
+
[Feature]
|
99
|
+
- The target can be 'max' to scroll to the end while keeping it elegant.
|
100
|
+
[Enhancement]
|
101
|
+
- Default duration is 0 for jquery +1.3. Means sync animation
|
102
|
+
- The plugin works on all major browsers, on compat & quirks modes, including iframes.
|
103
|
+
- In addition to window/document, if html or body are received, the plugin will choose the right one.
|
104
|
+
[Fix]
|
105
|
+
- The plugin accepts floating numbers, Thanks Ramin
|
106
|
+
- Using jQuery.nodeName where neccessary so that this works on xml+xhtml
|
107
|
+
- The max() internal function wasn't completely accurrate, now it is 98% (except for IE on quirks mode and it's not too noticeable).
|
108
|
+
|
109
|
+
1.4
|
110
|
+
[Fix]
|
111
|
+
- Fixed the problem when scrolling the window to absolute positioned elements on Safari.
|
112
|
+
- Fixed the problem on Opera 9.5 when scrolling the window. That it always scrolls to 0.
|
113
|
+
[Feature]
|
114
|
+
- Added the settings object as 2nd argument to the onAfter callback.
|
115
|
+
- The 3rd argument of scrollTo can be just a function and it's used as the onAfter.
|
116
|
+
- Added full support for iframes (even max scroll calculation).
|
117
|
+
- Instead of $.scrollTo, $(window).scrollTo() and $(document).scrollTo() can be used.
|
118
|
+
- Added $().scrollable() that returns the real element to scroll, f.e: $(window).scrollable() == [body|html], works for iframes.
|
119
|
+
[Enhancement]
|
120
|
+
- Cleaned the code a bit, specially the comments
|
121
|
+
|
122
|
+
1.3.3
|
123
|
+
[Change]
|
124
|
+
- Changed the licensing from GPL to GPL+MIT.
|
125
|
+
|
126
|
+
1.3.2
|
127
|
+
[Enhancement]
|
128
|
+
- Small improvements to make the code shorter.
|
129
|
+
[Change]
|
130
|
+
- Removed the last argument received by onAfter as it was the same as the 'this' but jqueryfied.
|
131
|
+
|
132
|
+
1.3.1
|
133
|
+
[Feature]
|
134
|
+
- Exposed $.scrollTo.window() to get the element that needs to be animated, to scroll the window.
|
135
|
+
- Added option 'over'.
|
136
|
+
[Enhancement]
|
137
|
+
- Made the code as short as possible.
|
138
|
+
[Change]
|
139
|
+
- Changed the arguments received by onAfter
|
140
|
+
|
141
|
+
1.3
|
142
|
+
[Enhancement]
|
143
|
+
- Added semicolon to the start, for safe file concatenation
|
144
|
+
- Added a limit check, values below 0 or over the maximum are fixed.
|
145
|
+
- Now it should work faster, only one of html or body go through all the processing, instead of both for all browsers.
|
146
|
+
[Fix]
|
147
|
+
- Fixed the behavior for Opera, which seemed to react to both changes on <html> and <body>.
|
148
|
+
- The border is also reduced, when 'margin' is set to true.
|
149
|
+
[Change]
|
150
|
+
- The option speed has been renamed to duration.
|
151
|
+
[Feature]
|
152
|
+
- The duration can be specified with a number as 2nd argument, and the rest of the settings as the third ( like $().animate )
|
153
|
+
- Remade the demo
|
154
|
+
|
155
|
+
1.2.4
|
156
|
+
[Enhancement]
|
157
|
+
- The target can be in the form of { top:x, left:y } allowing different position for each axis.
|
158
|
+
[Feature]
|
159
|
+
- The option 'offset' has been added, to scroll behind or past the target. Can be a number(both axes) or { top:x, left:y }.
|
160
|
+
|
161
|
+
1.2.3
|
162
|
+
[Feature]
|
163
|
+
- Exposed the defaults.
|
164
|
+
[Enhancement]
|
165
|
+
- Made the callback functions receive more parameters.
|
166
|
+
|
167
|
+
1.2.2
|
168
|
+
[Fix]
|
169
|
+
- Fixed a bug, I didn't have to add the scrolled amount if it was body or html.
|
170
|
+
|
171
|
+
1.2
|
172
|
+
[Change]
|
173
|
+
- The option 'onafter' is now called 'onAfter'.
|
174
|
+
[Feature]
|
175
|
+
- Two axes can be scrolled together, this is set with the option 'axis'.
|
176
|
+
- In case 2 axes are chosen, the scrolling can be queued: one scrolls, and then the other.
|
177
|
+
- There's an intermediary event, 'onAfterFirst' called in case the axes are queued, after the first ends.
|
178
|
+
- If the option 'margin' is set to true, the plugin will take in account, the margin of the target(no use if target is a value).
|
@@ -0,0 +1,22 @@
|
|
1
|
+
(The MIT License)
|
2
|
+
|
3
|
+
Copyright (c) 2007-2015 Ariel Flesler <aflesler@gmail.com>
|
4
|
+
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining
|
6
|
+
a copy of this software and associated documentation files (the
|
7
|
+
'Software'), to deal in the Software without restriction, including
|
8
|
+
without limitation the rights to use, copy, modify, merge, publish,
|
9
|
+
distribute, sublicense, and/or sell copies of the Software, and to
|
10
|
+
permit persons to whom the Software is furnished to do so, subject to
|
11
|
+
the following conditions:
|
12
|
+
|
13
|
+
The above copyright notice and this permission notice shall be
|
14
|
+
included in all copies or substantial portions of the Software.
|
15
|
+
|
16
|
+
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
|
17
|
+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
18
|
+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
|
19
|
+
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
|
20
|
+
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
|
21
|
+
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
|
22
|
+
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
@@ -0,0 +1,151 @@
|
|
1
|
+
# jQuery.scrollTo
|
2
|
+
|
3
|
+
Lightweight, cross-browser and highly customizable animated scrolling with jQuery
|
4
|
+
|
5
|
+
[![GitHub version](https://badge.fury.io/gh/flesler%2Fjquery.scrollTo.svg)](http://badge.fury.io/gh/flesler%2Fjquery.scrollTo)
|
6
|
+
[![libscore](http://img.shields.io/badge/libscore-31656-brightgreen.svg?style=flat-square)](http://libscore.com/#jQuery.fn.scrollTo)
|
7
|
+
|
8
|
+
## Installation
|
9
|
+
The plugin requires jQuery 1.8 or higher.
|
10
|
+
|
11
|
+
Via [bower](https://github.com/flesler/jquery.scrollTo/blob/master/bower.json):
|
12
|
+
```bash
|
13
|
+
bower install jquery.scrollTo
|
14
|
+
```
|
15
|
+
Via [npm](https://www.npmjs.com/package/jquery.scrollto):
|
16
|
+
```bash
|
17
|
+
npm install jquery.scrollto
|
18
|
+
```
|
19
|
+
Via [packagist](https://packagist.org/packages/flesler/jquery.scrollTo):
|
20
|
+
```php
|
21
|
+
php composer.phar require --prefer-dist flesler/jquery.scrollto "*"
|
22
|
+
```
|
23
|
+
|
24
|
+
### Using a public CDN
|
25
|
+
|
26
|
+
CDN provided by [jsdelivr](http://www.jsdelivr.com/#!jquery.scrollto)
|
27
|
+
```html
|
28
|
+
<script src="//cdn.jsdelivr.net/jquery.scrollto/2.1.0/jquery.scrollTo.min.js"></script>
|
29
|
+
```
|
30
|
+
CDN provided by [cdnjs](https://cdnjs.com/libraries/jquery-scrollTo)
|
31
|
+
```html
|
32
|
+
<script src="//cdnjs.cloudflare.com/ajax/libs/jquery-scrollTo/2.1.0/jquery.scrollTo.min.js"></script>
|
33
|
+
```
|
34
|
+
|
35
|
+
### Downloading Manually
|
36
|
+
|
37
|
+
If you want the latest stable version, get the latest release from the [releases page](https://github.com/flesler/jquery.scrollTo/releases).
|
38
|
+
|
39
|
+
## 2.0
|
40
|
+
|
41
|
+
Version 2.0 has been recently released. It is mostly backwards compatible, if you have any issue first check [this link](https://github.com/flesler/jquery.scrollTo/wiki/Migrating-to-2.0).
|
42
|
+
If your problem is not solved then go ahead and [report the issue](https://github.com/flesler/jquery.scrollTo/issues/new).
|
43
|
+
|
44
|
+
## Usage
|
45
|
+
|
46
|
+
jQuery.scrollTo's signature is designed to resemble [$().animate()](http://api.jquery.com/animate/).
|
47
|
+
|
48
|
+
```js
|
49
|
+
$(element).scrollTo(target[,duration][,settings]);
|
50
|
+
```
|
51
|
+
|
52
|
+
### _element_
|
53
|
+
|
54
|
+
This must be a scrollable element, to scroll the whole window use `$(window)`.
|
55
|
+
|
56
|
+
### _target_
|
57
|
+
|
58
|
+
This defines the position to where `element` must be scrolled. The plugin supports all these formats:
|
59
|
+
* A number with a fixed position: `250`
|
60
|
+
* A string with a fixed position with px: `"250px"`
|
61
|
+
* A string with a percentage (of container's size): `"50%"`
|
62
|
+
* A string with a relative step: `"+=50px"`
|
63
|
+
* An object with `left` and `top` containining any of the aforementioned: `{left:250, top:"50px"}`
|
64
|
+
* The string `"max"` to scroll to the end.
|
65
|
+
* A string selector that will be relative to the element to scroll: `".section:eq(2)"`
|
66
|
+
* A DOM element, probably a child of the element to scroll: `document.getElementById("top")`
|
67
|
+
* A jQuery object with a DOM element: `$("#top")`
|
68
|
+
|
69
|
+
### _settings_
|
70
|
+
|
71
|
+
The `duration` parameter is a shortcut to the setting with the same name.
|
72
|
+
These are the supported settings:
|
73
|
+
* __axis__: The axes to animate: `xy` (default), `x`, `y`, `yx`
|
74
|
+
* __interrupt__: If `true` will cancel the animation if the user scrolls. Default is `false`
|
75
|
+
* __limit__: If `true` the plugin will not scroll beyond the container's size. Default is `true`
|
76
|
+
* __margin__: If `true`, subtracts the margin and border of the `target` element. Default is `false`
|
77
|
+
* __offset__: Added to the final position, can be a number or an object with `left` and `top`
|
78
|
+
* __over__: Adds a % of the `target` dimensions: `{left:0.5, top:0.5}`
|
79
|
+
* __queue__: If `true` will scroll one `axis` and then the other. Default is `false`
|
80
|
+
* __onAfter(target, settings)__: A callback triggered when the animation ends (jQuery's `complete()`)
|
81
|
+
* __onAfterFirst(target, settings)__: A callback triggered after the first axis scrolls when queueing
|
82
|
+
|
83
|
+
You can add any setting supported by [$().animate()](http://api.jquery.com/animate/#animate-properties-options) as well:
|
84
|
+
|
85
|
+
* __duration__: Duration of the animation, default is `0` which makes it instantaneous
|
86
|
+
* __easing__: Name of an easing equation, you must register the easing function: `swing`
|
87
|
+
* __fail()__: A callback triggered when the animation is stopped (f.e via `interrupt`)
|
88
|
+
* __step()__: A callback triggered for every animated property on every frame
|
89
|
+
* __progress()__: A callback triggered on every frame
|
90
|
+
* And more, check jQuery's [documentation](http://api.jquery.com/animate/#animate-properties-options)
|
91
|
+
|
92
|
+
### window shorthand
|
93
|
+
|
94
|
+
You can use `$.scrollTo(...)` as a shorthand for `$(window).scrollTo(...)`.
|
95
|
+
|
96
|
+
### Changing the default settings
|
97
|
+
|
98
|
+
As with most plugins, the default settings are exposed so they can be changed.
|
99
|
+
```js
|
100
|
+
$.extend($.scrollTo.defaults, {
|
101
|
+
axis: 'y',
|
102
|
+
duration: 800
|
103
|
+
});
|
104
|
+
```
|
105
|
+
|
106
|
+
### Stopping the animation
|
107
|
+
|
108
|
+
jQuery.scrollTo ends up creating ordinary animations which can be stopped by calling [$().stop()](http://api.jquery.com/stop/) or [$().finish()](http://api.jquery.com/finish/) on the same element you called `$().scrollTo()`, including the `window`.
|
109
|
+
Remember you can pass a `fail()` callback to be called when the animation is stopped.
|
110
|
+
|
111
|
+
## Demo
|
112
|
+
|
113
|
+
Check the [demo](http://demos.flesler.com/jquery/scrollTo/) to see every option in action.
|
114
|
+
|
115
|
+
## Complementary plugins
|
116
|
+
|
117
|
+
There are two plugins, also created by me that depend on jQuery.scrollTo and aim to simplify certain use cases.
|
118
|
+
|
119
|
+
### [jQuery.localScroll](https://github.com/flesler/jquery.localScroll)
|
120
|
+
|
121
|
+
This plugin makes it very easy to implement anchor navigation.
|
122
|
+
If you don't want to include another plugin, you can try using something like [this minimalistic gist](https://gist.github.com/flesler/3f3e1166690108abf747).
|
123
|
+
|
124
|
+
### [jQuery.serialScroll](https://github.com/flesler/jquery.serialScroll)
|
125
|
+
|
126
|
+
This plugin simplifies the creation of scrolling slideshows.
|
127
|
+
|
128
|
+
## License
|
129
|
+
|
130
|
+
(The MIT License)
|
131
|
+
|
132
|
+
Copyright (c) 2007-2015 Ariel Flesler <aflesler@gmail.com>
|
133
|
+
|
134
|
+
Permission is hereby granted, free of charge, to any person obtaining
|
135
|
+
a copy of this software and associated documentation files (the
|
136
|
+
'Software'), to deal in the Software without restriction, including
|
137
|
+
without limitation the rights to use, copy, modify, merge, publish,
|
138
|
+
distribute, sublicense, and/or sell copies of the Software, and to
|
139
|
+
permit persons to whom the Software is furnished to do so, subject to
|
140
|
+
the following conditions:
|
141
|
+
|
142
|
+
The above copyright notice and this permission notice shall be
|
143
|
+
included in all copies or substantial portions of the Software.
|
144
|
+
|
145
|
+
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
|
146
|
+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
147
|
+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
|
148
|
+
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
|
149
|
+
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
|
150
|
+
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
|
151
|
+
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
@@ -0,0 +1,28 @@
|
|
1
|
+
{
|
2
|
+
"name": "jquery.scrollTo",
|
3
|
+
"description": "Lightweight, cross-browser and highly customizable animated scrolling with jQuery",
|
4
|
+
"homepage": "https://github.com/flesler/jquery.scrollTo",
|
5
|
+
"main": [
|
6
|
+
"./jquery.scrollTo.js"
|
7
|
+
],
|
8
|
+
"ignore": [
|
9
|
+
"**/.*",
|
10
|
+
"demo",
|
11
|
+
"tests",
|
12
|
+
"CHANGELOG",
|
13
|
+
"README.md",
|
14
|
+
"composer.json",
|
15
|
+
"package.json"
|
16
|
+
],
|
17
|
+
"dependencies": {
|
18
|
+
"jquery": ">=1.8"
|
19
|
+
},
|
20
|
+
"keywords": [
|
21
|
+
"browser", "animated", "animation", "jquery",
|
22
|
+
"scrolling", "scroll", "links", "anchors"
|
23
|
+
],
|
24
|
+
"author": {
|
25
|
+
"name": "Ariel Flesler",
|
26
|
+
"web": "http://flesler.blogspot.com/"
|
27
|
+
}
|
28
|
+
}
|
@@ -0,0 +1,32 @@
|
|
1
|
+
{
|
2
|
+
"name": "flesler/jquery.scrollto",
|
3
|
+
"description": "Lightweight, cross-browser and highly customizable animated scrolling with jQuery",
|
4
|
+
"keywords": [
|
5
|
+
"browser", "animated", "animation", "jquery",
|
6
|
+
"scrolling", "scroll", "links", "anchors"
|
7
|
+
],
|
8
|
+
"homepage": "https://github.com/flesler/jquery.scrollTo",
|
9
|
+
"support": {
|
10
|
+
"issues": "https://github.com/flesler/jquery.scrollTo/issues",
|
11
|
+
"source": "https://github.com/flesler/jquery.scrollTo"
|
12
|
+
},
|
13
|
+
"authors": [
|
14
|
+
{
|
15
|
+
"name": "Ariel Flesler",
|
16
|
+
"web": "http://flesler.blogspot.com/"
|
17
|
+
}
|
18
|
+
],
|
19
|
+
"require": {
|
20
|
+
"components/jquery": ">=1.8"
|
21
|
+
},
|
22
|
+
"extra": {
|
23
|
+
"component": {
|
24
|
+
"scripts": [
|
25
|
+
"jquery.scrollTo.js"
|
26
|
+
],
|
27
|
+
"files": [
|
28
|
+
"jquery.scrollTo.min.js"
|
29
|
+
]
|
30
|
+
}
|
31
|
+
}
|
32
|
+
}
|