forked from hector-jaraba/jquery-smooth-scroll
-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.html
168 lines (165 loc) · 16.3 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width">
<title>jQuery Smooth Scroll Plugin</title>
<style>
html,
body {
margin: 0;
padding: 0;
border-width: 0;
}
body {
font-family: "Helvetica Neue", Helvetica, Arial, sans-serif;
width: 94%;
margin: 0 auto;
padding: 0 3%;
max-width: 1120px;
font-size: 1em;
line-height: 1.5;
background-color: #fff;
color: #242424;
}
pre {
background-color: #f3f3f3;
padding: .25em;
border: 1px solid #ccc;
font-size: .9em;
overflow: auto;
}
code {
font-family: Monaco, Courier, monospace;
}
.comment,
.comments {
color: #aaa;
}
.keyword {
color: blue;
}
.string {
color: #090;
}
.number {
color: #099;
}
td.gutter {
text-align: right;
padding-right: 3px;
padding-left: 3px;
background-color: #ddd;
color: #aaa;
}
td.code {
padding-left: 5px;
}
h1, h2, h3 {
font-weight: normal;
color: #141414;
}
h2 {
padding-bottom: .2em;
border-bottom: 1px solid #ccc;
}
.right {
float: right;
}
</style>
</head>
<body>
<div class="right"><a href="demo/index.html">Demo</a></div>
<h1 id="smooth-scroll-plugin">Smooth Scroll Plugin</h1>
<p>Allows for easy implementation of smooth scrolling for same-page links.</p>
<h2 id="download">Download</h2>
<p>Using npm:</p>
<pre><code class="lang-bash"><div id="highlighter_533355" class="syntaxhighlighter "><table border="0" cellpadding="0" cellspacing="0"><tbody><tr><td class="gutter"><div class="line number1 index0 alt2">1</div></td><td class="code"><div class="container"><div class="line number1 index0 alt2"><code class="plain">npm </code><code class="functions">install</code> <code class="plain">jquery-smooth-scroll</code></div></div></td></tr></tbody></table></div>
</code></pre>
<p>Using bower:</p>
<pre><code class="lang-bash"><div id="highlighter_696232" class="syntaxhighlighter "><table border="0" cellpadding="0" cellspacing="0"><tbody><tr><td class="gutter"><div class="line number1 index0 alt2">1</div></td><td class="code"><div class="container"><div class="line number1 index0 alt2"><code class="plain">bower </code><code class="functions">install</code> <code class="plain">jquery-smooth-scroll</code></div></div></td></tr></tbody></table></div>
</code></pre>
<p>The old-fashioned way:</p>
<p>Go to the following URL in your browser and copy/paste the code into your own file:
<a href="https://raw.githubusercontent.com/kswedberg/jquery-smooth-scroll/master/jquery.smooth-scroll.js">https://raw.githubusercontent.com/kswedberg/jquery-smooth-scroll/master/jquery.smooth-scroll.js</a></p>
<h2 id="features">Features</h2>
<h3 id="-fn-smoothscroll">$.fn.smoothScroll</h3>
<ul>
<li>Works like this: <code>$('a').smoothScroll();</code></li>
<li>Specify a containing element if you want: <code>$('#container a').smoothScroll();</code></li>
<li>Exclude links if they are within a containing element: <code>$('#container a').smoothScroll({excludeWithin: ['.container2']});</code></li>
<li>Exclude links if they match certain conditions: <code>$('a').smoothScroll({exclude: ['.rough','#chunky']});</code></li>
<li>Adjust where the scrolling stops: <code>$('.backtotop').smoothScroll({offset: -100});</code></li>
<li>Add a callback function that is triggered before the scroll starts: `$('a').smoothScroll({beforeScroll: function() { alert('ready to go!'); }});</li>
<li>Add a callback function that is triggered after the scroll is complete: <code>$('a').smoothScroll({afterScroll: function() { alert('we made it!'); }});</code></li>
<li>Add back button support by including a history management plugin such as <a href="http://benalman.com/code/projects/jquery-bbq/docs/files/jquery-ba-bbq-js.html">Ben Alman's BBQ</a>. See <a href="demo/bbq.html">demo/bbq.html</a> for an example of how to implement this.</li>
</ul>
<h4 id="options">Options</h4>
<p>The following options, shown with their default values, are available for both <code>$.fn.smoothScroll</code> and <code>$.smoothScroll</code>:</p>
<pre><code class="lang-javascript"><div id="highlighter_987027" class="syntaxhighlighter "><table border="0" cellpadding="0" cellspacing="0"><tbody><tr><td class="gutter"><div class="line number1 index0 alt2">1</div><div class="line number2 index1 alt1">2</div><div class="line number3 index2 alt2">3</div><div class="line number4 index3 alt1">4</div><div class="line number5 index4 alt2">5</div><div class="line number6 index5 alt1">6</div><div class="line number7 index6 alt2">7</div><div class="line number8 index7 alt1">8</div><div class="line number9 index8 alt2">9</div><div class="line number10 index9 alt1">10</div><div class="line number11 index10 alt2">11</div><div class="line number12 index11 alt1">12</div><div class="line number13 index12 alt2">13</div><div class="line number14 index13 alt1">14</div><div class="line number15 index14 alt2">15</div><div class="line number16 index15 alt1">16</div><div class="line number17 index16 alt2">17</div><div class="line number18 index17 alt1">18</div><div class="line number19 index18 alt2">19</div><div class="line number20 index19 alt1">20</div><div class="line number21 index20 alt2">21</div><div class="line number22 index21 alt1">22</div><div class="line number23 index22 alt2">23</div><div class="line number24 index23 alt1">24</div><div class="line number25 index24 alt2">25</div><div class="line number26 index25 alt1">26</div><div class="line number27 index26 alt2">27</div><div class="line number28 index27 alt1">28</div><div class="line number29 index28 alt2">29</div><div class="line number30 index29 alt1">30</div><div class="line number31 index30 alt2">31</div></td><td class="code"><div class="container"><div class="line number1 index0 alt2"><code class="plain">{</code></div><div class="line number2 index1 alt1"><code class="undefined spaces"> </code><code class="plain">offset: 0,</code></div><div class="line number3 index2 alt2"> </div><div class="line number4 index3 alt1"><code class="undefined spaces"> </code><code class="comments">// one of 'top' or 'left'</code></div><div class="line number5 index4 alt2"><code class="undefined spaces"> </code><code class="plain">direction: </code><code class="string">'top'</code><code class="plain">,</code></div><div class="line number6 index5 alt1"> </div><div class="line number7 index6 alt2"><code class="undefined spaces"> </code><code class="comments">// only use if you want to override default behavior</code></div><div class="line number8 index7 alt1"><code class="undefined spaces"> </code><code class="plain">scrollTarget: </code><code class="keyword">null</code><code class="plain">,</code></div><div class="line number9 index8 alt2"> </div><div class="line number10 index9 alt1"><code class="undefined spaces"> </code><code class="comments">// fn(opts) function to be called before scrolling occurs.</code></div><div class="line number11 index10 alt2"><code class="undefined spaces"> </code><code class="comments">// `this` is the element(s) being scrolled</code></div><div class="line number12 index11 alt1"><code class="undefined spaces"> </code><code class="plain">beforeScroll: </code><code class="keyword">function</code><code class="plain">() {},</code></div><div class="line number13 index12 alt2"> </div><div class="line number14 index13 alt1"><code class="undefined spaces"> </code><code class="comments">// fn(opts) function to be called after scrolling occurs.</code></div><div class="line number15 index14 alt2"><code class="undefined spaces"> </code><code class="comments">// `this` is the triggering element</code></div><div class="line number16 index15 alt1"><code class="undefined spaces"> </code><code class="plain">afterScroll: </code><code class="keyword">function</code><code class="plain">() {},</code></div><div class="line number17 index16 alt2"><code class="undefined spaces"> </code><code class="plain">easing: </code><code class="string">'swing'</code><code class="plain">,</code></div><div class="line number18 index17 alt1"> </div><div class="line number19 index18 alt2"><code class="undefined spaces"> </code><code class="comments">// speed can be a number or 'auto'</code></div><div class="line number20 index19 alt1"><code class="undefined spaces"> </code><code class="comments">// if 'auto', the speed will be calculated based on the formula:</code></div><div class="line number21 index20 alt2"><code class="undefined spaces"> </code><code class="comments">// (current scroll position - target scroll position) / autoCoeffic</code></div><div class="line number22 index21 alt1"><code class="undefined spaces"> </code><code class="plain">speed: 400,</code></div><div class="line number23 index22 alt2"> </div><div class="line number24 index23 alt1"><code class="undefined spaces"> </code><code class="comments">// autoCoefficent: Only used when speed set to "auto".</code></div><div class="line number25 index24 alt2"><code class="undefined spaces"> </code><code class="comments">// The higher this number, the faster the scroll speed</code></div><div class="line number26 index25 alt1"><code class="undefined spaces"> </code><code class="plain">autoCoefficient: 2,</code></div><div class="line number27 index26 alt2"> </div><div class="line number28 index27 alt1"><code class="undefined spaces"> </code><code class="comments">// $.fn.smoothScroll only: whether to prevent the default click action</code></div><div class="line number29 index28 alt2"><code class="undefined spaces"> </code><code class="plain">preventDefault: </code><code class="keyword">true</code></div><div class="line number30 index29 alt1"> </div><div class="line number31 index30 alt2"><code class="plain">}</code></div></div></td></tr></tbody></table></div>
</code></pre>
<p>The options object for <code>$.fn.smoothScroll</code> can take two additional properties:
<code>exclude</code> and <code>excludeWithin</code>. The value for both of these is an array of
selectors, DOM elements or jQuery objects. Default value for both is an
empty array.</p>
<h4 id="setting-options-after-initial-call">Setting options after initial call</h4>
<p>If you need to change any of the options after you've already called <code>.smoothScroll()</code>,
you can do so by passing the <code>"options"</code> string as the first argument and an
options object as the second.</p>
<h3 id="-smoothscroll">$.smoothScroll</h3>
<ul>
<li>Utility method works without a selector: <code>$.smoothScroll()</code></li>
<li>Can be used to scroll any element (not just <code>document.documentElement</code> /
<code>document.body</code>)</li>
<li><p>Doesn't automatically fire, so you need to bind it to some other user
interaction. For example:</p>
<pre><code><div id="highlighter_189143" class="syntaxhighlighter "><table border="0" cellpadding="0" cellspacing="0"><tbody><tr><td class="gutter"><div class="line number1 index0 alt2">1</div><div class="line number2 index1 alt1">2</div><div class="line number3 index2 alt2">3</div><div class="line number4 index3 alt1">4</div><div class="line number5 index4 alt2">5</div><div class="line number6 index5 alt1">6</div><div class="line number7 index6 alt2">7</div></td><td class="code"><div class="container"><div class="line number1 index0 alt2"><code class="plain">$(</code><code class="string">'button.scrollsomething'</code><code class="plain">).on(</code><code class="string">'click'</code><code class="plain">, </code><code class="keyword">function</code><code class="plain">() {</code></div><div class="line number2 index1 alt1"><code class="undefined spaces"> </code><code class="plain">$.smoothScroll({</code></div><div class="line number3 index2 alt2"><code class="undefined spaces"> </code><code class="plain">scrollElement: $(</code><code class="string">'div.scrollme'</code><code class="plain">),</code></div><div class="line number4 index3 alt1"><code class="undefined spaces"> </code><code class="plain">scrollTarget: </code><code class="string">'#findme'</code></div><div class="line number5 index4 alt2"><code class="undefined spaces"> </code><code class="plain">});</code></div><div class="line number6 index5 alt1"><code class="undefined spaces"> </code><code class="keyword">return</code> <code class="keyword">false</code><code class="plain">;</code></div><div class="line number7 index6 alt2"><code class="plain">});</code></div></div></td></tr></tbody></table></div>
</code></pre></li>
<li><p>The <code>$.smoothScroll</code> method can take one or two arguments.</p>
<ul>
<li>If the first argument is a number, the document is scrolled to that
position. If it's an options object, those options determine how the
document (or other element) will be scrolled.</li>
<li>If a number is provided as the second argument, it will override whatever may have been set for the <code>scrollTarget</code> option.</li>
</ul>
</li>
</ul>
<h4 id="additional-option">Additional Option</h4>
<p>The following option, in addition to those listed for <code>$.fn.smoothScroll</code> above, is available
for <code>$.smoothScroll</code>:</p>
<pre><code class="lang-javascript"><div id="highlighter_18059" class="syntaxhighlighter "><table border="0" cellpadding="0" cellspacing="0"><tbody><tr><td class="gutter"><div class="line number1 index0 alt2">1</div><div class="line number2 index1 alt1">2</div><div class="line number3 index2 alt2">3</div><div class="line number4 index3 alt1">4</div><div class="line number5 index4 alt2">5</div></td><td class="code"><div class="container"><div class="line number1 index0 alt2"><code class="plain">{</code></div><div class="line number2 index1 alt1"><code class="undefined spaces"> </code><code class="comments">// jQuery set of elements you wish to scroll.</code></div><div class="line number3 index2 alt2"><code class="undefined spaces"> </code><code class="comments">// if null (default), $('html, body').firstScrollable() is used.</code></div><div class="line number4 index3 alt1"><code class="undefined spaces"> </code><code class="plain">scrollElement: </code><code class="keyword">null</code></div><div class="line number5 index4 alt2"><code class="plain">}</code></div></div></td></tr></tbody></table></div>
</code></pre>
<h3 id="-fn-scrollable">$.fn.scrollable</h3>
<ul>
<li>Selects the matched element(s) that are scrollable. Acts just like a
DOM traversal method such as <code>.find()</code> or <code>.next()</code>.</li>
<li>The resulting jQuery set may consist of <strong>zero, one, or multiple</strong>
elements.</li>
</ul>
<h3 id="-fn-firstscrollable">$.fn.firstScrollable</h3>
<ul>
<li>Selects the first matched element that is scrollable. Acts just like a
DOM traversal method such as <code>.find()</code> or <code>.next()</code>.</li>
<li>The resulting jQuery set may consist of <strong>zero or one</strong> element.</li>
<li>This method is used <em>internally</em> by the plugin to determine which element
to use for "document" scrolling:
<code>$('html, body').firstScrollable().animate({scrollTop: someNumber},
someSpeed)</code></li>
</ul>
<h2 id="notes">Notes</h2>
<ul>
<li>To determine where to scroll the page, the <code>$.fn.smoothScroll</code> method looks
for an element with an <em>id</em> attribute that matches the <code><a></code> element's hash.
It does <em>not</em> look at the element's <em>name</em> attribute. If you want a clicked link
to scroll to a "named anchor" (e.g. <code><a name="foo"></code>), you'll need to use the
<code>$.smoothScroll</code> method instead.</li>
<li>The plugin's <code>$.fn.smoothScroll</code> and <code>$.smoothScroll</code> methods use the
<code>$.fn.firstScrollable</code> DOM traversal method (also defined by this plugin)
to determine which element is scrollable. If no elements are scrollable,
these methods return a jQuery object containing an empty array, just like
all of jQuery's other DOM traversal methods. Any further chained methods,
therefore, will be called against no elements (which, in most cases,
means that nothing will happen).</li>
</ul>
</body>
</html>