forked from uikit/uikit
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathdocumentation_javascript.html
More file actions
349 lines (278 loc) · 18.7 KB
/
Copy pathdocumentation_javascript.html
File metadata and controls
349 lines (278 loc) · 18.7 KB
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
<!DOCTYPE html>
<html lang="en-gb" dir="ltr">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>JavaScript - UIkit documentation</title>
<link rel="shortcut icon" href="images/favicon.ico" type="image/x-icon">
<link rel="apple-touch-icon-precomposed" href="images/apple-touch-icon.png">
<link id="data-uikit-theme" rel="stylesheet" href="css/uikit.docs.min.css">
<link rel="stylesheet" href="css/docs.css">
<link rel="stylesheet" href="../vendor/highlight/highlight.css">
<script src="../vendor/jquery.js"></script>
<script src="js/uikit.min.js"></script>
<script src="../vendor/highlight/highlight.js"></script>
<script src="js/docs.js"></script>
</head>
<body class="tm-background">
<nav class="tm-navbar uk-navbar uk-navbar-attached">
<div class="uk-container uk-container-center">
<a class="uk-navbar-brand uk-hidden-small" href="../index.html"><img class="uk-margin uk-margin-remove" src="images/logo_uikit.svg" width="90" height="30" title="UIkit" alt="UIkit"></a>
<ul class="uk-navbar-nav uk-hidden-small">
<li class="uk-active"><a href="documentation_get-started.html">Get Started</a></li>
<li><a href="core.html">Core</a></li>
<li><a href="components.html">Components</a></li>
<li><a href="customizer.html">Customizer</a></li>
<li><a href="../showcase/index.html">Showcase</a></li>
<li><a href="tutorials.html">Tutorials</a></li>
</ul>
<a href="#tm-offcanvas" class="uk-navbar-toggle uk-visible-small" data-uk-offcanvas></a>
<div class="uk-navbar-brand uk-navbar-center uk-visible-small"><img src="images/logo_uikit.svg" width="90" height="30" title="UIkit" alt="UIkit"></div>
</div>
</nav>
<div class="tm-middle">
<div class="uk-container uk-container-center">
<div class="uk-grid" data-uk-grid-margin>
<div class="tm-sidebar uk-width-medium-1-4 uk-hidden-small">
<ul class="tm-nav uk-nav" data-uk-nav>
<li class="uk-nav-header">Beginners</li>
<li><a href="documentation_get-started.html">Get started</a></li>
<li><a href="documentation_how-to-customize.html">How to customize</a></li>
<li><a href="documentation_layouts.html">Layout examples</a></li>
<li class="uk-nav-header">Developers</li>
<li><a href="documentation_project-structure.html">Project structure</a></li>
<li><a href="documentation_less-sass.html">Less & Sass files</a></li>
<li><a href="documentation_create-a-theme.html">Create a theme</a></li>
<li><a href="documentation_create-a-style.html">Create a style</a></li>
<li><a href="documentation_customizer-json.html">Customizer.json</a></li>
<li class="uk-active"><a href="documentation_javascript.html">JavaScript</a></li>
<li><a href="documentation_custom-prefix.html">Custom prefix</a></li>
</ul>
</div>
<div class="tm-main uk-width-medium-3-4">
<article class="uk-article">
<h1 class="uk-article-title">JavaScript</h1>
<p class="uk-article-lead">Use data attributes to apply JavaScript to UIkit components</p>
<p>You can use all UIkit components by just adding <code>data-uk-*</code> attributes to your HTML elements without writing a single line of JavaScript. This is UIkit's best practice of using its components and should always be considered first.</p>
<h3 class="tm-article-subtitle">Markup</h3>
<pre><code><button data-uk-button>My Button</button></code></pre>
<p>But of course you can still use the components just through the jQuery API.</p>
<h3 class="tm-article-subtitle">Markup</h3>
<pre><code>$(".button").uk("button");</code></pre>
<hr class="uk-article-divider">
<h2 id="amd-support"><a href="#amd-support" class="uk-link-reset">AMD support</a></h2>
<p>AMD (Asynchronous Module Definition) is a way of defining JavaScript modules and their dependencies so they can be loaded asynchronously.</p>
<h3 class="tm-article-subtitle">Usage</h3>
<pre><code>/* Simple require of the UIkit core */
require("path/to/uikit.js", function(UI){
// UI is the global UIkit object a.k.a. $.UIkit
});</code></pre>
<h3 class="tm-article-subtitle">Autoload UIkit and its components</h3>
<pre><code>/* setup require.js first */
requirejs.config({
paths: {
"uikit": 'path/to/uikit.js'
},
config: {
"uikit": {
"base": "path/to/uikit_dist_folder"
}
}
});
/* now you can autoload uikit core + components separated by a comma */
require("uikit!notify,sortable", function(UI){
// access loaded components: UI.notify, UI.sortable
});</code></pre>
<hr class="uk-article-divider">
<h2 id="js-override"><a href="#js-override" class="uk-link-reset">Override default component settings.</a></h2>
<p>It is possible to adjust the default component settings as you can see in the following example.</p>
<h3 class="tm-article-subtitle">Usage</h3>
<pre><code>
// override default tooltip settings
UIkit.on('beforeready.uk.dom', function(){
$.extend(UIkit.components.tooltip.prototype.defaults, {
pos: 'top',
delay: 500,
animation: true
});
});
</code></pre>
<hr class="uk-article-divider">
<h2 id="dom-observe"><a href="#dom-observe" class="uk-link-reset">Observe the DOM to auto-init new added components, e.g via AJAX.</a></h2>
<p>If you inject dynamic HTML markup into the DOM via JavaScript, just add the <code>data-uk-observe</code> attribute to one of the parent elements to auto-initialize UIKit JavaScript components.</p>
<h3 class="tm-article-subtitle">Usage</h3>
<pre><code>
<div data-uk-observe>
<!-- inject your dynamic html here -->
</div>
</code></pre>
<h3 class="tm-article-subtitle">Observe an element via JavaScript</h3>
<pre><code>UIkit.domObserve('#element', function(element) { /* apply on dom change within element */ })</code></pre>
<hr class="uk-article-divider">
<h2 id="data-check-display"><a href="#data-check-display" class="uk-link-reset">Check Display event on visibility change.</a></h2>
<p>Sometimes components, like <a href="grid.html">Grid</a> or <a href="tab.html">Tab</a> are hidden in the markup. This may happen when used in combination with the <a href="switcher.html">Switcher</a>, <a href="modal.html">Modal</a> or <a href="dropdown.html">Dropdown</a>. Once they become visible, they need to be recalculated to adjust or fix the height and other dimensions.</p>
<p>To do so, add the <code>data-uk-check-display</code> attribute to the elements which need to be recalculated. They now listen to the <code>display.uk.check</code> event, which will be triggered by the container component, for example the Switcher. This is not needed for elements with <code>data-uk-margin</code>, <code>data-uk-grid-margin</code> and <code>data-uk-grid-match</code> attributes, those will be triggered by default.</p>
<h3 class="tm-article-subtitle">Usage</h3>
<pre><code>
<!-- Element within a modal, switcher or dropdown -->
<div id="myelement" data-uk-check-display>...</div>
<script>
$("#myelement").on('display.uk.check', function(){
// custom code to adjust height etc on show
});
</script>
</code></pre>
</article>
</div>
</div>
</div>
</div>
<div class="tm-footer">
<div class="uk-container uk-container-center uk-text-center">
<ul class="uk-subnav uk-subnav-line uk-flex-center">
<li><a href="http://github.com/uikit/uikit">GitHub</a></li>
<li><a href="http://github.com/uikit/uikit/issues">Issues</a></li>
<li><a href="http://github.com/uikit/uikit/blob/master/CHANGELOG.md">Changelog</a></li>
<li><a href="https://twitter.com/getuikit">Twitter</a></li>
</ul>
<div class="uk-panel">
<p>Made by <a href="http://www.yootheme.com">YOOtheme</a> with love and caffeine.<br>Licensed under <a href="http://opensource.org/licenses/MIT">MIT license</a>.</p>
<a href="../index.html"><img src="images/logo_uikit.svg" width="90" height="30" title="UIkit" alt="UIkit"></a>
</div>
</div>
</div>
<div id="tm-offcanvas" class="uk-offcanvas">
<div class="uk-offcanvas-bar">
<ul class="uk-nav uk-nav-offcanvas uk-nav-parent-icon" data-uk-nav="{multiple:true}">
<li class="uk-parent uk-active"><a href="#">Documentation</a>
<ul class="uk-nav-sub">
<li><a href="documentation_get-started.html">Get started</a></li>
<li><a href="documentation_how-to-customize.html">How to customize</a></li>
<li><a href="documentation_layouts.html">Layout examples</a></li>
<li><a href="core.html">Core</a></li>
<li><a href="components.html">Components</a></li>
<li><a href="documentation_project-structure.html">Project structure</a></li>
<li><a href="documentation_create-a-theme.html">Create a theme</a></li>
<li><a href="documentation_create-a-theme.html">Create a style</a></li>
<li><a href="documentation_customizer-json.html">Customizer.json</a></li>
<li><a href="documentation_javascript.html">JavaScript</a></li>
<li><a href="documentation_less-sass.html">Less & Sass files</a></li>
<li><a href="documentation_custom-prefix.html">Custom prefix</a></li>
</ul>
</li>
<li class="uk-nav-header">Core</li>
<li class="uk-parent"><a href="#"><i class="uk-icon-wrench"></i> Defaults</a>
<ul class="uk-nav-sub">
<li><a href="base.html">Base</a></li>
<li><a href="print.html">Print</a></li>
</ul>
</li>
<li class="uk-parent"><a href="#"><i class="uk-icon-th-large"></i> Layout</a>
<ul class="uk-nav-sub">
<li><a href="grid.html">Grid</a></li>
<li><a href="panel.html">Panel</a></li>
<li><a href="block.html">Block</a></li>
<li><a href="article.html">Article</a></li>
<li><a href="comment.html">Comment</a></li>
<li><a href="utility.html">Utility</a></li>
<li><a href="flex.html">Flex</a></li>
<li><a href="cover.html">Cover</a></li>
</ul>
</li>
<li class="uk-parent"><a href="#"><i class="uk-icon-bars"></i> Navigations</a>
<ul class="uk-nav-sub">
<li><a href="nav.html">Nav</a></li>
<li><a href="navbar.html">Navbar</a></li>
<li><a href="subnav.html">Subnav</a></li>
<li><a href="breadcrumb.html">Breadcrumb</a></li>
<li><a href="pagination.html">Pagination</a></li>
<li><a href="tab.html">Tab</a></li>
<li><a href="thumbnav.html">Thumbnav</a></li>
</ul>
</li>
<li class="uk-parent"><a href="#"><i class="uk-icon-check"></i> Elements</a>
<ul class="uk-nav-sub">
<li><a href="list.html">List</a></li>
<li><a href="description-list.html">Description list</a></li>
<li><a href="table.html">Table</a></li>
<li><a href="form.html">Form</a></li>
</ul>
</li>
<li class="uk-parent"><a href="#"><i class="uk-icon-folder-open"></i> Common</a>
<ul class="uk-nav-sub">
<li><a href="button.html">Button</a></li>
<li><a href="icon.html">Icon</a></li>
<li><a href="close.html">Close</a></li>
<li><a href="badge.html">Badge</a></li>
<li><a href="alert.html">Alert</a></li>
<li><a href="thumbnail.html">Thumbnail</a></li>
<li><a href="overlay.html">Overlay</a></li>
<li><a href="text.html">Text</a></li>
<li><a href="column.html">Column</a></li>
<li><a href="animation.html">Animation</a></li>
<li><a href="contrast.html">Contrast</a></li>
</ul>
</li>
<li class="uk-parent"><a href="#"><i class="uk-icon-magic"></i> JavaScript</a>
<ul class="uk-nav-sub">
<li><a href="dropdown.html">Dropdown</a></li>
<li><a href="modal.html">Modal</a></li>
<li><a href="offcanvas.html">Off-canvas</a></li>
<li><a href="switcher.html">Switcher</a></li>
<li><a href="toggle.html">Toggle</a></li>
<li><a href="scrollspy.html">Scrollspy</a></li>
<li><a href="smooth-scroll.html">Smooth scroll</a></li>
</ul>
</li>
<li class="uk-nav-header">Components</li>
<li class="uk-parent"><a href="#"><i class="uk-icon-th-large"></i> Layout</a>
<ul class="uk-nav-sub">
<li><a href="grid-js.html">Dynamic Grid</a></li>
</ul>
</li>
<li class="uk-parent"><a href="#"><i class="uk-icon-bars"></i> Navigations</a>
<ul class="uk-nav-sub">
<li><a href="dotnav.html">Dotnav</a></li>
<li><a href="slidenav.html">Slidenav</a></li>
<li><a href="pagination-js.html">Dynamic Pagination</a></li>
</ul>
</li>
<li class="uk-parent"><a href="#"><i class="uk-icon-folder-open"></i> Common</a>
<ul class="uk-nav-sub">
<li><a href="form-advanced.html">Form advanced</a></li>
<li><a href="form-file.html">Form file</a></li>
<li><a href="form-password.html">Form password</a></li>
<li><a href="form-select.html">Form select</a></li>
<li><a href="placeholder.html">Placeholder</a></li>
<li><a href="progress.html">Progress</a></li>
</ul>
</li>
<li class="uk-parent"><a href="#"><i class="uk-icon-magic"></i> JavaScript</a>
<ul class="uk-nav-sub">
<li><a href="lightbox.html">Lightbox</a></li>
<li><a href="autocomplete.html">Autocomplete</a></li>
<li><a href="datepicker.html">Datepicker</a></li>
<li><a href="htmleditor.html">HTML editor</a></li>
<li><a href="slider.html">Slider</a></li>
<li><a href="slideset.html">Slideset</a></li>
<li><a href="slideshow.html">Slideshow</a></li>
<li><a href="parallax.html">Parallax</a></li>
<li><a href="accordion.html">Accordion</a></li>
<li><a href="notify.html">Notify</a></li>
<li><a href="search.html">Search</a></li>
<li><a href="nestable.html">Nestable</a></li>
<li><a href="sortable.html">Sortable</a></li>
<li><a href="sticky.html">Sticky</a></li>
<li><a href="timepicker.html">Timepicker</a></li>
<li><a href="tooltip.html">Tooltip</a></li>
<li><a href="upload.html">Upload</a></li>
</ul>
</li>
<li class="uk-nav-divider"></li>
<li><a href="../showcase/index.html">Showcase</a></li>
<li><a href="tutorials.html">Tutorials</a></li>
</ul>
</div>
</div>
</body>
</html>