forked from tgomilar/paroller.js
-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.html
416 lines (401 loc) · 20.6 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
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
<meta name="description" content="lightweight jQuery plugin that enables parallax scrolling effect on elements">
<meta name="keywords" content="paroller.js,jquery plugin,parallax,scrolling,parallax effect,jQuery,paroller,scroller,scrolling, paroller js, paroller jquery">
<meta name="google-site-verification" content="TWTDG5sHkQOekIFUa5uWVmi7yO3pJTU7AGMaIPajIHc" />
<title>paroller.js</title>
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/4.0.0-alpha.6/css/bootstrap.min.css"
integrity="sha384-rwoIResjU2yc3z8GV/NPeZWAv56rSmLldC3R/AZzGRnGxQQKnKkoFVhFQhNUwEyJ" crossorigin="anonymous">
<link rel="stylesheet" href="assets/style.css">
<script src="https://use.fontawesome.com/9576790a31.js"></script>
</head>
<body data-spy="scroll" data-target="#main-navbar" data-offset="70">
<nav class="navbar navbar-light bg-faded sticky-top navbar-toggleable-md" id="main-navbar">
<a class="navbar-brand" href="#">
<span class="logo-arrow"></span>
<span class="pl-5">paroller.js</span>
<span class="navbar-text small hidden-xs-down"> - parallax scrolling jQuery plugin</span>
</a>
<div class="collapse navbar-collapse justify-content-end">
<ul class="nav nav-pills align-items-center">
<li class="nav-item active">
<a class="nav-link" href="#download">Download <span class="sr-only">(current)</span></a>
</li>
<li class="nav-item">
<a class="nav-link" href="#usage">Usage</a>
</li>
<li class="nav-item">
<a class="nav-link" href="#vertical">Vertical</a>
</li>
<li class="nav-item">
<a class="nav-link" href="#horizontal">Horizontal</a>
</li>
<li class="nav-item">
<a href="https://github.com/tgomilar/paroller.js/" class="mx-2">
<i class="fa fa-github fa-2x"></i>
</a>
</li>
</ul>
</div>
</nav>
<div class="container">
<section id="download" class="jumbotron text-center bg-faded my-5">
<div class="container">
<h1 class="jumbotron-heading display-5 mb-3">Download</h1>
<p class="lead col-8 mx-auto">paroller.js is a lightweight jQuery plugin that enables parallax scrolling effect on elements that have <i>data-paroller-factor</i>.</p>
<ul class="text-left col-xs-12 col-sm-12 col-md-9 offset-md-2">
<li>You can use it on elements with background property or on any other element.</li>
<li>While scrolling elements can move: vertical, horizontal.</li>
<li>Manipulated through <samp>html data-*</samp> attributes.</li>
<li>Mobile ready.</li>
<li>Easy to use.</li>
</ul>
<p>
<a href="https://github.com/tgomilar/paroller.js/" class="btn btn-primary btn-lg my-2">
<i class="fa fa-github" aria-hidden="true"></i> GitHub</a>
<a href="https://github.com/tgomilar/paroller.js/archive/master.zip" class="btn btn-primary btn-lg my-2">
<i class="fa fa-download" aria-hidden="true"></i> Download</a>
</p>
<hr class="my-5">
<h1 class="jumbotron-heading display-5 mb-3">Install</h1>
<div class="text-left col-xs-12 col-sm-12 col-md-9 offset-md-2">
<p>Before closing <samp><code></body></code></samp> element include:</p>
<dl class="row text-left">
<dt class="col-sm-3">1. jQuery library</dt>
<dd class="col-sm-9">
<a href="http://jquery.com/download/" target="_blank"><i class="fa fa-link"></i> jQuery</a>
<code><script src="jquery-3.1.1.min.js"></script></code>
</dd>
<dt class="col-sm-3">2. jquery.paroller.js</dt>
<dd class="col-sm-9">
<a href="https://github.com/tgomilar/paroller.js/blob/master/dist/" target="_blank"><i
class="fa fa-link"></i> Paroller</a>
<code><script src="jquery.paroller.min.js"></script></code>
</dd>
<dt class="col-sm-3">3. Use</dt>
<dd class="col-sm-9 card">
<div class="card-block">
<code>
// initialize paroller.js
<br>
$(window).paroller();
</code>
<hr>
<code>
// initialize paroller.js and set attributes for .my-element
$(".my-element").paroller({ factor: '0.5', type: 'foreground', direction: 'horizontal' });
</code>
<hr>
<code>// select element <br></code>
<code><div data-paroller-factor="0.3"></div></code>
</div>
</dd>
</dl>
<h6>npm</h6>
<div class="card my-3">
<div class="card-block">
<code>$ npm install paroller.js</code>
</div>
</div>
<h6>Bower</h6>
<div class="card my-3">
<div class="card-block">
<code>$ bower install paroller.js</code>
</div>
</div>
<h6>Yarn</h6>
<div class="card my-3">
<div class="card-block">
<code>$ yarn add paroller.js</code>
</div>
</div>
</div>
</div>
</section>
<section id="usage" class="jumbotron text-center bg-faded my-5">
<div class="container">
<h1 class="jumbotron-heading display-5 mb-3">Usage</h1>
<p class="lead">
To enable parallax scrolling effect on element you have to use <samp>data-paroller-factor</samp> attribute on selected element.
<br>
<samp>data-paroller-factor</samp>
sets speed and distance of element's parallax effect on scroll. <br>
<code><div data-paroller-factor="0.3"></div></code>
</p>
<hr class="my-5">
<h2>Via data attributes</h2>
<div class="my-5">
<dl class="row text-left">
<dt class="col-sm-3"><samp>data-paroller-factor</samp></dt>
<dd class="col-sm-9">
This attribute is necessary to enable parallax scrolling effect. <br>
It sets elements offset and speed. It can be positive (<i><samp>0.3</samp></i>) or negative (<i><samp>-0.3</samp></i>).
Less means slower. <br>
<code><div data-paroller-factor="0.3"></div></code>
</dd>
<dt class="col-sm-3"><samp>data-paroller-type</samp></dt>
<dd class="col-sm-9">
This attribute is optional. <br>
It has two values <i><samp>background</samp></i> and <i><samp>foreground</samp></i>.<br>
If not used the default value is set to: <i><samp>background</samp></i>. <br>
<code><div data-paroller-factor="0.3" data-paroller-type="foreground"></div></code>
</dd>
<dt class="col-sm-3"><samp>data-paroller-direction</samp></dt>
<dd class="col-sm-9">
This attribute is optional. <br>
It has two values <i><samp>vertical</samp></i>, <i><samp>horizontal</samp></i>.<br>
If not used the default value is set to: <i><samp>vertical</samp></i>. <br>
<code><div data-paroller-factor="0.3"
data-paroller-direction="horizontal"></div></code>
</dd>
</dl>
</div>
<hr class="my-5">
<h2>Via JavaScript</h2>
<div class="card my-5">
<div class="card-block text-left">
<pre>
// initialize paroller.js and set attributes for #my-element
$("#my-element").paroller({
factor: 0.3, // multiplier for scrolling speed and offset
type: 'foreground', // background, foreground
direction: 'horizontal' // vertical, horizontal
});
</pre>
</div>
</div>
</div>
</section>
<section id="vertical" class="my-5">
<div class="jumbotron text-center bg-faded my-5"
style="background: url('https://unsplash.it/1200/600?image=1015') no-repeat center;"
data-paroller-factor="0.5">
<h1 class="heading-1 py-5 text-white">Hello Parallax!</h1>
<p class="text-white">data-paroller-factor="0.5"</p>
</div>
<div class="jumbotron text-center bg-faded my-5"
style="background: url('https://unsplash.it/1200/800?image=974') no-repeat center;"
data-paroller-factor="-0.15">
<h1 class="heading-1 py-5 text-white">Scrolling is fun!</h1>
<p class="text-white">data-paroller-factor="-0.15"</p>
</div>
<div class="row my-5">
<div class="col col-md-4" data-paroller-factor="0.5" data-paroller-type="foreground">
<div class="card">
<img class="card-img-top" src="https://unsplash.it/400/200/?image=1024" alt="Card image cap">
<div class="card-block">
<h4 class="card-title">Card vertical</h4>
<p class="card-text">
<code>data-paroller-factor="0.5" data-paroller-type="foreground"</code>
</p>
</div>
</div>
</div>
<div class="col col-md-4" data-paroller-factor="0.1" data-paroller-type="foreground">
<div class="card">
<img class="card-img-top" src="https://unsplash.it/400/200/?image=1023" alt="Card image cap">
<div class="card-block">
<h4 class="card-title">Card vertical</h4>
<p class="card-text">
<code>data-paroller-factor="0.1" data-paroller-type="foreground"</code>
</p>
</div>
</div>
</div>
<div class="col col-md-4" data-paroller-factor="-0.1" data-paroller-type="foreground">
<div class="card">
<img class="card-img-top" src="https://unsplash.it/400/200/?image=1022" alt="Card image cap">
<div class="card-block">
<h4 class="card-title">Card vertical</h4>
<p class="card-text">
<code>data-paroller-factor="-0.1" data-paroller-type="foreground"</code>
</p>
</div>
</div>
</div>
</div>
<div class="row my-5">
<div class="col col-md-4" data-paroller-factor="0.9" data-paroller-type="foreground"
data-paroller-direction="vertical">
<div class="card">
<img class="card-img-top" src="https://unsplash.it/400/200/?image=1021" alt="Card image cap">
<div class="card-block">
<h4 class="card-title">Card vertical</h4>
<p class="card-text">
<code>data-paroller-factor="0.9" data-paroller-type="foreground"
data-paroller-direction="vertical"</code>
</p>
</div>
</div>
</div>
<div class="col col-md-4" data-paroller-factor="0.15" data-paroller-type="foreground"
data-paroller-direction="vertical">
<div class="card">
<img class="card-img-top" src="https://unsplash.it/400/200/?image=1020" alt="Card image cap">
<div class="card-block">
<h4 class="card-title">Card vertical</h4>
<p class="card-text">
<code>data-paroller-factor="0.15" data-paroller-type="foreground"
data-paroller-direction="vertical"</code>
</p>
</div>
</div>
</div>
<div class="col col-md-4" data-paroller-factor="-0.1" data-paroller-type="foreground"
data-paroller-direction="vertical">
<div class="card">
<img class="card-img-top" src="https://unsplash.it/400/200/?image=1019" alt="Card image cap">
<div class="card-block">
<h4 class="card-title">Card vertical</h4>
<p class="card-text">
<code>data-paroller-factor="-0.1" data-paroller-type="foreground"
data-paroller-direction="vertical"</code>
</p>
</div>
</div>
</div>
</div>
<div class="row my-5">
<div class="col col-sm-6" data-paroller-factor="0.1" data-paroller-type="foreground"
data-paroller-direction="vertical">
<div class="card">
<img class="card-img-top" src="https://unsplash.it/400/200/?image=1018" alt="Card image cap">
<div class="card-block">
<h4 class="card-title">Card vertical</h4>
</div>
</div>
</div>
<div class="col col-sm-6" data-paroller-factor="-0.1" data-paroller-type="foreground"
data-paroller-direction="vertical">
<div class="card">
<img class="card-img-top" src="https://unsplash.it/400/200/?image=1017" alt="Card image cap">
<div class="card-block">
<h4 class="card-title">Card vertical</h4>
</div>
</div>
</div>
</div>
</section>
<section id="horizontal" class="my-5">
<div class="jumbotron text-center bg-faded my-5"
style="background: url('https://unsplash.it/1200/600/?image=981') no-repeat center;"
data-paroller-factor="0.5"
data-paroller-direction="horizontal">
<h1 class="heading-1 py-5 text-white">Hola, horizontal Parallax!</h1>
<p class="text-white">data-paroller-factor="0.5"</p>
</div>
<div class="jumbotron text-center bg-faded my-5"
style="background: url('https://unsplash.it/1200/600/?image=1079') repeat center;"
data-paroller-factor="-0.75"
data-paroller-direction="horizontal">
<h1 class="heading-1 py-5 text-white">Maybe some horizontal scrolling with repeated background?</h1>
<p class="text-white">data-paroller-factor="-0.75"</p>
</div>
<div class="row my-5">
<div class="col col-md-4" data-paroller-factor="-0.3" data-paroller-type="foreground"
data-paroller-direction="horizontal">
<div class="card">
<img class="card-img-top" src="https://unsplash.it/400/200/?image=1016" alt="Card image cap">
<div class="card-block">
<h4 class="card-title">Card horizontal</h4>
<p class="card-text">
<code>data-paroller-factor="-0.3" data-paroller-type="foreground"
data-paroller-direction="horizontal"
</code>
</p>
</div>
</div>
</div>
<div class="col col-md-4" data-paroller-factor="-0.1" data-paroller-type="foreground"
data-paroller-direction="horizontal">
<div class="card">
<img class="card-img-top" src="https://unsplash.it/400/200/?image=1014" alt="Card image cap">
<div class="card-block">
<h4 class="card-title">Card horizontal</h4>
<p class="card-text">
<code>data-paroller-factor="-0.1" data-paroller-type="foreground"
data-paroller-direction="horizontal"</code>
</p>
</div>
</div>
</div>
<div class="col col-md-4" data-paroller-factor="0.1" data-paroller-type="foreground"
data-paroller-direction="horizontal">
<div class="card">
<img class="card-img-top" src="https://unsplash.it/400/200/?image=1013" alt="Card image cap">
<div class="card-block">
<h4 class="card-title">Card horizontal</h4>
<p class="card-text">
<code>data-paroller-factor="0.1" data-paroller-type="foreground"
data-paroller-direction="horizontal"</code>
</p>
</div>
</div>
</div>
</div>
<div class="row my-5">
<div class="col-12 col-sm-6" data-paroller-factor="0.27" data-paroller-type="foreground"
data-paroller-direction="horizontal">
<div class="card">
<img class="card-img-top" src="https://unsplash.it/400/200/?image=1012" alt="Card image cap">
<div class="card-block">
<h4 class="card-title">Card horizontal</h4>
</div>
</div>
</div>
<div class="col-12 col-sm-6" data-paroller-factor="-0.1" data-paroller-type="foreground"
data-paroller-direction="horizontal">
<div class="card">
<img class="card-img-top" src="https://unsplash.it/400/200/?image=1011" alt="Card image cap">
<div class="card-block">
<h4 class="card-title">Card horizontal</h4>
</div>
</div>
</div>
</div>
</section>
</div>
<div class="clearfix"></div>
<footer class="bg-faded text-muted py-5 mt-5">
<div class="container">
<div class="row">
<div class="col-8">
<p><b>Happy scrolling!</b></p>
<p>
<small>
<script>document.write(new Date().getFullYear())</script>
@ Copyrights <a href="https://github.com/tgomilar/paroller.js/blob/master/LICENCE.md"
target="_blank">MIT</a>
</small>
</p>
</div>
<div class="col text-right">
<iframe src="https://ghbtns.com/github-btn.html?user=tgomilar&repo=paroller.js&type=star&count=true&size=large" frameborder="0" scrolling="0" width="160px" height="30px"></iframe>
</div>
</div>
</div>
</footer>
<!-- jQuery -->
<script src="https://code.jquery.com/jquery-3.1.1.slim.min.js"
integrity="sha384-A7FZj7v+d/sdmMqp/nOQwliLvUsJfDHW+k9Omg/a/EheAdgtzNs3hpfag6Ed950n"
crossorigin="anonymous"></script>
<!-- Bootstrap 4-->
<script src="https://cdnjs.cloudflare.com/ajax/libs/tether/1.4.0/js/tether.min.js"
integrity="sha384-DztdAPBWPRXSA/3eYEEUWrWCy7G5KFbe8fFjk5JAIxUYHKkDx6Qin1DkWx51bBrb"
crossorigin="anonymous"></script>
<script src="https://maxcdn.bootstrapcdn.com/bootstrap/4.0.0-alpha.6/js/bootstrap.min.js"
integrity="sha384-vBWWzlZJ8ea9aCX4pEW3rVHjgjt7zpkNpZk+02D9phzyeVkE+jo0ieGizqPLForn"
crossorigin="anonymous"></script>
<!--Paroller-->
<script src="dist/jquery.paroller.js"></script>
<script>
$(function () {
$(window).paroller();
$('body').scrollspy({target: '#main-navbar'});
});
</script>
</body>
</html>