-
Notifications
You must be signed in to change notification settings - Fork 4
/
Copy pathbackground.html
237 lines (237 loc) · 15.6 KB
/
background.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
<!DOCTYPE html>
<html lang="en" dir="ltr">
<head>
<!-- meta -->
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
<title>Documentation v5.0.3 | Gameforest Bootstrap Gaming Theme</title>
<!-- css: plugins -->
<link rel="stylesheet" href="assets/plugins/highlight/styles/github.css">
<!-- css: theme -->
<link rel="stylesheet" href="../dist/css/theme.css">
<link rel="stylesheet" href="assets/css/docs.min.css">
</head>
<body class="fixed-navbar">
<div class="site">
<header class="site-header">
<nav class="navbar navbar-expand-lg navbar-dark navbar-docs pr-3">
<div class="container-fluid px-0">
<a class="navbar-brand" href="../dist">Gameforest</a>
<button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarSupportedContent" aria-controls="navbarSupportedContent" aria-expanded="false" aria-label="Toggle navigation">
<span class="navbar-toggler-icon"></span>
</button>
<ul class="navbar-nav flex-row d-none d-md-flex">
<li class="nav-item"><a class="nav-link" href="../dist" target="_blank">Preview</a></li>
<li class="nav-item"><a class="nav-link" href="index.html">Documentation</a></li>
<li class="nav-item"><a class="nav-link" href="changelog.html">Changelog</a></li>
<li class="nav-item"><a class="btn btn-outline-light" href="https://themeforest.net/downloads#item-5007730" target="_blank">Rate now <i class="ya ya-star-add"></i></a></li>
<li class="nav-item"><a class="nav-link ml-2" href="github.html"><i class="ya ya-github"></i></a></li>
<li class="nav-item"><a class="nav-link pl-1" href="https://www.facebook.com/yakuthemes" target="_blank"><i class="ya ya-facebook"></i></a></li>
<li class="nav-item"><a class="nav-link pl-1" href="https://www.twitter.com/yakuthemes" target="_blank"><i class="ya ya-twitter"></i></a></li>
</ul>
<!-- end .navbar-nav -->
</div>
</nav>
</header>
<!-- end .site-header -->
<div class="sidebar">
<div class="sidebar-search">
<input type="text" class="form-control" id="search" placeholder="Search..." autocomplete="off">
<div class="list-group sidebar-results" id="results"></div>
</div>
<div class="sidebar-subtitle">Getting Started</div>
<a class="sidebar-link" href="index.html"><span>Introduction</span></a>
<a class="sidebar-link" href="file-structure.html"><span>File Structure</span></a>
<a class="sidebar-link" href="gulp.html"><span>Gulp</span></a>
<a class="sidebar-link" href="sass.html"><span>Sass</span></a>
<a class="sidebar-link" href="twig.html"><span>Twig</span></a>
<a class="sidebar-link" href="javascript.html"><span>Javascript</span></a>
<a class="sidebar-link" href="plugins.html"><span>Plugins</span></a>
<a class="sidebar-link" href="github.html"><span>Github</span></a>
<a class="sidebar-link" href="changelog.html"><span>Changelog</span></a>
<div class="sidebar-subtitle">Bootstrap Components</div>
<a class="sidebar-link" href="alerts.html"><span>Alerts</span></a>
<a class="sidebar-link" href="badges.html"><span>Badges</span></a>
<a class="sidebar-link" href="breadcrumb.html"><span>Breadcrumb</span></a>
<a class="sidebar-link" href="buttons.html"><span>Buttons</span></a>
<a class="sidebar-link" href="cards.html"><span>Cards</span></a>
<a class="sidebar-link" href="columns.html"><span>Columns</span></a>
<a class="sidebar-link" href="dropdowns.html"><span>Dropdowns</span></a>
<a class="sidebar-link" href="forms.html"><span>Forms</span></a>
<a class="sidebar-link" href="input-groups.html"><span>Input Groups</span></a>
<a class="sidebar-link" href="modal.html"><span>Modal</span></a>
<a class="sidebar-link" href="navbar.html"><span>Navbar</span></a>
<a class="sidebar-link" href="pagination.html"><span>Pagination</span></a>
<a class="sidebar-link" href="popovers.html"><span>Popovers</span></a>
<a class="sidebar-link" href="progress.html"><span>Progress</span></a>
<a class="sidebar-link" href="tables.html"><span>Tables</span></a>
<a class="sidebar-link" href="tabs.html"><span>Tabs</span></a>
<a class="sidebar-link" href="tooltips.html"><span>Tooltips</span></a>
<div class="sidebar-subtitle">Gameforest Components</div>
<a class="sidebar-link" href="accordions.html"><span>Accordions</span></a>
<a class="sidebar-link" href="avatars.html"><span>Avatars</span></a>
<a class="sidebar-link active" href="background.html"><span>Background</span></a>
<a class="sidebar-link" href="blog.html"><span>Blog</span></a>
<a class="sidebar-link" href="carousel.html"><span>Carousel</span></a>
<a class="sidebar-link" href="charts.html"><span>Charts</span></a>
<a class="sidebar-link" href="comments.html"><span>Comments</span></a>
<a class="sidebar-link" href="datatables.html"><span>DataTables</span></a>
<a class="sidebar-link" href="datepicker.html"><span>DatePicker</span></a>
<a class="sidebar-link" href="embed.html"><span>Embed</span></a>
<a class="sidebar-link" href="icons.html"><span>Icons</span></a>
<a class="sidebar-link" href="lightbox.html"><span>Lightbox</span></a>
<a class="sidebar-link" href="notification.html"><span>Notification</span></a>
<a class="sidebar-link" href="promo.html"><span>Promo</span></a>
<a class="sidebar-link" href="select.html"><span>Select</span></a>
<a class="sidebar-link" href="social.html"><span>Social</span></a>
<a class="sidebar-link" href="sticky.html"><span>Sticky</span></a>
<a class="sidebar-link" href="text-editor.html"><span>Text Editor</span></a>
<a class="sidebar-link" href="typography.html"><span>Typography</span></a>
<a class="sidebar-link" href="widgets.html"><span>Widgets</span></a>
</div>
<!-- end .sidebar -->
<div class="site-content" role="main">
<section>
<div class="container">
<div class="row">
<div class="col-9">
<h1 class="mb-4">Background</h1>
<p class="lead">Similar for embed plugin but use the gameforest background component for add videos to the custom section or block.</p>
<hr class="docs-separator my-5">
<div class="docs-block">
<h4 id="example" class="mb-3 anchor">
Example
</h4>
<p>Add youtube video to the element by using <code>ya-background</code> attribute. Copy youtube url from browser bar and paste it into the data attribute like in the example below.</p>
<div ya-background="https://www.youtube.com/watch?v=wVMjIEtEokE" ya-option="mute: 1;controls: 0;loop: 1;opacity: 1" style="height: 600px"></div>
<div class="docs-code">
<button class="btn btn-default btn-icon btn-clipboard" data-toggle="tooltip" title="Copy" rel="#example_code"><i class="ya ya-save"></i></button>
<pre class="pre"><code id="example_code" class="twig"><div ya-background="https://www.youtube.com/watch?v=wVMjIEtEokE" ya-option="mute: 1;controls: 0;loop: 1" style="height: 650px">
...
</div></code></pre>
</div>
</div>
<div class="docs-block">
<h4 id="vimeo" class="mb-3 anchor">
Vimeo
</h4>
<p>Add vimeo video to the element by using <code>ya-background</code> attribute. Copy youtube url from browser bar and paste it into the data attribute like in the example below.</p>
<div ya-background="https://vimeo.com/300249379" ya-option="mute: 1;controls: 0;loop: 1;opacity: 1" style="height: 600px"></div>
<div class="docs-code">
<button class="btn btn-default btn-icon btn-clipboard" data-toggle="tooltip" title="Copy" rel="#vimeo_code"><i class="ya ya-save"></i></button>
<pre class="pre"><code id="vimeo_code" class="twig"><div ya-background="https://vimeo.com/300249379" ya-option="mute: 1;controls: 0;loop: 1;opacity: 1" style="height: 650px">
...
</div></code></pre>
</div>
</div>
<div class="docs-block">
<h4 id="options" class="mb-3 anchor">
Options
</h4>
<p>Options can be passed via data attributes. For data attributes, append the option name to <code>ya-option</code>. Default option names and values are available below in the table.</p>
<div class="docs-code">
<button class="btn btn-default btn-icon btn-clipboard" data-toggle="tooltip" title="Copy" rel="#options_code"><i class="ya ya-save"></i></button>
<pre class="pre"><code id="options_code" class="twig">ya-option="mute: 1;controls: 0;loop: 1"</code></pre>
</div>
<table class="table">
<thead>
<tr>
<th scope="col">option</th>
<th scope="col">value</th>
<th scope="col">default</th>
<th scope="col" style="width: 60%">description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>autoplay</code></td>
<td>integer</td>
<td>1</td>
<td>Play the video automatically when user clicked to the thumbnail.</td>
</tr>
<tr>
<td><code>controls</code></td>
<td>integer</td>
<td>1</td>
<td>Display the player pause, volume control or timeline.</td>
</tr>
<tr>
<td><code>recommends</code></td>
<td>integer</td>
<td>0</td>
<td>Display recommended playlist end of the video.</td>
</tr>
<tr>
<td><code>mute</code></td>
<td>integer</td>
<td>0</td>
<td>Mute the embedded video by default.</td>
</tr>
<tr>
<td><code>loop</code></td>
<td>number</td>
<td>0</td>
<td>Restart the video if it has ended.</td>
</tr>
<tr>
<td><code>start</code></td>
<td>number</td>
<td>null</td>
<td>Start to play the video from this time.</td>
</tr>
<tr>
<td><code>opacity</code></td>
<td>number</td>
<td>0.5</td>
<td>Set the opacity for the player.</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="col-3">
<nav class="nav nav-docs flex-column" ya-sticky="top: 100">
<a class="nav-link" href="#example">Example</a>
<a class="nav-link" href="#vimeo">Vimeo</a>
<a class="nav-link" href="#options">Options</a>
<div class="divider"></div>
<a class="nav-link" href="https://github.com/yakuthemes/gameforest/issues" target="_blank"><i class="ya ya-help"></i> Report issue</a>
<a class="nav-link" href="https://themeforest.net/item/gameforest-responsive-gaming-html-theme/5007730/comments" target="_blank"><i class="ya ya-link"></i> Get help</a>
</nav>
</div>
</div>
</div>
</section>
</div>
<!-- end .site-content -->
<a class="version" href="changelog.html" data-toggle="tooltip" data-placement="left" title="Gameforest version"><i class="ya ya-bulb mr-1"></i> v5.0.3</a>
<footer class="docs-footer">
<p class="mr-auto">Copyright © 2019 by <a href="https://yakuthemes.com" target="_blank">@yakuthemes</a>. Thank you for using yakuthemes products.</p>
<a href="index.html">Getting Started</a>
<a href="changelog.html">Changelog</a>
<a href="../dist">Preview</a>
<a href="#">Ratings</a>
<a href="#">Support</a>
<a href="#">Download</a>
</footer>
</div>
<!-- end .site -->
<!-- js: vendor -->
<script src="../dist/js/vendor.js"></script>
<script src="../dist/js/theme.min.js"></script>
<script src="assets/plugins/holder/holder.min.js"></script>
<script src="assets/plugins/clipboard/clipboard.min.js"></script>
<script src="assets/plugins/highlight/highlight.pack.js"></script>
<script src="assets/js/docs.min.js"></script>
<script>
var gameforest = {
disqus: 'gameforestyakuzieu',
facebook: {
lang: 'en_US',
version: 'v3.2',
id: '',
}
}
</script>
</body>
</html>