/
index.html
418 lines (379 loc) · 25.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
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
417
418
<!DOCTYPE html>
<html>
<head>
<meta charset='utf-8'>
<meta http-equiv="X-UA-Compatible" content="chrome=1">
<link href='https://fonts.googleapis.com/css?family=Architects+Daughter' rel='stylesheet' type='text/css'>
<link rel="stylesheet" type="text/css" href="stylesheets/stylesheet.css" media="screen">
<link rel="stylesheet" type="text/css" href="stylesheets/pygment_trac.css" media="screen">
<link rel="stylesheet" type="text/css" href="stylesheets/prettify.css" media="screen">
<link rel="stylesheet" type="text/css" href="stylesheets/carouselTicker.css" media="screen">
<link rel="stylesheet" type="text/css" href="stylesheets/print.css" media="print">
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<title>carouselTicker</title>
</head>
<body>
<header>
<div class="inner ta-center">
<h1>carouselTicker</h1>
<p>A lightness, flexible jQuery plugin enabling you to easily create semantic, modern carouselTicker enchanced with the power of CSS. <br>
Supports: Chrome, FireFox, Safari, Opera, IE7, IE8, IE9, IE10, IE11</p>
<h2>Simple Carousel Ticker, try it! <a href="https://github.com/likeclever1/carouselTicker/archive/gh-pages.zip" class="btn">Download</a></h2>
</div>
</header>
<div id="content-wrapper">
<div class="inner clearfix">
<section id="main-content">
<div id="demos">
<h1>Demos</h1>
<h4>Default Setting</h4>
<h4>Horizontal mode</h4>
<div id="carouselTicker" class="carouselTicker">
<ul class="carouselTicker__list">
<li class="carouselTicker__item">
<a href="https://placehold.it/290x60"><img src="https://placehold.it/290x60" alt="banner image"></a>
</li>
<li class="carouselTicker__item">
<a href="https://placehold.it/190x65"><img src="https://placehold.it/190x65" alt="banner image"></a>
</li>
<li class="carouselTicker__item">
<a href="#"><img src="https://placehold.it/190x65" alt="banner image"></a>
</li>
<li class="carouselTicker__item">
<a href="#"><img src="https://placehold.it/190x65" alt="banner image"></a>
</li>
<li class="carouselTicker__item">
<a href="#"><img src="https://placehold.it/190x65" alt="banner image"></a>
</li>
<li class="carouselTicker__item">
<a href="#"><img src="https://placehold.it/190x65" alt="banner image"></a>
</li>
</ul>
</div>
<br>
<br>
<h4>Multiple calls</h4>
<div style="width: 400px; margin: 0 auto;">
<div class="carouselTicker carouselTicker-start">
<ul class="carouselTicker__list">
<li class="carouselTicker__item">1</li>
<li class="carouselTicker__item">2</li>
<li class="carouselTicker__item">3</li>
<li class="carouselTicker__item">4</li>
<li class="carouselTicker__item">5</li>
<li class="carouselTicker__item">6</li>
<li class="carouselTicker__item">7</li>
<li class="carouselTicker__item">8</li>
<li class="carouselTicker__item">9</li>
<li class="carouselTicker__item">10</li>
<li class="carouselTicker__item">11</li>
<li class="carouselTicker__item">12</li>
<li class="carouselTicker__item">13</li>
<li class="carouselTicker__item">14</li>
<li class="carouselTicker__item">15</li>
</ul>
</div>
<div class="carouselTicker carouselTicker-start">
<ul class="carouselTicker__list">
<li class="carouselTicker__item">1</li>
<li class="carouselTicker__item">2</li>
<li class="carouselTicker__item">3</li>
<li class="carouselTicker__item">4</li>
<li class="carouselTicker__item">5</li>
<li class="carouselTicker__item">6</li>
<li class="carouselTicker__item">7</li>
<li class="carouselTicker__item">8</li>
<li class="carouselTicker__item">9</li>
<li class="carouselTicker__item">10</li>
<li class="carouselTicker__item">11</li>
<li class="carouselTicker__item">12</li>
<li class="carouselTicker__item">13</li>
<li class="carouselTicker__item">14</li>
<li class="carouselTicker__item">15</li>
</ul>
</div>
<div class="carouselTicker carouselTicker-start">
<ul class="carouselTicker__list">
<li class="carouselTicker__item">1</li>
<li class="carouselTicker__item">2</li>
<li class="carouselTicker__item">3</li>
<li class="carouselTicker__item">4</li>
<li class="carouselTicker__item">5</li>
<li class="carouselTicker__item">6</li>
<li class="carouselTicker__item">7</li>
<li class="carouselTicker__item">8</li>
<li class="carouselTicker__item">9</li>
<li class="carouselTicker__item">10</li>
<li class="carouselTicker__item">11</li>
<li class="carouselTicker__item">12</li>
<li class="carouselTicker__item">13</li>
<li class="carouselTicker__item">14</li>
<li class="carouselTicker__item">15</li>
</ul>
</div>
</div>
<br><br>
<h4>Example sensitivity to resize, resize your window for start it!</h4>
<br>
<div id="carouselTicker-width-resize" class="carouselTicker">
<ul class="carouselTicker__list">
<li class="carouselTicker__item">1</li>
<li class="carouselTicker__item">2</li>
<li class="carouselTicker__item">3</li>
<li class="carouselTicker__item">4</li>
<li class="carouselTicker__item">5</li>
</ul>
</div>
<br>
<h4>Vertical mode</h4>
<br>
<div style="overflow: hidden;">
<div style="float: left; width: 50%;">
<div style="height: 600px; width: 108px; ">
<div id="carouselTicker-vertical" class="carouselTicker carouselTicker_vertical">
<ul class="carouselTicker__list">
<li class="carouselTicker__item">1</li>
<li class="carouselTicker__item">2</li>
<li class="carouselTicker__item">3</li>
<li class="carouselTicker__item">4</li>
<li class="carouselTicker__item">5</li>
<li class="carouselTicker__item">6</li>
<li class="carouselTicker__item">7</li>
<li class="carouselTicker__item">8</li>
<li class="carouselTicker__item">9</li>
<li class="carouselTicker__item">10</li>
<li class="carouselTicker__item">11</li>
<li class="carouselTicker__item">12</li>
<li class="carouselTicker__item">13</li>
<li class="carouselTicker__item">14</li>
<li class="carouselTicker__item">15</li>
</ul>
</div>
</div>
</div>
<div style="float: left; width: 50%;">
<div style="height: 600px; width: 108px; ">
<div id="carouselTicker-vertical-with-callback" class="carouselTicker carouselTicker_vertical">
<ul class="carouselTicker__list">
<li class="carouselTicker__item">1</li>
<li class="carouselTicker__item">2</li>
<li class="carouselTicker__item">3</li>
<li class="carouselTicker__item">4</li>
<li class="carouselTicker__item">5</li>
<li class="carouselTicker__item">6</li>
<li class="carouselTicker__item">7</li>
<li class="carouselTicker__item">8</li>
<li class="carouselTicker__item">9</li>
<li class="carouselTicker__item">10</li>
<li class="carouselTicker__item">11</li>
<li class="carouselTicker__item">12</li>
<li class="carouselTicker__item">13</li>
<li class="carouselTicker__item">14</li>
<li class="carouselTicker__item">15</li>
</ul>
</div>
</div>
</div>
</div>
<h4>Example with destruction</h4>
<br>
<div id="carouselTicker-destructor-example" class="carouselTicker">
<ul class="carouselTicker__list">
<li class="carouselTicker__item">
<a href="#"><img src="https://placehold.it/190x65" alt="banner image"></a>
</li>
<li class="carouselTicker__item">
<a href="#"><img src="https://placehold.it/190x65" alt="banner image"></a>
</li>
<li class="carouselTicker__item">
<a href="#"><img src="https://placehold.it/190x65" alt="banner image"></a>
</li>
<li class="carouselTicker__item">
<a href="#"><img src="https://placehold.it/190x65" alt="banner image"></a>
</li>
<li class="carouselTicker__item">
<a href="#"><img src="https://placehold.it/190x65" alt="banner image"></a>
</li>
<li class="carouselTicker__item">
<a href="#"><img src="https://placehold.it/190x65" alt="banner image"></a>
</li>
</ul>
</div>
<button id="destory-carouselTicker">
Destroy
</button>
<h4>Example with control buttons</h4>
<br>
<div id="carouselTicker-buttons-controls-example" class="carouselTicker">
<ul class="carouselTicker__list">
<li class="carouselTicker__item">
<a href="#"><img src="https://placehold.it/190x65" alt="banner image"></a>
</li>
<li class="carouselTicker__item">
<a href="#"><img src="https://placehold.it/190x65" alt="banner image"></a>
</li>
<li class="carouselTicker__item">
<a href="#"><img src="https://placehold.it/190x65" alt="banner image"></a>
</li>
<li class="carouselTicker__item">
<a href="#"><img src="https://placehold.it/190x65" alt="banner image"></a>
</li>
<li class="carouselTicker__item">
<a href="#"><img src="https://placehold.it/190x65" alt="banner image"></a>
</li>
<li class="carouselTicker__item">
<a href="#"><img src="https://placehold.it/190x65" alt="banner image"></a>
</li>
</ul>
</div>
<button id="carouselTicker-buttons-controls-prev">
Left
</button>
<button id="carouselTicker-buttons-controls-stop">
Stop
</button>
<button id="carouselTicker-buttons-controls-next">
Right
</button>
</div>
<br><br>
<div id="getting-started">
<h1>Getting Started</h1>
<h3>1. Load jQuery and include carouselTicker's plugin files</h3>
<p>After you download carouselTicker, move carouselTicker.css and jquery.carouselTicker.js to you root's CSS and Javascript directories. Next, load JQuery and include carouselTicker CSS and Javascript files inside of your tags:</p>
<p>
<pre>
<span class="tag"><head></span><span class="pln">
...
</span><span class="tag"><link</span><span class="pln"> </span><span class="atn">rel</span><span class="pun">=</span><span class="atv">"stylesheet"</span><span class="pln"> </span><span class="atn">type</span><span class="pun">=</span><span class="atv">"text/css"</span><span class="pln"> </span><span class="atn">href</span><span class="pun">=</span><span class="atv">"stylesheets/carouselTicker.css"</span><span class="pln"> </span><span class="tag">/></span><span class="pln">
</span><span class="tag"><script</span><span class="pln"> </span><span class="atn">type</span><span class="pun">=</span><span class="atv">"text/javascript"</span><span class="pln"> </span><span class="atn">src</span><span class="pun">=</span><span class="atv">"https://ajax.googleapis.com/ajax/libs/jquery/1.9.1/jquery.min.js"</span><span class="tag">></script></span><span class="pln">
</span><span class="tag"><script</span><span class="pln"> </span><span class="atn">type</span><span class="pun">=</span><span class="atv">"text/javascript"</span><span class="pln"> </span><span class="atn">src</span><span class="pun">=</span><span class="atv">"javascripts/jquery.carouselTicker.js"</span><span class="tag">></script></span><span class="pln">
...
</span><span class="tag"></head></span></pre>
</p>
<h3>2. Set up your HTML</h3>
<p>Class Naming carouselTicker based on BEM principles, so we need main element-container with main name for example "carouselTicker", inside tag.carouselTicker__list - that will be container-list with our content items and inside it we can include items like tag.carouselTicker__item</p>
<h4>Example HTML</h4>
<p>
<pre>
<span class="tag"><div </span><span class="atn">class</span><span class="pun">=</span><span class="atv">"carouselTicker"</span>>
<span class="tag"><ul </span><span class="atn">class</span><span class="pun">=</span><span class="atv">"carouselTicker__list"</span>>
<span class="tag"><li </span><span class="atn">class</span><span class="pun">=</span><span class="atv">"carouselTicker__list"</span>><span class="pln">1</span><span class="tag"></li></span>
<span class="tag"><li </span><span class="atn">class</span><span class="pun">=</span><span class="atv">"carouselTicker__list"</span>><span class="pln">2</span><span class="tag"></li></span><span class="pln">
...
</span><span class="tag"><li </span><span class="atn">class</span><span class="pun">=</span><span class="atv">"carouselTicker__list"</span>><span class="pln">n</span><span class="tag"></li></span>
<span class="tag"></ul></span>
<span class="tag"></div></span></pre>
</p>
<h3>3. Activate carouselTicker</h3>
<p>The last thing we have to do is activate the plugin. To do this, add the following script right before your closing <span class="tag"></head></span> tag</p>
<p>
<pre>
<span class="tag"><head></span><span class="pln">
...
</span><span class="tag"><script></span><span class="pln">
$</span><span class="pun">(</span><span class="pln">document</span><span class="pun">).</span><span class="pln">ready</span><span class="pun">(</span><span class="kwd">function</span><span class="pun">()</span><span class="pln"> </span><span class="pun">{</span><span class="pln">
$</span><span class="pun">(</span><span class="str">'.carouselTicker'</span><span class="pun">).</span><span class="pln">carouselTicker</span><span class="pun">();</span><span class="pln">
</span><span class="pun">});</span><span class="pln">
</span><span class="tag"></script></span><span class="pln">
</span><span class="tag"></head></span></pre>
</p>
<h4>Customizing carouselTicker Functionality</h4>
<p>carouselTicker options gives you a wide range of variables(in future ;) ) to tweak functionality. To learn more about all of the options, read the Options section. Here's just a few of the things you can play with:</p>
<p>
<pre>
<span class="pln">$</span><span class="pun">(</span><span class="str">'.carouselTicker'</span><span class="pun">).</span><span class="pln">carouselTicker</span><span class="pun">({</span><span class="pln">
speed</span><span class="pun">:</span><span class="pln"> </span><span class="str">5</span><span class="pun">,</span><span class="pln">
delay</span><span class="pun">:</span><span class="pln"> </span><span class="lit">50</span><span class="pun">,</span><span class="pln">
reverse</span><span class="pun">:</span><span class="pln"> </span><span class="str">true</span><span class="pun">
</span><span class="pun">});</span></pre>
</p>
<div id="options">
<h1>Options</h1>
<h3>3. Activate carouselTicker</h3>
<table>
<tr>
<td>mode</td>
<td>string</td>
<td>Determines vertical or horizontal direction carouselTicker. <strong>Default: "horizontal"</strong></td>
</tr>
<tr>
<td>speed</td>
<td>integer</td>
<td>Determines speed rotate the carouselTicker. <strong>Default: 1</strong></td>
</tr>
<tr>
<td>delay</td>
<td>integer</td>
<td>This is parameter determines speed the carouselTicker. <strong>Default: 30</strong></td>
</tr>
<tr>
<td>reverse</td>
<td>boolean</td>
<td>Determines direction carouselTicker. <strong>Default: false</strong></td>
</tr>
<tr>
<td>onCarouselTickerLoad</td>
<td>function</td>
<td>Called after the carouselTicker has been load.</td>
</tr>
</table>
</div><!-- end #options -->
<div id="advanced">
<h1>Advanced</h1>
<h3>The CarouselTicker API</h3>
<p>The CarouselTicker API was created to be as flexible and easy to use as possible. The API allows you to create custom triggers, to be sensitivity to resize, destroy CarouselTicker functionality if needed. </p>
<p>Here is a quick look at all of the API methods:</p>
<p>
<pre><span class="com">// set callback on load carouselTicker</span><span class="pln">
$</span><span class="pun">(...).</span><span class="pln">carouselTicker</span><span class="pun">(</span><span class="str">'onCarouselTickerLoad'</span><span class="pun">: </span><span class="pln"> function<span class="pun">() {</span> callback </span><span class="pun">});</span><span class="pln">
<span class="com">// set resize handler on carouselTicker</span><span class="pln">
$</span><span class="pun">(window).</span><span class="pln">on</span><span class="pun">(</span><span class="str">'resize',</span> <span class="pln">function<span class="pun">() {</span>
$</span><span class="pun">(...).</span><span class="pln">carouselTicker().resizeTicker();</span>
<span class="pun">});</span><span class="pln">
<span class="com">// destroy carouselTicker</span><span class="pln">
$</span><span class="pun">(...).</span><span class="pln">carouselTicker().destructor();</span>
<span class="com">// reload carouselTicker</span><span class="pln">
$</span><span class="pun">(...).</span><span class="pln">carouselTicker().reloadCarouselTicker();</span>
<span class="com">// stop carouselTicker</span><span class="pln">
$</span><span class="pun">(...).</span><span class="pln">carouselTicker().stop();</span>
<span class="com">// run carouselTicker</span><span class="pln">
$</span><span class="pun">(...).</span><span class="pln">carouselTicker().run();</span>
<span class="com">// run to left/up direction carouselTicker</span><span class="pln">
$</span><span class="pun">(...).</span><span class="pln">carouselTicker().prev();</span>
<span class="com">// run to right/down direction carouselTicker</span><span class="pln">
$</span><span class="pun">(...).</span><span class="pln">carouselTicker().next();</span>
</pre>
</p>
</div><!-- end #advanced -->
<div id="talk">
<h1>Talk</h1>
<h3>Share thoughts, questions, & bugs!</h3>
<p>Head on over to carouselTicker's issue tracker on GitHub: <a href="https://github.com/likeclever1/carouselTicker/issues">https://github.com/likeclever1/carouselTicker/issues</a></p>
</div><!-- end #advanced -->
</div>
</section>
<aside id="sidebar">
<nav class="menu">
<a href="https://github.com/likeclever1/carouselTicker/archive/gh-pages.zip">Download</a>
<a href="#demos">Demos</a>
<a href="#getting-started">Get Started</a>
<a href="#options">Options</a>
<a href="#advanced">Advanced</a>
<a href="#talk">Talk</a>
</nav>
</aside>
</div>
</div>
<footer>
<p>
Developed and maintained by <a href="mailto: yuriy.beresovskiy@gmail.com" class="white">Berezovskiy Yuriy</a> under the <a href="https://opensource.org/licenses/MIT" class="white">MIT license</a>
</p>
</footer>
<script src="https://code.jquery.com/jquery-3.5.1.js" integrity="sha256-QWo7LDvxbWT2tbbQ97B53yJnYU3WhH/C8ycbRAkjPDc=" crossorigin="anonymous"></script>
<script type="text/javascript" src="javascripts/jquery.carouselTicker.js"></script>
<script type="text/javascript" src="javascripts/start.js"></script>
</body>
</html>