-
-
Notifications
You must be signed in to change notification settings - Fork 2
/
media.html
528 lines (500 loc) · 18.2 KB
/
media.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
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
<!DOCTYPE html>
<html lang="en">
<head>
{{> head }}
</head>
<body>
{{> navbar }}
<main>
{{> intro}}
<div class="container">
<div class="row">
<div class="col s12 m8 offset-m1 xl7 offset-xl1">
<p class="caption">
Media components include things that have to do with large media
objects like Images, Video, Audio, etc.
</p>
<div id="materialbox" class="scrollspy section">
<h3 class="header">Material Box</h3>
<p class="caption">
Material box is a material design implementation of the Lightbox
plugin. When a user clicks on an image that can be enlarged,
Material box centers the image and enlarges it in a smooth,
non-jarring manner. To dismiss the image, the user can either
click on the image again, scroll away, or press the ESC key.
</p>
<img
class="materialboxed responsive-img"
width="650"
alt="Material Box sample image"
src="images/sample-1.jpg"
/>
<p>
Creating the above image with the effect is as simple as adding
a <code class="language-markup">materialboxed</code> class to
the image tag.
</p>
<pre><code class="language-markup">
<img class="materialboxed" width="650" alt="Material Box sample image" src="images/sample-1.jpg">
</code></pre>
<h4>Initialization</h4>
<pre><code class="language-javascript">
document.addEventListener('DOMContentLoaded', function() {
var elems = document.querySelectorAll('.materialboxed');
var instances = M.Materialbox.init(elems, {
// specify options here
});
});
</code></pre>
<h4>Options</h4>
<table class="striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>inDuration</td>
<td>Number</td>
<td>275</td>
<td>Transition in duration in milliseconds.</td>
</tr>
<tr>
<td>outDuration</td>
<td>Number</td>
<td>200</td>
<td>Transition out duration in milliseconds.</td>
</tr>
<tr>
<td>onOpenStart</td>
<td>Function</td>
<td>null</td>
<td>
Callback function called before materialbox is opened.
</td>
</tr>
<tr>
<td>onOpenEnd</td>
<td>Function</td>
<td>null</td>
<td>
Callback function called after materialbox is opened.
</td>
</tr>
<tr>
<td>onCloseStart</td>
<td>Function</td>
<td>null</td>
<td>
Callback function called before materialbox is closed.
</td>
</tr>
<tr>
<td>onCloseEnd</td>
<td>Function</td>
<td>null</td>
<td>
Callback function called after materialbox is closed.
</td>
</tr>
</tbody>
</table>
<h4>Methods</h4>
<blockquote>
<p>
All the methods are called on the plugin instance. You can get
the plugin instance like this:
</p>
<pre><code class="language-javascript col s12">
var instance = M.Materialbox.getInstance(elem);
</code></pre>
</blockquote>
<h5 class="method-header">
.open();
</h5>
<p>Open materialbox</p>
<pre><code class="language-javascript col s12">
instance.open();
</code></pre>
<h5 class="method-header">
.close();
</h5>
<p>Close materialbox</p>
<pre><code class="language-javascript col s12">
instance.close();
</code></pre>
<h5 class="method-header">
.destroy();
</h5>
<p>Destroy plugin instance and teardown</p>
<pre><code class="language-javascript col s12">
instance.destroy();
</code></pre>
<h4>Properties</h4>
<table class="striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>el</td>
<td>Element</td>
<td>The DOM element the plugin was initialized with.</td>
</tr>
<tr>
<td>options</td>
<td>Object</td>
<td>The options the instance was initialized with.</td>
</tr>
<tr>
<td>overlayActive</td>
<td>Boolean</td>
<td>If the materialbox overlay is showing.</td>
</tr>
<tr>
<td>doneAnimating</td>
<td>Boolean</td>
<td>If the carousel is no longer being animated.</td>
</tr>
<tr>
<td>caption</td>
<td>String</td>
<td>Caption if specified.</td>
</tr>
<tr>
<td>originalWidth</td>
<td>Number</td>
<td>Original width of image.</td>
</tr>
<tr>
<td>originalHeight</td>
<td>Number</td>
<td>Original height of image.</td>
</tr>
</tbody>
</table>
<h4>Captions</h4>
<p>
It is very easy to add a short caption to your photo. Just add
the caption as a
<code class="language-markup">data-caption</code> attribute.
</p>
<img
class="materialboxed"
data-caption="A picture of a way with a group of trees in a park"
width="250"
src="images/placeholder/800x400_d.jpg"
/>
<pre><code class="language-markup">
<img class="materialboxed" data-caption="A picture of a way with a group of trees in a park" width="250" alt="Sample image for Material Box with caption" src="images/placeholder/800x400_d.jpg">
</code></pre>
</div>
<!-- Slider Section -->
<div id="slider" class="scrollspy section">
<h3 class="header">Slider</h3>
<p class="caption">
Our slider is a simple and elegant image carousel. You can also
have captions that will be transitioned on their own depending
on their alignment. You can also have indicators that show up on
the bottom of the slider.
</p>
<div class="slider">
<ul class="slides">
<li>
<img
src="images/placeholder/800x400_a.jpg"
alt="Sample image for first slide"
/>
<!-- random image -->
<div class="caption center-align">
<h3>This is our big Tagline!</h3>
<h5 class="light">Here's our small slogan.</h5>
</div>
</li>
<li>
<img
src="images/placeholder/800x400_b.jpg"
alt="Sample image for second slide"
/>
<!-- random image -->
<div class="caption left-align">
<h3>Left Aligned Caption</h3>
<h5 class="light">Here's our small slogan.</h5>
</div>
</li>
<li>
<img
src="images/placeholder/800x400_c.jpg"
alt="Sample image for third slide"
/>
<!-- random image -->
<div class="caption right-align">
<h3>Right Aligned Caption</h3>
<h5 class="light">Here's our small slogan.</h5>
</div>
</li>
<li>
<img
src="images/placeholder/800x400_d.jpg"
alt="Sample image for fourth slide"
/>
<!-- random image -->
<div class="caption center-align">
<h3>This is our big Tagline!</h3>
<h5 class="light">Here's our small slogan.</h5>
</div>
</li>
</ul>
</div>
<pre><code class="language-markup">
<div class="slider">
<ul class="slides">
<li>
<img src="images/placeholder/800x400_a.jpg" alt="Sample image for first slide">
<div class="caption center-align">
<h3>This is our big Tagline!</h3>
<h5 class="light">Here's our small slogan.</h5>
</div>
</li>
<li>
<img src="images/placeholder/800x400_b.jpg" alt="Sample image for second slide">
<div class="caption left-align">
<h3>Left Aligned Caption</h3>
<h5 class="light">Here's our small slogan.</h5>
</div>
</li>
<li>
<img src="images/placeholder/800x400_c.jpg" alt="Sample image for third slide">
<div class="caption right-align">
<h3>Right Aligned Caption</h3>
<h5 class="light">Here's our small slogan.</h5>
</div>
</li>
<li>
<img src="images/placeholder/800x400_d.jpg" alt="Sample image for fourth slide">
<div class="caption center-align">
<h3>This is our big Tagline!</h3>
<h5 class="light">Here's our small slogan.</h5>
</div>
</li>
</ul>
</div>
</code></pre>
<h4>Initialization</h4>
<pre><code class="language-javascript">
document.addEventListener('DOMContentLoaded', function() {
var elems = document.querySelectorAll('.slider');
var instances = M.Slider.init(elems, {
// specify options here
/** Optional function which generates ARIA label for each indicator */
indicatorLabelFunc: (idx, current) => {
let label = "Go to slide " + idx;
if (current) {
label = label + " (Current)";
}
return label;
}
});
});
</code></pre>
<h4>Options</h4>
<table class="striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>indicators</td>
<td>Boolean</td>
<td>true</td>
<td>Set to false to hide slide indicators.</td>
</tr>
<tr>
<td>height</td>
<td>Number</td>
<td>400</td>
<td>Set height of slider.</td>
</tr>
<tr>
<td>duration</td>
<td>Number</td>
<td>500</td>
<td>Set the duration of the transition animation in ms.</td>
</tr>
<tr>
<td>interval</td>
<td>Number</td>
<td>6000</td>
<td>Set the duration between transitions in ms.</td>
</tr>
<tr>
<td>pauseOnFocus</td>
<td>Boolean</td>
<td>true</td>
<td>
If slider should pause when keyboard focus is received.
</td>
</tr>
<tr>
<td>pauseOnHover</td>
<td>Boolean</td>
<td>true</td>
<td>
If slider should pause when is hovered by a pointer.
</td>
</tr>
<tr>
<td>indicatorLabelFunc</td>
<td>Function</td>
<td>null</td>
<td>
<p>
Optional function used to generate ARIA label to
indicators (for accessibility purposes).
</p>
<p>
It receives the current index, starting from "1", and a
boolean indicating whether it is the current element or
not.
</p>
<p>
If not specified, the generated label is going to be the
current index.
</p>
</td>
</tr>
</tbody>
</table>
<h4>Methods</h4>
<p>
We have methods to pause, start, move to next and move to
previous slide.
</p>
<blockquote>
<p>
All the methods are called on the plugin instance. You can get
the plugin instance like this:
</p>
<pre><code class="language-javascript col s12">
var instance = M.Slider.getInstance(elem);
</code></pre>
</blockquote>
<h5 class="method-header">
.pause();
</h5>
<p>Pause slider autoslide</p>
<pre><code class="language-javascript col s12">
instance.pause();
</code></pre>
<h5 class="method-header">
.start();
</h5>
<p>Start slider autoslide</p>
<pre><code class="language-javascript col s12">
instance.start();
</code></pre>
<h5 class="method-header">
.next();
</h5>
<p>Move to next slider</p>
<pre><code class="language-javascript col s12">
instance.next();
</code></pre>
<h5 class="method-header">
.prev();
</h5>
<p>Move to prev slider</p>
<pre><code class="language-javascript col s12">
instance.prev();
</code></pre>
<h5 class="method-header">
.destroy();
</h5>
<p>Destroy plugin instance and teardown</p>
<pre><code class="language-javascript col s12">
instance.destroy();
</code></pre>
<h4>Properties</h4>
<table class="striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>el</td>
<td>Element</td>
<td>The DOM element the plugin was initialized with.</td>
</tr>
<tr>
<td>options</td>
<td>Object</td>
<td>The options the instance was initialized with.</td>
</tr>
<tr>
<td>activeIndex</td>
<td>Number</td>
<td>Index of current slide.</td>
</tr>
<tr>
<td>eventPause</td>
<td>Boolean</td>
<td>
Indicates whether the slider is paused by a focus/mouse
event or not.
</td>
</tr>
</tbody>
</table>
<h4>Fullscreen Slider</h4>
<p>
You can easliy make this slider a fullscreen slider by adding
the class <code class="language-markup">fullscreen</code> to the
slider div. Here's a quick demo.
</p>
<a
href="fullscreen-slider-demo.html"
target="_blank"
class="btn-large waves-effect waves-light"
>Open Demo</a
>
</div>
</div>
<!-- Table of Contents -->
<div class="col hide-on-small-only m3 xl3">
<div class="toc-wrapper">
<div style="height: 1px;">
<ul class="section table-of-contents">
<li>
<a href="#materialbox">Material Box</a>
</li>
<li>
<a href="#slider">Slider</a>
</li>
</ul>
</div>
</div>
</div>
</div>
</div>
</main>
{{> footer }}
<script type="module" src="/src/main.ts"></script>
</body>
</html>