-
Notifications
You must be signed in to change notification settings - Fork 0
/
documentation.html
653 lines (560 loc) · 39 KB
/
documentation.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
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link href="css/heinz.min.css" rel="stylesheet">
<link href="css/prism.css" rel="stylesheet" />
<title>Heinz - Documentation</title>
<link rel="apple-touch-icon" sizes="180x180" href="media/favicons/apple-touch-icon.png">
<link rel="icon" type="image/png" sizes="32x32" href="media/favicons/favicon-32x32.png">
<link rel="icon" type="image/png" sizes="16x16" href="media/favicons/favicon-16x16.png">
<link rel="manifest" href="media/favicons/manifest.json">
<link rel="mask-icon" href="media/favicons/safari-pinned-tab.svg" color="#5bbad5">
<meta name="theme-color" content="#ffffff">
</head>
<body>
<header class="head">
<nav class="menu boxed">
<div class="bar">
<a href="https://htw-mmp.github.io/heinz/" class="branding">
<img src="media/heinz_h.svg">
</a>
<a class="fork-link" target="_blank"href="https://github.com/HTW-MMP/heinz/"><img style="position: absolute; top: 0; right: 0; border: 0;z-index: 10001;" src="https://camo.githubusercontent.com/a6677b08c955af8400f44c6298f40e7d19cc5b2d/68747470733a2f2f73332e616d617a6f6e6177732e636f6d2f6769746875622f726962626f6e732f666f726b6d655f72696768745f677261795f3664366436642e706e67" alt="Fork me on GitHub" data-canonical-src="https://s3.amazonaws.com/github/ribbons/forkme_right_gray_6d6d6d.png"></a>
<span class="toggle-code btn code-display">Code:</span>
<span class="nav-toggle">
<div class="hamburger">toggle menu</div>
</span>
<ul>
<li><span class="nav-toggle"><div class="ex">close</div></span></li>
<li class="dropdown"><span class="current">Documentation</span><div class="toc"></div></li>
<li><a href="docSass.html">Sass</a></li>
</ul>
</div>
<div class="scrollspy-wrapper">
<div class="scrollbar"></div>
</div>
</nav>
</header>
<!-- main section has class grid, in the grid there are secions, if section needs background, add class box -->
<main class="main grid">
<section class="box">
<div class="toc">
<h1 class="no-toc">Table Of Contents</h1>
</div>
<h1>Introduction</h1>
<h2 id="quick-start">Quick Start</h2>
<ol>
<li>Download the latest release on <a href="https://getheinz.com/">getheinz.com</a>.</li>
<li>Open the included index.html file.</li>
<li>Fill it with your content.</li>
<li>And that’s about it — you’re about to come down the stretch and have your very own multimedia story. If you’re unsure about the general structure, keep reading.</li>
</ol>
<h2 id="starter-template">Freshness</h2>
<p>Heinz is developed for modern browsers only – because the future is awesome.</p>
<p>Although, always be sure to have your pages set up with the latest design and development standards. That means using an HTML5 doctype and including a viewport meta tag for proper responsive behaviors. Still we recommend you to use an autoprefixer. ;)</p>
</section>
<section class="box">
<h1 id="documentation">Documentation</h1>
<p class="text-lead code-display">Notice: the switch in the navbar toggles Code Visibility, turn it off to get an idea of what a story example could look like.</p>
<h2 id="layout">Layout</h2>
<h3 id="grid">Grid</h3>
<p>If you don't like the gray background and boxed look of the design, you can simply remove the <code class="language-markup">boxed</code> CSS class from the body tag and achieve a flat white look.</p>
<p>Heinz is created using a 12-column grid. You can define a separate grid outside of our prepared layout, just make sure to add a class of <code class="language-markup">grid</code> to your parent.</p>
<p>The Children of the grid can vary in width. The class <code class="language-markup">item-span-suffix-columnNumbers</code> defines the behavior of the item. There are different classes to help you manage the breakpoints. The <code class="language-markup">-lg</code> suffix describes the item-span up until the breakpoint for medium screen size, <code class="language-markup">-md</code> up until the small breakpoint <code class="language-markup">-sm</code> up until extra small. To create a fully responsive layout, it is recommended to combine the classes. As an example to create a grid that has 4 items in a row on large screens, 3 items on medium, 2 on small and 1 on extra small, you'd apply 3 clases to your grid item.</p>
<pre><code class="language-markup"><div class="item-span-lg-3 item-span-md-4 item-span-sm-6"></div></code></pre>
<p>Take a look at the following examples to visualize, try resizing the window to see the behavior.</p>
<h4>Grid inside Section</h4>
<div style="border: 1px solid black" class="item-span-8">.item-span-8</div>
<div style="border: 1px solid black" class="item-span-7">.item-span-7</div>
<div style="border: 1px solid black" class="item-span-6">.item-span-6</div>
<div style="border: 1px solid black" class="item-span-5">.item-span-5</div>
<div style="border: 1px solid black" class="item-span-4">.item-span-4</div>
<div style="border: 1px solid black" class="item-span-3">.item-span-3</div>
<div style="border: 1px solid black" class="item-span-2">.item-span-2</div>
<div style="border: 1px solid black" class="item-span-1">.item-span-1</div>
</section>
<section class="box full-width">
<h4 class="item-span-12">Static Grid</h4>
<div style="border: 1px solid black" class="item-span-12 box">item-span-12</div>
<div style="border: 1px solid black" class="item-span-11 box">item-span-11</div>
<div style="border: 1px solid black" class="item-span-10 box">item-span-10</div>
<div style="border: 1px solid black" class="item-span-9 box">item-span-9</div>
<div style="border: 1px solid black" class="item-span-8 box">item-span-8</div>
<div style="border: 1px solid black" class="item-span-7 box">item-span-7</div>
<div style="border: 1px solid black" class="item-span-6 box">item-span-6</div>
<div style="border: 1px solid black" class="item-span-5 box">item-span-5</div>
<div style="border: 1px solid black" class="item-span-4 box">item-span-4</div>
<div style="border: 1px solid black" class="item-span-3 box">item-span-3</div>
<div style="border: 1px solid black" class="item-span-2 box">item-span-2</div>
<div style="border: 1px solid black" class="item-span-1 box">item-span-1</div>
<h4 class="item-span-lg-12">Large Grid</h4>
<div style="border: 1px solid black" class="item-span-lg-12 box">item-span-12</div>
<div style="border: 1px solid black" class="item-span-lg-11 box">item-span-11</div>
<div style="border: 1px solid black" class="item-span-lg-10 box">item-span-10</div>
<div style="border: 1px solid black" class="item-span-lg-9 box">item-span-9</div>
<div style="border: 1px solid black" class="item-span-lg-8 box">item-span-8</div>
<div style="border: 1px solid black" class="item-span-lg-7 box">item-span-7</div>
<div style="border: 1px solid black" class="item-span-lg-6 box">item-span-6</div>
<div style="border: 1px solid black" class="item-span-lg-5 box">item-span-5</div>
<div style="border: 1px solid black" class="item-span-lg-4 box">item-span-4</div>
<div style="border: 1px solid black" class="item-span-lg-3 box">item-span-3</div>
<div style="border: 1px solid black" class="item-span-lg-2 box">item-span-2</div>
<div style="border: 1px solid black" class="item-span-lg-1 box">item-span-1</div>
<h4 class="item-span-md-12">Medium Grid</h4>
<div style="border: 1px solid black" class="item-span-md-12 box">item-span-12</div>
<div style="border: 1px solid black" class="item-span-md-11 box">item-span-11</div>
<div style="border: 1px solid black" class="item-span-md-10 box">item-span-10</div>
<div style="border: 1px solid black" class="item-span-md-9 box">item-span-9</div>
<div style="border: 1px solid black" class="item-span-md-8 box">item-span-8</div>
<div style="border: 1px solid black" class="item-span-md-7 box">item-span-7</div>
<div style="border: 1px solid black" class="item-span-md-6 box">item-span-6</div>
<div style="border: 1px solid black" class="item-span-md-5 box">item-span-5</div>
<div style="border: 1px solid black" class="item-span-md-4 box">item-span-4</div>
<div style="border: 1px solid black" class="item-span-md-3 box">item-span-3</div>
<div style="border: 1px solid black" class="item-span-md-2 box">item-span-2</div>
<div style="border: 1px solid black" class="item-span-md-1 box">item-span-1</div>
<h4 class="item-span-sm-12">Small Grid</h4>
<div style="border: 1px solid black" class="item-span-sm-12 box">item-span-12</div>
<div style="border: 1px solid black" class="item-span-sm-11 box">item-span-11</div>
<div style="border: 1px solid black" class="item-span-sm-10 box">item-span-10</div>
<div style="border: 1px solid black" class="item-span-sm-9 box">item-span-9</div>
<div style="border: 1px solid black" class="item-span-sm-8 box">item-span-8</div>
<div style="border: 1px solid black" class="item-span-sm-7 box">item-span-7</div>
<div style="border: 1px solid black" class="item-span-sm-6 box">item-span-6</div>
<div style="border: 1px solid black" class="item-span-sm-5 box">item-span-5</div>
<div style="border: 1px solid black" class="item-span-sm-4 box">item-span-4</div>
<div style="border: 1px solid black" class="item-span-sm-3 box">item-span-3</div>
<div style="border: 1px solid black" class="item-span-sm-2 box">item-span-2</div>
<div style="border: 1px solid black" class="item-span-sm-1 box">item-span-1</div>
<h4 class="item-span-12">Combined</h4>
<div style="border: 1px solid black" class="box item-span-lg-3 item-span-md-4 item-span-sm-6">item-span-lg-3 item-span-md-4 item-span-sm-6</div>
<div style="border: 1px solid black" class="box item-span-lg-3 item-span-md-4 item-span-sm-6">item-span-lg-3 item-span-md-4 item-span-sm-6</div>
<div style="border: 1px solid black" class="box item-span-lg-3 item-span-md-4 item-span-sm-6">item-span-lg-3 item-span-md-4 item-span-sm-6</div>
<div style="border: 1px solid black" class="box item-span-lg-3 item-span-md-4 item-span-sm-6">item-span-lg-3 item-span-md-4 item-span-sm-6</div>
<div style="border: 1px solid black" class="box item-span-lg-3 item-span-md-4 item-span-sm-6">item-span-lg-3 item-span-md-4 item-span-sm-6</div>
<div style="border: 1px solid black" class="box item-span-lg-3 item-span-md-4 item-span-sm-6">item-span-lg-3 item-span-md-4 item-span-sm-6</div>
<div style="border: 1px solid black" class="box item-span-lg-3 item-span-md-4 item-span-sm-6">item-span-lg-3 item-span-md-4 item-span-sm-6</div>
<div style="border: 1px solid black" class="box item-span-lg-3 item-span-md-4 item-span-sm-6">item-span-lg-3 item-span-md-4 item-span-sm-6</div>
</section>
<section class="box">
<h3>Sections</h3>
<p>While we're at it, let's talk about sections. All of your content is to be placed within a section tag.</p>
<p>If you are working with the boxed layout (as you can see on the <a href="docSass.html">Sass Documentation Page</a>) you want to add a class of box to your section to ensure it has a white background and looks right.</p>
<p>There are generally two different types of sections, the default section which spans across 8 of the predefined 12 columns and full-width sections, generally you'll find yourself using the default section for most of your content, however some of our components require to be placed within a full-width section, the Documentation will mention it.</p>
<p>Important to note is that <b>a full-width section cannot be placed inside a default-width section.</b></p>
<p>We recommend using sections to divide your content into chapters, so don't be afraid to create new sections, when you feel like it makes sense for the content.</p>
<pre><code class="language-markup"><section class="box">
<h1>A Section talking about one thing</h1>
<!-- content and components -->
</section>
<section class="box">
<h1>A Section talking about another thing</h1>
<!-- content and components -->
</section>
<section class="full-width">
<h1>A Section that spans across the full width.</h1>
<!-- content and components -->
</section></code></pre>
</section>
<section class="box">
<h2 id="components">Components</h2>
<h3>Table Of Contents</h3>
<p class="text-center"><span class="text-highlighted">This feature requires JavaScript.</span></p>
<p>Heinz includes an automatic Table of Contents, that'll read all headings up until h3 and list them. All you need to do is include a div-container for it.</p>
<p>If you want a header not to show up in the Table Of Contents (like the Table of Contents Title) all you do is add a <code class="language-markup">no-toc</code> class to the heading.</p>
<pre><code class="language-markup"><div class="toc">
<h1 class="no-toc">Table Of Contents</h1>
</div></code></pre>
<h3 id="navbar">Navbar</h3>
<p class="text-center"><span class="text-highlighted">This feature requires JavaScript.</span></p>
<p>The Navbar in our example consists of the Navigation as well a visual representation of the sections and a progressbar.</p>
<p>We recommend placing this Code in the <code class="language-markup"><header></code></p>
<p>You can see and example of what the navbar looks like at the top of this page. It is fixed and responsive, and will collapse into an off-canvas menu on small screens.</p>
<pre><code class="language-markup"><nav class="menu boxed">
<div class="bar">
<a href="/" class="branding">
<!-- Brand -->
</a>
<span class="nav-toggle">
<div class="hamburger">toggle menu</div>
</span>
<!-- Navigation Code Here -->
</div>
<!-- Progressbar Code Here -->
</nav></code></pre>
<h4 id="navigation">Navigation</h4>
<p>On the left, you'll include all brandings. We planned for it to consist of a small logo as well as a short title.</p>
<pre><code class="language-markup"><a href="/" class="branding">
<img src="icon.svg">
<span>Story Title</span>
</a></code></pre>
<p>On the right, you have the option to include a list of links. The Menu comes with a dropdown option.</p>
<p>Don't forget to include the <code class="language-markup">nav-toggle</code> and include the js-file to make sure the menu will work responsively and that the dropdowns will open up.</p>
<pre><code class="language-markup"><ul>
<li><span class="nav-toggle"><div class="ex">close</div></span></li>
<li><a href="#">Item</a></li> <!-- normal Item -->
<li class="dropdown"> <!-- dropdown Item -->
<span>parent</span>
<ul>
<li><a href="#">Child</a></li>
<li><a href="#">Child</a></li>
<li><a href="#">Child</a></li>
</ul>
</li>
<li><a href="#">Item</a></li>
</ul></code></pre>
<h4 id="progressbar">Progressbar</h4>
<p>The progressbar is a visual representation of all sections within a document. It is created using JavaScript.</p>
<pre><code class="language-markup"><div class="scrollspy-wrapper display-titles">
<div class="scrollbar"></div>
</div></code></pre>
<p>There are two different versions of the progressbar, a minimal one, without titles and one with titles displayed (Refer to the <a href="docSass.html">Sass Docs</a> to see those in action).</p>
<p>To toggle the title display all you have to do is to add or remove <code class="language-markup">display-titles</code> from the wrapper classes.</p>
<p>The title that is displayed can be defined using a data-attribute within the section tag, or represents the first heading within the section.</p>
<pre><code class="language-markup"><section data-section-title="Progressbar Title">
<!-- Content -->
</section></code></pre>
<h3 id="text">Text Classes</h3>
<p>We've baked some text styling for you.</p>
<h4>Headings</h4>
<p>Headings are automatically styled and can be automatically numbered. To enable numbered headings all you do is add the <code class="language-markup">numbered</code> class to the parent. If you only want the headings within a specific section, add the class to the section, if you want the whole document to have numbered headings, add the class to the body tag.</p>
<pre><code class="language-markup"><section class="numbered">
<h1>Heading 1</h1>
<h2>Heading 2</h2>
<h3>Heading 3</h3>
<h3>Heading 3</h3>
<h4>Heading 4</h4>
<h5>Heading 5</h5>
<h6>Heading 6</h6>
<h1>Heading 1</h1>
</section></code></pre>
<div class="item-span-8 numbered">
<h1 class="no-toc">Heading 1</h1>
<h2 class="no-toc">Heading 2</h2>
<h3 class="no-toc">Heading 3</h3>
<h3 class="no-toc">Heading 3</h3>
<h4 class="no-toc">Heading 4</h4>
<h5 class="no-toc">Heading 5</h5>
<h6 class="no-toc">Heading 6</h6>
<h1 class="no-toc">Heading 1</h1>
</div>
<h4>Paragraph Styles</h4>
<p>For your running text:</p>
<pre><code class="language-markup"><p class="text-lead">This is very useful for a <span class="text-highlighted"> lead text </span>, that follows a heading and begins an article</p>
<p class="text-left">This paragraph has left text alignment.</p>
<p class="text-right">This paragraph has <span class="text-highlighted"> right text</span> alignment</p>
<p class="text-center">This paragraph has centered text</p>
<p class="text-justify">The text in here is justified, so if it spans across multiple lines it won't have jagged edges.</p>
<p class="text-hyphen">This paragraph has hyphenated text, which is enabled by default within paragraphs, but if you want to enable it on other containers, use it.</p>
<p class="text-no-hyphen">This paragraph does not hyphenate.</p>
<p class="text-small">This text is smaller than the others.</p>
<p class="text-muted">This paragraph is muted and not as opaque as the others.</p>
<p>In here, we have a <span class="text-highlighted">part of text that is highlighted</span>.</p></code></pre>
<p class="text-lead">This is very useful for a <b>lead text</b>, that follows a heading and begins an article</p>
<p class="text-left">This paragraph has <b>left text </b> alignment.</p>
<p class="text-right">This paragraph has <b>right text</b> alignment</p>
<p class="text-center">This paragraph has <b>centered text </b> </p>
<p class="text-justify">The text in here is <b>justified </b>, so if it spans across multiple lines it won't have jagged edges.</p>
<p class="text-hyphen">This paragraph has <b>hyphenated text</b>, which is enabled by default within paragraphs, but if you want to enable it on other containers, use it.</p>
<p class="text-no-hyphen">This paragraph <b>does not hyphenate</b>. </p>
<p class="text-small">This text is <b>smaller </b>than the others.</p>
<p class="text-muted">This paragraph is <b>muted </b>and not as opaque as the others.</p>
<p>In here, we have a <span class="text-highlighted">part of text that is highlighted</span>.</p>
<h4>Lists</h4>
<p>Heinz supports lists as well</p>
<pre><code class="language-markup"><ul>
<li>An Unordered List</li>
<li>With just a few</li>
<li>Bulletpoints</li>
</ul>
<ol>
<li>And an ordered List</li>
<li>Where all Items</li>
<li>Are Numbered.</li>
</ol></code></pre>
<ul>
<li>An Unordered List</li>
<li>With just a few</li>
<li>Bulletpoints</li>
</ul>
<ol>
<li>And an ordered List</li>
<li>Where all Items</li>
<li>Are Numbered.</li>
</ol>
<h4>Blockquote</h4>
<p>For using a blockquote, enter the following code. Fill in your text between <code class="language-markup"><blockquote></code> and <code class="language-markup"><span></code>. The source you can add into <code class="language-markup"><span></span></code></p>
<pre><code class="language-markup"><blockquote>
<p>"Have no fear of perfection,
you'll never reach it"</p>
<span>Salvador Dali</span>
</blockquote></code></pre>
<blockquote>
<p>"Have no fear of perfection,
you'll never reach it"</p>
<span>Salvador Dali</span>
</blockquote>
<h3 id="image">Image</h3>
<p>There are four image formats defined.</p>
<p>Copy the code and paste it within a <code class="language-markup"><section></code>. Add the source of your picture into <code class="language-markup"><img src=""></code>.</p>
<h4>Image content-width</h4>
<pre><code class="language-markup"><figure class="content-wide">
<img src="media/image.jpg" alt="image">
<figcaption>
Image Caption
</figcaption>
</figure></code></pre>
<figure class="content-wide">
<img src="media/mountains.jpg" alt="Image width of content">
<figcaption>
Image with content-width, <a href="https://unsplash.com/photos/gdE-5Oui1Y0"> source</a>
</figcaption>
</figure>
<h4>Oversized image</h4>
<pre><code class="language-markup"><figure class="oversized">
<img src="media/image.jpg" alt="image">
<figcaption>
Image Caption
</figcaption>
</figure></code></pre>
<figure class="oversized">
<img src="media/mountains.jpg" alt="Oversized">
<figcaption>
Image with content-width, <a href="https://unsplash.com/photos/gdE-5Oui1Y0"> source</a>
</figcaption>
</figure>
<h4>Oversized image with textoverlay</h4>
<pre><code class="language-markup"><div class="oversized textoverlay">
<img src="media/image.jpg" alt="image">
<div class="overlay-content">This is overlay text</div>
</div></code></pre>
<div class="oversized textoverlay">
<img src="media/clouds.jpg" alt="image oversized">
<div class="overlay-content">This is overlay text</div>
</div>
<h4>Full width image</h4>
<p>Copy the code and paste this into the <code class="language-markup"><main></code>.
<p>Be careful, for adding a full-width image <b>you need to create a new section</b>. Close the preceding section, add the code for the full width image and start a new section for the following code. Add the source of your picture into <code class="language-markup"><img src=""></code>.</p>
<pre><code class="language-markup"><section class="full-width">
<figure>
<img src="media/image.jpg" alt="image full width">
<figcaption>
full width image caption
</figcaption>
</figure>
</section></code></pre>
</section>
<section class="full-width">
<figure>
<img src="media/clouds.jpg" alt="image full width">
<figcaption>
full width image <a href="https://unsplash.com/photos/viNPa2F7fnw"> source</a>
</figcaption>
</figure>
</section>
<section class="box">
<h3 id="slider">Slider</h3>
<p class="text-center"><span class="text-highlighted">This feature requires JavaScript.</span></p>
<p>We offer you fully prepared responsive sliders in two sizes. Content width and oversized. The Slider has images as background-image and also navigators in spans. Those are enabled automatically in js. Just copy the snippet into a <code class="language-markup">section</code> and enter the URL in <code class="language-markup">url(media/)</code> and <code class="language-markup">src="media/"</code> of your images.</p>
<h4>Slider content-width</h4>
<pre><code class="language-markup"><div class="slider-wrap">
<div class="slider">
<div style="background-image: url(media/img1.jpg)"><img src="media/img1.jpg" alt="slide 1"></div>
<div style="background-image: url(media/img2.jpg)"><img src="media/img2.jpg" alt="slide 2"></div>
<div style="background-image: url(media/img3.jpg)"><img src="media/img3.jpg" alt="slide 3"></div>
</div>
<span class="navigator toggle-next">next</span>
<span class="navigator toggle-prev">prev</span>
</div></code></pre>
<div class="slider-wrap">
<div class="slider">
<div style="background-image: url(media/clouds.jpg)"><img src="media/clouds.jpg" alt="slide 1"></div>
<div style="background-image: url(media/mountains.jpg)"><img src="media/mountains.jpg" alt="slide 2"></div>
<div style="background-image: url(media/wheel.jpg)"><img src="media/wheel.jpg" alt="slide 3"></div>
</div>
<span class="navigator toggle-next">next</span>
<span class="navigator toggle-prev">prev</span>
</div>
<h4>Slider oversized</h4>
<p>Adding class <code class="language-markup">large</code> to the wrapper makes the slider bigger.</p>
<pre><code class="language-markup"><pre><code class="language-markup"><div class="slider-wrap large">
<div class="slider">
<div style="background-image: url(media/img1.jpg)"><img src="media/img1.jpg" alt="slide 1"></div>
<div style="background-image: url(media/img2.jpg)"><img src="media/img2.jpg" alt="slide 2"></div>
<div style="background-image: url(media/img3.jpg)"><img src="media/img3.jpg" alt="slide 3"></div>
</div>
<span class="navigator toggle-next">next</span>
<span class="navigator toggle-prev">prev</span>
</div></code></pre></code></pre>
<div class="slider-wrap large">
<div class="slider">
<div style="background-image: url(media/clouds.jpg)"><img src="media/clouds.jpg" alt="slide 1"></div>
<div style="background-image: url(media/mountains.jpg)"><img src="media/mountains.jpg" alt="slide 2"></div>
<div style="background-image: url(media/wheel.jpg)"><img src="media/wheel.jpg" alt="slide 3"></div>
</div>
<span class="navigator toggle-next">next</span>
<span class="navigator toggle-prev">prev</span>
</div>
</section>
<section class="box">
<h3 id="video">Video</h3>
<p>There are three kinds of video players. Two are normal players, one with content width and the other one oversized. The third one is a full-width option.</p>
<p>In our examples we work with YouTube Videos since they are the most common embedded videos. If you want to use an HTML5 video, just replace the iframe with the video tag.</p>
<p>Videos need to be wrapped in 2 containers to ensure they scale responsively.</p>
<h4>player content-width</h4>
<pre><code class="language-markup"><div class="video-wrap">
<div class="video">
<iframe src="https://www.youtube.com/embed/YOUTUBEVIDEOID" frameborder="0" gesture="media" allowfullscreen></iframe>
</div>
</div></code></pre>
<div class="video-wrap">
<div class="video">
<iframe width="854" height="480" src="https://www.youtube.com/embed/6gCd3VUOYWs?ecver=1" frameborder="0" gesture="media" allowfullscreen></iframe>
</div>
</div>
<h4>player oversized</h4>
<p>Adding class <code class="language-markup">large</code> to the wrapper makes the player bigger.</p>
<pre><code class="language-markup"><div class="video-wrap large">
<div class="video">
<iframe src="https://www.youtube.com/embed/YOUTUBEVIDEOID" frameborder="0" gesture="media" allowfullscreen></iframe>
</div>
</div></code></pre>
<div class="video-wrap large">
<div class="video">
<iframe width="854" height="480" src="https://www.youtube.com/embed/6gCd3VUOYWs?ecver=1" frameborder="0" gesture="media" allowfullscreen></iframe>
</div>
</div>
<h4>background-video</h4>
<p>The third option is a display filling <strong>background-video</strong>. Autoplay, loop and muted are inclued via URL attributes from the YouTube API. There's an over-video container that darkens the video and adds a grid where you can put a textoverlay.</p>
<p>Be careful, for adding a background-video <b>you need to create a new section</b>. Close the preceding section, add the code for the full width video and start a new section for the following code.</p>
<pre><code class="language-markup"><section class="full-width">
<div class="video-wrap">
<div class="video">
<iframe src="https://www.youtube.com/embed/YOUTUBEVIDEOID?ecver=1&autoplay=1&mute=1&controls=0&loop=1&playlist=6gCd3VUOYWs&modestbranding=1"></iframe>
</div>
</div>
<div class="over-video grid">
<div class="item-span-8 item-offset-2">
<h1 class="text-white">Text on top of the video</h1>
</div>
</div>
</section></code></pre>
</section>
<section class="full-width">
<div class="video-wrap">
<div class="video">
<iframe src="https://www.youtube.com/embed/6gCd3VUOYWs?ecver=1&autoplay=1&mute=1&controls=0&loop=1&playlist=6gCd3VUOYWs&modestbranding=1"></iframe>
</div>
</div>
<div class="over-video grid">
<div class="item-span-8 item-offset-2">
<h1 class="text-white">Text on top of the video</h1>
</div>
</div>
</section>
<section class="box">
<h3 id="audio">Audio</h3>
<p>For inserting audio files, copy the following html. Enter your audio source according to the file type into <code class="language-markup"><source src=""></code> and the type of your audio file into <code class="language-markup">type=""</code>. Unfortunately you can't customize the look of your audio via CSS, because it's not supported by browsers.</p>
<pre><code class="language-markup"><audio controls>
<source src="audio.mp3" type="audio/mpeg">
Your browser does not support the audio element.
</audio></code></pre>
<audio controls>
<source src="media/SampleAudio_0.4mb.mp3" type="audio/mpeg">
Your browser does not support the audio element.
</audio>
</section>
<section class="has-sidestory">
<div class="sidestory sidestory-left box">
<p>this Sidestory is on the left side and does not open an overlay.</p>
</div>
<div class="content box">
<h3 id="sidestory">Sidestory</h3>
<p class="text-center"><span class="text-highlighted">This feature requires JavaScript.</span></p>
<p>You can add additional sidestories to your website. These are small boxes on the side of your container. We prepared one for the left side and one for the right side. By placing an overlay toggle in the box, an overlay opens where you can add your additional story. The background will be blurred then.</p>
<p><b>Sidestories require a separate section</b>, the content needs to be placed within a content container and the sidestories either before or after the content. The placement of the sidestory box matters in the responsive view when the content will either be before or after the story.</p>
<p>The overlay can be placed anywhere in the code, we recommend at the end of the document though.</p>
<p>To open an overlay, you need to use the class toggle and a data-attribute referencing the ID of the overlay.</p>
</div>
<div class="sidestory sidestory-right box">
<h3 class="no-toc">Side</h3>
<p>This Story is on the right, and it does open an overlay.</p>
<br>
<p class="text-center">
<span class="toggle" data-toggle-overlay="overlay-1">Toggle Overlay</span>
</p>
</div>
</section>
<section class="box">
<pre><code class="language-markup"><section class="has-sidestory">
<div class="sidestory sidestory-left box">
<p>this Sidestory is on the left side and does not open an overlay.</p>
</div>
<div class="content box">
<p>Sidestory Content</p>
</div>
<div class="sidestory sidestory-right box">
<h2>Sidestory</h2>
<p>This Story is on the right, and it does open an overlay.</p>
<br>
<p class="text-center">
<span class="toggle" data-toggle-overlay="overlay-1">Toggle Overlay</span>
</p>
</div>
</section></code></pre>
<p>For creating the content of the overlay you need the following code. Again, we like to place it at the end of our code. The overlay can contain any of the components discussed.</p>
<pre><code class="language-markup"><div class="overlay grid" id="overlay-1">
<section>
<span class="toggle close">x</span>
<h1>Overlay Title</h1>
<p>In this example we just added an image with content-wide. How you can add this picture you learn in chapter "Images"</p>
<p>You can close this overlay by clicking the x, clicking outside of the content or hitting "Esc" on your keyboard.</p>
<figure class="content-wide">
<img src="media/mountains.jpg" alt="Image width of content">
<figcaption>
Image with content-width, <a href="https://unsplash.com/photos/gdE-5Oui1Y0"> source</a>
</figcaption>
</figure>
</section>
</div></code></pre>
</section>
<section class="box">
<h1 id="creators">Creators</h1>
<p class="text-center">
Myriam Frisano<br>
Sebastian Hubacher<br>
Nadia Etter<br>
Pascal Lüthi<br>
Kyle Smith<br>
Kim Schläpfer
</p>
<h1 id="copyright-and-license">Copyright and License</h1>
<p class="text-center">Heinz is released under MIT.</p>
</section>
</main>
<div class="overlay grid" id="overlay-1">
<section>
<span class="toggle close">x</span>
<h1 class="no-toc">Overlay Title</h1>
<p>In this example we just added an image with content-wide. How you can add this picture you learn in chapter "Images"</p>
<p>You can close this overlay by clicking the x, clicking outside of the content or hitting "Esc" on your keyboard.</p>
<figure class="content-wide">
<img src="media/mountains.jpg" alt="Image width of content">
<figcaption>
Image with content-width, <a href="https://unsplash.com/photos/gdE-5Oui1Y0"> source</a>
</figcaption>
</figure>
</section>
</div>
<footer class="grid">
<div class="foot">
<p>
© Heinz · 2017 · <span class="backtotop">Back To Top</span></p>
</div>
</footer>
<script src="js/jquery-3.2.1.js"></script>
<script src="js/heinz.min.js"></script>
<script src="js/prism.js"></script>
</body>
</html>