Commit | Line | Data |
---|---|---|
0c5338dd TD |
1 | |
2 | <!doctype html> | |
3 | <html lang="en" class="no-js"> | |
4 | <head> | |
5 | ||
6 | <meta charset="utf-8"> | |
7 | <meta name="viewport" content="width=device-width,initial-scale=1"> | |
8 | ||
9 | ||
10 | ||
11 | ||
fb962f09 WG |
12 | <link rel="icon" href="../../assets/default.favicon.ico"> |
13 | <meta name="generator" content="mkdocs-1.1.2, mkdocs-material-7.1.0"> | |
0c5338dd TD |
14 | |
15 | ||
16 | ||
17 | <title>Helper Functions - WoltLab Suite Documentation</title> | |
18 | ||
19 | ||
20 | ||
fb962f09 | 21 | <link rel="stylesheet" href="../../assets/stylesheets/main.33e2939f.min.css"> |
0c5338dd TD |
22 | |
23 | ||
fb962f09 | 24 | <link rel="stylesheet" href="../../assets/stylesheets/palette.ef6f36e2.min.css"> |
0c5338dd TD |
25 | |
26 | ||
27 | ||
28 | <meta name="theme-color" content="#009485"> | |
29 | ||
30 | ||
31 | ||
32 | ||
33 | ||
fd8430cb WG |
34 | |
35 | ||
0c5338dd TD |
36 | |
37 | ||
38 | <link rel="stylesheet" href="../../stylesheets/extra.css"> | |
39 | ||
40 | ||
41 | ||
42 | ||
43 | ||
44 | </head> | |
45 | ||
46 | ||
47 | ||
48 | ||
49 | ||
50 | ||
51 | ||
52 | <body dir="ltr" data-md-color-scheme="" data-md-color-primary="teal" data-md-color-accent=""> | |
0c5338dd TD |
53 | |
54 | ||
fb962f09 WG |
55 | <script>function __prefix(e){return new URL("../..",location).pathname+"."+e}function __get(e,t=localStorage){return JSON.parse(t.getItem(__prefix(e)))}</script> |
56 | ||
0c5338dd TD |
57 | <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off"> |
58 | <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off"> | |
59 | <label class="md-overlay" for="__drawer"></label> | |
60 | <div data-md-component="skip"> | |
61 | ||
62 | ||
63 | <a href="#javascript-helper-functions" class="md-skip"> | |
64 | Skip to content | |
65 | </a> | |
66 | ||
67 | </div> | |
68 | <div data-md-component="announce"> | |
69 | ||
70 | <aside class="md-announce"> | |
71 | <div class="md-announce__inner md-grid md-typeset"> | |
72 | ||
73 | <a href="https://www.woltlab.com">Back to <strong>woltlab.com</strong></a> | |
74 | ||
75 | </div> | |
76 | </aside> | |
77 | ||
78 | </div> | |
79 | ||
fb962f09 | 80 | <header class="md-header" data-md-component="header"> |
0c5338dd | 81 | <nav class="md-header__inner md-grid" aria-label="Header"> |
fb962f09 | 82 | <a href="../.." title="WoltLab Suite Documentation" class="md-header__button md-logo" aria-label="WoltLab Suite Documentation" data-md-component="logo"> |
0c5338dd TD |
83 | |
84 | <img src="../../assets/logo.png" alt="logo"> | |
85 | ||
86 | </a> | |
87 | <label class="md-header__button md-icon" for="__drawer"> | |
88 | <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"/></svg> | |
89 | </label> | |
90 | <div class="md-header__title" data-md-component="header-title"> | |
91 | <div class="md-header__ellipsis"> | |
92 | <div class="md-header__topic"> | |
93 | <span class="md-ellipsis"> | |
94 | WoltLab Suite Documentation | |
95 | </span> | |
96 | </div> | |
97 | <div class="md-header__topic" data-md-component="header-topic"> | |
98 | <span class="md-ellipsis"> | |
99 | ||
100 | Helper Functions | |
101 | ||
102 | </span> | |
103 | </div> | |
104 | </div> | |
0c5338dd TD |
105 | </div> |
106 | ||
fb962f09 WG |
107 | |
108 | ||
a3639e76 WG |
109 | <label class="md-header__button md-icon" for="__search"> |
110 | <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg> | |
111 | </label> | |
112 | ||
113 | <div class="md-search" data-md-component="search" role="dialog"> | |
114 | <label class="md-search__overlay" for="__search"></label> | |
115 | <div class="md-search__inner" role="search"> | |
116 | <form class="md-search__form" name="search"> | |
117 | <input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" data-md-state="active" required> | |
118 | <label class="md-search__icon md-icon" for="__search"> | |
119 | <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg> | |
120 | <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg> | |
121 | </label> | |
122 | <button type="reset" class="md-search__icon md-icon" aria-label="Clear" tabindex="-1"> | |
fb962f09 | 123 | <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41z"/></svg> |
a3639e76 WG |
124 | </button> |
125 | </form> | |
126 | <div class="md-search__output"> | |
127 | <div class="md-search__scrollwrap" data-md-scrollfix> | |
128 | <div class="md-search-result" data-md-component="search-result"> | |
129 | <div class="md-search-result__meta"> | |
130 | Initializing search | |
131 | </div> | |
132 | <ol class="md-search-result__list"></ol> | |
133 | </div> | |
134 | </div> | |
135 | </div> | |
136 | </div> | |
137 | </div> | |
138 | ||
0c5338dd | 139 | |
7124f4cb WG |
140 | <div class="md-header__source"> |
141 | ||
142 | <a href="https://github.com/WoltLab/docs.woltlab.com/" title="Go to repository" class="md-source" data-md-component="source"> | |
143 | <div class="md-source__icon md-icon"> | |
144 | ||
fb962f09 | 145 | <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg> |
7124f4cb WG |
146 | </div> |
147 | <div class="md-source__repository"> | |
148 | GitHub | |
149 | </div> | |
150 | </a> | |
151 | </div> | |
152 | ||
0c5338dd TD |
153 | </nav> |
154 | </header> | |
155 | ||
156 | <div class="md-container" data-md-component="container"> | |
157 | ||
158 | ||
159 | ||
160 | ||
161 | <main class="md-main" data-md-component="main"> | |
162 | <div class="md-main__inner md-grid"> | |
163 | ||
164 | ||
165 | ||
166 | <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" > | |
167 | <div class="md-sidebar__scrollwrap"> | |
168 | <div class="md-sidebar__inner"> | |
169 | ||
170 | ||
171 | ||
0c5338dd TD |
172 | <nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0"> |
173 | <label class="md-nav__title" for="__drawer"> | |
fb962f09 | 174 | <a href="../.." title="WoltLab Suite Documentation" class="md-nav__button md-logo" aria-label="WoltLab Suite Documentation" data-md-component="logo"> |
0c5338dd TD |
175 | |
176 | <img src="../../assets/logo.png" alt="logo"> | |
177 | ||
178 | </a> | |
179 | WoltLab Suite Documentation | |
180 | </label> | |
181 | ||
7124f4cb WG |
182 | <div class="md-nav__source"> |
183 | ||
184 | <a href="https://github.com/WoltLab/docs.woltlab.com/" title="Go to repository" class="md-source" data-md-component="source"> | |
185 | <div class="md-source__icon md-icon"> | |
186 | ||
fb962f09 | 187 | <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg> |
7124f4cb WG |
188 | </div> |
189 | <div class="md-source__repository"> | |
190 | GitHub | |
191 | </div> | |
192 | </a> | |
193 | </div> | |
194 | ||
0c5338dd TD |
195 | <ul class="md-nav__list" data-md-scrollfix> |
196 | ||
197 | ||
198 | ||
199 | ||
200 | ||
201 | ||
202 | ||
203 | ||
204 | <li class="md-nav__item"> | |
205 | <a href="../../getting-started/" class="md-nav__link"> | |
206 | Getting Started | |
207 | </a> | |
208 | </li> | |
209 | ||
210 | ||
211 | ||
212 | ||
213 | ||
214 | ||
215 | ||
216 | ||
217 | ||
218 | ||
219 | ||
220 | <li class="md-nav__item md-nav__item--nested"> | |
221 | ||
222 | ||
223 | <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2" type="checkbox" id="__nav_2" > | |
224 | ||
225 | <label class="md-nav__link" for="__nav_2"> | |
226 | PHP API | |
227 | <span class="md-nav__icon md-icon"></span> | |
228 | </label> | |
229 | <nav class="md-nav" aria-label="PHP API" data-md-level="1"> | |
230 | <label class="md-nav__title" for="__nav_2"> | |
231 | <span class="md-nav__icon md-icon"></span> | |
232 | PHP API | |
233 | </label> | |
234 | <ul class="md-nav__list" data-md-scrollfix> | |
235 | ||
236 | ||
237 | ||
238 | ||
239 | ||
240 | <li class="md-nav__item"> | |
241 | <a href="../../php/pages/" class="md-nav__link"> | |
242 | Pages | |
243 | </a> | |
244 | </li> | |
245 | ||
246 | ||
247 | ||
248 | ||
249 | ||
250 | ||
251 | ||
252 | <li class="md-nav__item"> | |
253 | <a href="../../php/database-objects/" class="md-nav__link"> | |
254 | Database Objects | |
255 | </a> | |
256 | </li> | |
257 | ||
258 | ||
259 | ||
260 | ||
261 | ||
262 | ||
263 | ||
264 | <li class="md-nav__item"> | |
265 | <a href="../../php/database-access/" class="md-nav__link"> | |
266 | Database Access | |
267 | </a> | |
268 | </li> | |
269 | ||
270 | ||
271 | ||
272 | ||
273 | ||
274 | ||
275 | ||
276 | <li class="md-nav__item"> | |
277 | <a href="../../php/exceptions/" class="md-nav__link"> | |
278 | Exceptions | |
279 | </a> | |
280 | </li> | |
281 | ||
282 | ||
283 | ||
284 | ||
285 | ||
286 | ||
287 | ||
288 | ||
289 | <li class="md-nav__item md-nav__item--nested"> | |
290 | ||
291 | ||
292 | <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5" type="checkbox" id="__nav_2_5" > | |
293 | ||
294 | <label class="md-nav__link" for="__nav_2_5"> | |
295 | API | |
296 | <span class="md-nav__icon md-icon"></span> | |
297 | </label> | |
298 | <nav class="md-nav" aria-label="API" data-md-level="2"> | |
299 | <label class="md-nav__title" for="__nav_2_5"> | |
300 | <span class="md-nav__icon md-icon"></span> | |
301 | API | |
302 | </label> | |
303 | <ul class="md-nav__list" data-md-scrollfix> | |
304 | ||
305 | ||
306 | ||
307 | ||
308 | ||
6923e968 WG |
309 | |
310 | <li class="md-nav__item md-nav__item--nested"> | |
311 | ||
312 | ||
313 | <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5_1" type="checkbox" id="__nav_2_5_1" > | |
314 | ||
315 | <label class="md-nav__link" for="__nav_2_5_1"> | |
316 | Caches | |
317 | <span class="md-nav__icon md-icon"></span> | |
318 | </label> | |
319 | <nav class="md-nav" aria-label="Caches" data-md-level="3"> | |
320 | <label class="md-nav__title" for="__nav_2_5_1"> | |
321 | <span class="md-nav__icon md-icon"></span> | |
322 | Caches | |
323 | </label> | |
324 | <ul class="md-nav__list" data-md-scrollfix> | |
325 | ||
326 | ||
327 | ||
328 | ||
329 | ||
0c5338dd TD |
330 | <li class="md-nav__item"> |
331 | <a href="../../php/api/caches/" class="md-nav__link"> | |
6923e968 WG |
332 | Overview |
333 | </a> | |
334 | </li> | |
335 | ||
336 | ||
337 | ||
338 | ||
339 | ||
340 | ||
341 | ||
342 | <li class="md-nav__item"> | |
343 | <a href="../../php/api/caches_persistent-caches/" class="md-nav__link"> | |
344 | Persistent Caches | |
345 | </a> | |
346 | </li> | |
347 | ||
348 | ||
349 | ||
350 | ||
351 | ||
352 | ||
353 | ||
354 | <li class="md-nav__item"> | |
355 | <a href="../../php/api/caches_runtime-caches/" class="md-nav__link"> | |
356 | Runtime Caches | |
0c5338dd TD |
357 | </a> |
358 | </li> | |
359 | ||
360 | ||
361 | ||
6923e968 WG |
362 | </ul> |
363 | </nav> | |
364 | </li> | |
365 | ||
366 | ||
367 | ||
0c5338dd TD |
368 | |
369 | ||
370 | ||
371 | ||
372 | <li class="md-nav__item"> | |
373 | <a href="../../php/api/comments/" class="md-nav__link"> | |
374 | Comments | |
375 | </a> | |
376 | </li> | |
377 | ||
378 | ||
379 | ||
380 | ||
381 | ||
382 | ||
383 | ||
384 | <li class="md-nav__item"> | |
385 | <a href="../../php/api/cronjobs/" class="md-nav__link"> | |
386 | Cronjobs | |
387 | </a> | |
388 | </li> | |
389 | ||
390 | ||
391 | ||
392 | ||
393 | ||
394 | ||
395 | ||
396 | <li class="md-nav__item"> | |
397 | <a href="../../php/api/events/" class="md-nav__link"> | |
398 | Events | |
399 | </a> | |
400 | </li> | |
401 | ||
402 | ||
403 | ||
404 | ||
405 | ||
406 | ||
407 | ||
408 | ||
409 | <li class="md-nav__item md-nav__item--nested"> | |
410 | ||
411 | ||
412 | <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5_5" type="checkbox" id="__nav_2_5_5" > | |
413 | ||
414 | <label class="md-nav__link" for="__nav_2_5_5"> | |
415 | Form Builder | |
416 | <span class="md-nav__icon md-icon"></span> | |
417 | </label> | |
418 | <nav class="md-nav" aria-label="Form Builder" data-md-level="3"> | |
419 | <label class="md-nav__title" for="__nav_2_5_5"> | |
420 | <span class="md-nav__icon md-icon"></span> | |
421 | Form Builder | |
422 | </label> | |
423 | <ul class="md-nav__list" data-md-scrollfix> | |
424 | ||
425 | ||
426 | ||
427 | ||
428 | ||
429 | <li class="md-nav__item"> | |
430 | <a href="../../php/api/form_builder/overview/" class="md-nav__link"> | |
431 | Overview | |
432 | </a> | |
433 | </li> | |
434 | ||
435 | ||
436 | ||
437 | ||
438 | ||
439 | ||
440 | ||
441 | <li class="md-nav__item"> | |
442 | <a href="../../php/api/form_builder/structure/" class="md-nav__link"> | |
443 | Structure | |
444 | </a> | |
445 | </li> | |
446 | ||
447 | ||
448 | ||
449 | ||
450 | ||
451 | ||
452 | ||
453 | <li class="md-nav__item"> | |
454 | <a href="../../php/api/form_builder/form_fields/" class="md-nav__link"> | |
455 | Fields | |
456 | </a> | |
457 | </li> | |
458 | ||
459 | ||
460 | ||
461 | ||
462 | ||
463 | ||
464 | ||
465 | <li class="md-nav__item"> | |
466 | <a href="../../php/api/form_builder/validation_data/" class="md-nav__link"> | |
467 | Validation and Data | |
468 | </a> | |
469 | </li> | |
470 | ||
471 | ||
472 | ||
473 | ||
474 | ||
475 | ||
476 | ||
477 | <li class="md-nav__item"> | |
478 | <a href="../../php/api/form_builder/dependencies/" class="md-nav__link"> | |
479 | Dependencies | |
480 | </a> | |
481 | </li> | |
482 | ||
483 | ||
484 | ||
485 | </ul> | |
486 | </nav> | |
487 | </li> | |
488 | ||
489 | ||
490 | ||
491 | ||
492 | ||
493 | ||
494 | ||
495 | <li class="md-nav__item"> | |
496 | <a href="../../php/api/package_installation_plugins/" class="md-nav__link"> | |
497 | Package Installation Plugins | |
498 | </a> | |
499 | </li> | |
500 | ||
501 | ||
502 | ||
503 | ||
504 | ||
505 | ||
506 | ||
507 | <li class="md-nav__item"> | |
508 | <a href="../../php/api/user_activity_points/" class="md-nav__link"> | |
509 | User Activity Points | |
510 | </a> | |
511 | </li> | |
512 | ||
513 | ||
514 | ||
515 | ||
516 | ||
517 | ||
518 | ||
519 | <li class="md-nav__item"> | |
520 | <a href="../../php/api/user_notifications/" class="md-nav__link"> | |
521 | User Notifications | |
522 | </a> | |
523 | </li> | |
524 | ||
525 | ||
526 | ||
527 | ||
528 | ||
529 | ||
530 | ||
531 | <li class="md-nav__item"> | |
532 | <a href="../../php/api/sitemaps/" class="md-nav__link"> | |
533 | Sitemaps | |
534 | </a> | |
535 | </li> | |
536 | ||
537 | ||
538 | ||
539 | </ul> | |
540 | </nav> | |
541 | </li> | |
542 | ||
543 | ||
544 | ||
545 | ||
546 | ||
547 | ||
548 | ||
549 | <li class="md-nav__item"> | |
550 | <a href="../../php/code-style/" class="md-nav__link"> | |
551 | Code Style | |
552 | </a> | |
553 | </li> | |
554 | ||
555 | ||
556 | ||
557 | ||
558 | ||
559 | ||
560 | ||
561 | <li class="md-nav__item"> | |
562 | <a href="../../php/apps/" class="md-nav__link"> | |
563 | Apps | |
564 | </a> | |
565 | </li> | |
566 | ||
567 | ||
568 | ||
569 | ||
570 | ||
571 | ||
572 | ||
573 | <li class="md-nav__item"> | |
574 | <a href="../../php/gdpr/" class="md-nav__link"> | |
575 | GDPR | |
576 | </a> | |
577 | </li> | |
578 | ||
579 | ||
580 | ||
581 | </ul> | |
582 | </nav> | |
583 | </li> | |
584 | ||
585 | ||
586 | ||
587 | ||
588 | ||
589 | ||
590 | ||
591 | ||
592 | ||
593 | ||
594 | ||
595 | <li class="md-nav__item md-nav__item--nested"> | |
596 | ||
597 | ||
598 | <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" type="checkbox" id="__nav_3" > | |
599 | ||
600 | <label class="md-nav__link" for="__nav_3"> | |
601 | Languages, Templates & CSS | |
602 | <span class="md-nav__icon md-icon"></span> | |
603 | </label> | |
604 | <nav class="md-nav" aria-label="Languages, Templates & CSS" data-md-level="1"> | |
605 | <label class="md-nav__title" for="__nav_3"> | |
606 | <span class="md-nav__icon md-icon"></span> | |
607 | Languages, Templates & CSS | |
608 | </label> | |
609 | <ul class="md-nav__list" data-md-scrollfix> | |
610 | ||
611 | ||
612 | ||
613 | ||
614 | ||
615 | <li class="md-nav__item"> | |
616 | <a href="../../view/languages/" class="md-nav__link"> | |
617 | Languages | |
618 | </a> | |
619 | </li> | |
620 | ||
621 | ||
622 | ||
623 | ||
624 | ||
625 | ||
626 | ||
627 | <li class="md-nav__item"> | |
628 | <a href="../../view/templates/" class="md-nav__link"> | |
629 | Templates | |
630 | </a> | |
631 | </li> | |
632 | ||
633 | ||
634 | ||
635 | ||
636 | ||
637 | ||
638 | ||
6923e968 WG |
639 | <li class="md-nav__item"> |
640 | <a href="../../view/template-plugins/" class="md-nav__link"> | |
641 | Template Plugins | |
642 | </a> | |
643 | </li> | |
644 | ||
645 | ||
646 | ||
647 | ||
648 | ||
649 | ||
650 | ||
0c5338dd TD |
651 | <li class="md-nav__item"> |
652 | <a href="../../view/css/" class="md-nav__link"> | |
653 | CSS | |
654 | </a> | |
655 | </li> | |
656 | ||
657 | ||
658 | ||
659 | </ul> | |
660 | </nav> | |
661 | </li> | |
662 | ||
663 | ||
664 | ||
665 | ||
666 | ||
667 | ||
668 | ||
669 | ||
670 | ||
671 | ||
672 | ||
673 | ||
674 | ||
675 | <li class="md-nav__item md-nav__item--active md-nav__item--nested"> | |
676 | ||
677 | ||
678 | <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" checked> | |
679 | ||
680 | <label class="md-nav__link" for="__nav_4"> | |
77efcd46 | 681 | TypeScript and JavaScript API |
0c5338dd TD |
682 | <span class="md-nav__icon md-icon"></span> |
683 | </label> | |
77efcd46 | 684 | <nav class="md-nav" aria-label="TypeScript and JavaScript API" data-md-level="1"> |
0c5338dd TD |
685 | <label class="md-nav__title" for="__nav_4"> |
686 | <span class="md-nav__icon md-icon"></span> | |
77efcd46 | 687 | TypeScript and JavaScript API |
0c5338dd TD |
688 | </label> |
689 | <ul class="md-nav__list" data-md-scrollfix> | |
690 | ||
691 | ||
692 | ||
693 | ||
694 | ||
695 | <li class="md-nav__item"> | |
696 | <a href="../general-usage/" class="md-nav__link"> | |
697 | General Usage | |
698 | </a> | |
699 | </li> | |
700 | ||
701 | ||
702 | ||
703 | ||
704 | ||
705 | ||
706 | ||
77efcd46 WG |
707 | <li class="md-nav__item"> |
708 | <a href="../typescript/" class="md-nav__link"> | |
709 | TypeScript | |
710 | </a> | |
711 | </li> | |
712 | ||
713 | ||
714 | ||
715 | ||
716 | ||
717 | ||
718 | ||
0c5338dd TD |
719 | |
720 | <li class="md-nav__item md-nav__item--nested"> | |
721 | ||
722 | ||
77efcd46 | 723 | <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4_3" type="checkbox" id="__nav_4_3" > |
0c5338dd | 724 | |
77efcd46 | 725 | <label class="md-nav__link" for="__nav_4_3"> |
0c5338dd TD |
726 | New API |
727 | <span class="md-nav__icon md-icon"></span> | |
728 | </label> | |
729 | <nav class="md-nav" aria-label="New API" data-md-level="2"> | |
77efcd46 | 730 | <label class="md-nav__title" for="__nav_4_3"> |
0c5338dd TD |
731 | <span class="md-nav__icon md-icon"></span> |
732 | New API | |
733 | </label> | |
734 | <ul class="md-nav__list" data-md-scrollfix> | |
735 | ||
736 | ||
737 | ||
738 | ||
739 | ||
740 | <li class="md-nav__item"> | |
741 | <a href="../new-api_writing-a-module/" class="md-nav__link"> | |
742 | Writing a module | |
743 | </a> | |
744 | </li> | |
745 | ||
746 | ||
747 | ||
748 | ||
749 | ||
750 | ||
751 | ||
752 | <li class="md-nav__item"> | |
753 | <a href="../new-api_data-structures/" class="md-nav__link"> | |
754 | Data Structures | |
755 | </a> | |
756 | </li> | |
757 | ||
758 | ||
759 | ||
760 | ||
761 | ||
762 | ||
763 | ||
764 | <li class="md-nav__item"> | |
765 | <a href="../new-api_core/" class="md-nav__link"> | |
766 | Core Functions | |
767 | </a> | |
768 | </li> | |
769 | ||
770 | ||
771 | ||
772 | ||
773 | ||
774 | ||
775 | ||
776 | <li class="md-nav__item"> | |
777 | <a href="../new-api_dom/" class="md-nav__link"> | |
778 | DOM | |
779 | </a> | |
780 | </li> | |
781 | ||
782 | ||
783 | ||
784 | ||
785 | ||
786 | ||
787 | ||
788 | <li class="md-nav__item"> | |
789 | <a href="../new-api_events/" class="md-nav__link"> | |
790 | Event Handling | |
791 | </a> | |
792 | </li> | |
793 | ||
794 | ||
795 | ||
796 | ||
797 | ||
798 | ||
799 | ||
800 | <li class="md-nav__item"> | |
801 | <a href="../new-api_ajax/" class="md-nav__link"> | |
802 | Ajax | |
803 | </a> | |
804 | </li> | |
805 | ||
806 | ||
807 | ||
808 | ||
809 | ||
810 | ||
811 | ||
812 | <li class="md-nav__item"> | |
813 | <a href="../new-api_dialogs/" class="md-nav__link"> | |
814 | Dialogs | |
815 | </a> | |
816 | </li> | |
817 | ||
818 | ||
819 | ||
820 | ||
821 | ||
822 | ||
823 | ||
824 | <li class="md-nav__item"> | |
825 | <a href="../new-api_browser/" class="md-nav__link"> | |
826 | Browser and Screen Sizes | |
827 | </a> | |
828 | </li> | |
829 | ||
830 | ||
831 | ||
832 | ||
833 | ||
834 | ||
835 | ||
836 | <li class="md-nav__item"> | |
837 | <a href="../new-api_ui/" class="md-nav__link"> | |
838 | User Interface | |
839 | </a> | |
840 | </li> | |
841 | ||
842 | ||
843 | ||
844 | </ul> | |
845 | </nav> | |
846 | </li> | |
847 | ||
848 | ||
849 | ||
850 | ||
851 | ||
852 | ||
853 | ||
854 | <li class="md-nav__item"> | |
855 | <a href="../legacy-api/" class="md-nav__link"> | |
856 | Legacy API | |
857 | </a> | |
858 | </li> | |
859 | ||
860 | ||
861 | ||
862 | ||
863 | ||
864 | ||
865 | ||
866 | ||
867 | ||
868 | <li class="md-nav__item md-nav__item--active"> | |
869 | ||
870 | <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc"> | |
871 | ||
872 | ||
873 | ||
874 | ||
875 | <label class="md-nav__link md-nav__link--active" for="__toc"> | |
876 | Helper Functions | |
877 | <span class="md-nav__icon md-icon"></span> | |
878 | </label> | |
879 | ||
880 | <a href="./" class="md-nav__link md-nav__link--active"> | |
881 | Helper Functions | |
882 | </a> | |
883 | ||
884 | ||
885 | <nav class="md-nav md-nav--secondary" aria-label="Table of contents"> | |
886 | ||
887 | ||
888 | ||
889 | ||
890 | ||
891 | <label class="md-nav__title" for="__toc"> | |
892 | <span class="md-nav__icon md-icon"></span> | |
893 | Table of contents | |
894 | </label> | |
895 | <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix> | |
896 | ||
897 | <li class="md-nav__item"> | |
898 | <a href="#introduction" class="md-nav__link"> | |
899 | Introduction | |
900 | </a> | |
901 | ||
902 | </li> | |
903 | ||
904 | <li class="md-nav__item"> | |
905 | <a href="#elements" class="md-nav__link"> | |
906 | Elements | |
907 | </a> | |
908 | ||
909 | <nav class="md-nav" aria-label="Elements"> | |
910 | <ul class="md-nav__list"> | |
911 | ||
912 | <li class="md-nav__item"> | |
913 | <a href="#elcreatetagname-string-element" class="md-nav__link"> | |
914 | elCreate(tagName: string): Element | |
915 | </a> | |
916 | ||
917 | </li> | |
918 | ||
919 | <li class="md-nav__item"> | |
920 | <a href="#elremoveelement-element" class="md-nav__link"> | |
921 | elRemove(element: Element) | |
922 | </a> | |
923 | ||
924 | </li> | |
925 | ||
926 | <li class="md-nav__item"> | |
927 | <a href="#elshowelement-element" class="md-nav__link"> | |
928 | elShow(element: Element) | |
929 | </a> | |
930 | ||
931 | </li> | |
932 | ||
933 | <li class="md-nav__item"> | |
934 | <a href="#elhideelement-element" class="md-nav__link"> | |
935 | elHide(element: Element) | |
936 | </a> | |
937 | ||
938 | </li> | |
939 | ||
940 | <li class="md-nav__item"> | |
941 | <a href="#eltoggleelement-element" class="md-nav__link"> | |
942 | elToggle(element: Element) | |
943 | </a> | |
944 | ||
945 | </li> | |
946 | ||
947 | </ul> | |
948 | </nav> | |
949 | ||
950 | </li> | |
951 | ||
952 | <li class="md-nav__item"> | |
953 | <a href="#attributes" class="md-nav__link"> | |
954 | Attributes | |
955 | </a> | |
956 | ||
957 | <nav class="md-nav" aria-label="Attributes"> | |
958 | <ul class="md-nav__list"> | |
959 | ||
960 | <li class="md-nav__item"> | |
961 | <a href="#elattrelement-element-attribute-string-value-string-string" class="md-nav__link"> | |
962 | elAttr(element: Element, attribute: string, value?: string): string | |
963 | </a> | |
964 | ||
965 | </li> | |
966 | ||
967 | <li class="md-nav__item"> | |
968 | <a href="#elattrboolelement-element-attribute-string-boolean" class="md-nav__link"> | |
969 | elAttrBool(element: Element, attribute: string): boolean | |
970 | </a> | |
971 | ||
972 | </li> | |
973 | ||
974 | <li class="md-nav__item"> | |
975 | <a href="#eldataelement-element-attribute-string-value-string-string" class="md-nav__link"> | |
976 | elData(element: Element, attribute: string, value?: string): string | |
977 | </a> | |
978 | ||
979 | </li> | |
980 | ||
981 | <li class="md-nav__item"> | |
982 | <a href="#eldataboolelement-element-attribute-string-boolean" class="md-nav__link"> | |
983 | elDataBool(element: Element, attribute: string): boolean | |
984 | </a> | |
985 | ||
986 | </li> | |
987 | ||
988 | </ul> | |
989 | </nav> | |
990 | ||
991 | </li> | |
992 | ||
993 | <li class="md-nav__item"> | |
994 | <a href="#selecting-elements" class="md-nav__link"> | |
995 | Selecting Elements | |
996 | </a> | |
997 | ||
998 | <nav class="md-nav" aria-label="Selecting Elements"> | |
999 | <ul class="md-nav__list"> | |
1000 | ||
1001 | <li class="md-nav__item"> | |
1002 | <a href="#elbyidid-string-element-null" class="md-nav__link"> | |
1003 | elById(id: string): Element | null | |
1004 | </a> | |
1005 | ||
1006 | </li> | |
1007 | ||
1008 | <li class="md-nav__item"> | |
1009 | <a href="#elbyselselector-string-context-element-element-null" class="md-nav__link"> | |
1010 | elBySel(selector: string, context?: Element): Element | null | |
1011 | </a> | |
1012 | ||
1013 | </li> | |
1014 | ||
1015 | <li class="md-nav__item"> | |
1016 | <a href="#elbyselallselector-string-context-element-callback-element-element-void-nodelist" class="md-nav__link"> | |
1017 | elBySelAll(selector: string, context?: Element, callback: (element: Element) => void): NodeList | |
1018 | </a> | |
1019 | ||
1020 | <nav class="md-nav" aria-label="elBySelAll(selector: string, context?: Element, callback: (element: Element) => void): NodeList"> | |
1021 | <ul class="md-nav__list"> | |
1022 | ||
1023 | <li class="md-nav__item"> | |
1024 | <a href="#callback-to-iterate-over-elements" class="md-nav__link"> | |
1025 | Callback to Iterate Over Elements | |
1026 | </a> | |
1027 | ||
1028 | </li> | |
1029 | ||
1030 | </ul> | |
1031 | </nav> | |
1032 | ||
1033 | </li> | |
1034 | ||
1035 | <li class="md-nav__item"> | |
1036 | <a href="#elclosestelement-element-selector-string-element-null" class="md-nav__link"> | |
1037 | elClosest(element: Element, selector: string): Element | null | |
1038 | </a> | |
1039 | ||
1040 | <nav class="md-nav" aria-label="elClosest(element: Element, selector: string): Element | null"> | |
1041 | <ul class="md-nav__list"> | |
1042 | ||
1043 | <li class="md-nav__item"> | |
1044 | <a href="#text-nodes" class="md-nav__link"> | |
1045 | Text Nodes | |
1046 | </a> | |
1047 | ||
1048 | </li> | |
1049 | ||
1050 | </ul> | |
1051 | </nav> | |
1052 | ||
1053 | </li> | |
1054 | ||
1055 | <li class="md-nav__item"> | |
1056 | <a href="#elbyclassclassname-string-context-element-nodelist" class="md-nav__link"> | |
1057 | elByClass(className: string, context?: Element): NodeList | |
1058 | </a> | |
1059 | ||
1060 | </li> | |
1061 | ||
1062 | <li class="md-nav__item"> | |
1063 | <a href="#elbytagtagname-string-context-element-nodelist" class="md-nav__link"> | |
1064 | elByTag(tagName: string, context?: Element): NodeList | |
1065 | </a> | |
1066 | ||
1067 | </li> | |
1068 | ||
1069 | </ul> | |
1070 | </nav> | |
1071 | ||
1072 | </li> | |
1073 | ||
1074 | <li class="md-nav__item"> | |
1075 | <a href="#utility-functions" class="md-nav__link"> | |
1076 | Utility Functions | |
1077 | </a> | |
1078 | ||
1079 | <nav class="md-nav" aria-label="Utility Functions"> | |
1080 | <ul class="md-nav__list"> | |
1081 | ||
1082 | <li class="md-nav__item"> | |
1083 | <a href="#elinnererrorelement-element-errormessage-string-ishtml-boolean-element-null" class="md-nav__link"> | |
1084 | `elInnerError(element: Element, errorMessage?: string, isHtml?: boolean): Element | null`` | |
1085 | </a> | |
1086 | ||
1087 | </li> | |
1088 | ||
1089 | </ul> | |
1090 | </nav> | |
1091 | ||
1092 | </li> | |
1093 | ||
1094 | <li class="md-nav__item"> | |
1095 | <a href="#string-extensions" class="md-nav__link"> | |
1096 | String Extensions | |
1097 | </a> | |
1098 | ||
1099 | <nav class="md-nav" aria-label="String Extensions"> | |
1100 | <ul class="md-nav__list"> | |
1101 | ||
1102 | <li class="md-nav__item"> | |
1103 | <a href="#hashcode-string" class="md-nav__link"> | |
1104 | hashCode(): string | |
1105 | </a> | |
1106 | ||
1107 | </li> | |
1108 | ||
1109 | </ul> | |
1110 | </nav> | |
1111 | ||
1112 | </li> | |
1113 | ||
1114 | </ul> | |
1115 | ||
1116 | </nav> | |
1117 | ||
1118 | </li> | |
1119 | ||
1120 | ||
1121 | ||
1122 | ||
1123 | ||
1124 | ||
1125 | ||
1126 | <li class="md-nav__item"> | |
1127 | <a href="../code-snippets/" class="md-nav__link"> | |
1128 | Code Snippets | |
1129 | </a> | |
1130 | </li> | |
1131 | ||
1132 | ||
1133 | ||
1134 | </ul> | |
1135 | </nav> | |
1136 | </li> | |
1137 | ||
1138 | ||
1139 | ||
1140 | ||
1141 | ||
1142 | ||
1143 | ||
1144 | ||
1145 | ||
1146 | ||
1147 | ||
1148 | <li class="md-nav__item md-nav__item--nested"> | |
1149 | ||
1150 | ||
1151 | <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" > | |
1152 | ||
1153 | <label class="md-nav__link" for="__nav_5"> | |
1154 | Package Components | |
1155 | <span class="md-nav__icon md-icon"></span> | |
1156 | </label> | |
1157 | <nav class="md-nav" aria-label="Package Components" data-md-level="1"> | |
1158 | <label class="md-nav__title" for="__nav_5"> | |
1159 | <span class="md-nav__icon md-icon"></span> | |
1160 | Package Components | |
1161 | </label> | |
1162 | <ul class="md-nav__list" data-md-scrollfix> | |
1163 | ||
1164 | ||
1165 | ||
1166 | ||
1167 | ||
1168 | <li class="md-nav__item"> | |
1169 | <a href="../../package/package-xml/" class="md-nav__link"> | |
1170 | package.xml | |
1171 | </a> | |
1172 | </li> | |
1173 | ||
1174 | ||
1175 | ||
1176 | ||
1177 | ||
1178 | ||
1179 | ||
1180 | ||
1181 | <li class="md-nav__item md-nav__item--nested"> | |
1182 | ||
1183 | ||
1184 | <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_2" type="checkbox" id="__nav_5_2" > | |
1185 | ||
1186 | <label class="md-nav__link" for="__nav_5_2"> | |
1187 | PIPs | |
1188 | <span class="md-nav__icon md-icon"></span> | |
1189 | </label> | |
1190 | <nav class="md-nav" aria-label="PIPs" data-md-level="2"> | |
1191 | <label class="md-nav__title" for="__nav_5_2"> | |
1192 | <span class="md-nav__icon md-icon"></span> | |
1193 | PIPs | |
1194 | </label> | |
1195 | <ul class="md-nav__list" data-md-scrollfix> | |
1196 | ||
1197 | ||
1198 | ||
1199 | ||
1200 | ||
1201 | <li class="md-nav__item"> | |
1202 | <a href="../../package/pip/" class="md-nav__link"> | |
1203 | Overview | |
1204 | </a> | |
1205 | </li> | |
1206 | ||
1207 | ||
1208 | ||
1209 | ||
1210 | ||
1211 | ||
1212 | ||
1213 | <li class="md-nav__item"> | |
1214 | <a href="../../package/pip/acl-option/" class="md-nav__link"> | |
1215 | aclOption | |
1216 | </a> | |
1217 | </li> | |
1218 | ||
1219 | ||
1220 | ||
1221 | ||
1222 | ||
1223 | ||
1224 | ||
1225 | <li class="md-nav__item"> | |
1226 | <a href="../../package/pip/acp-menu/" class="md-nav__link"> | |
1227 | acpMenu | |
1228 | </a> | |
1229 | </li> | |
1230 | ||
1231 | ||
1232 | ||
1233 | ||
1234 | ||
1235 | ||
1236 | ||
1237 | <li class="md-nav__item"> | |
1238 | <a href="../../package/pip/acp-search-provider/" class="md-nav__link"> | |
1239 | acpSearchProvider | |
1240 | </a> | |
1241 | </li> | |
1242 | ||
1243 | ||
1244 | ||
1245 | ||
1246 | ||
1247 | ||
1248 | ||
1249 | <li class="md-nav__item"> | |
1250 | <a href="../../package/pip/acp-template/" class="md-nav__link"> | |
1251 | acpTemplate | |
1252 | </a> | |
1253 | </li> | |
1254 | ||
1255 | ||
1256 | ||
1257 | ||
1258 | ||
1259 | ||
1260 | ||
1261 | <li class="md-nav__item"> | |
1262 | <a href="../../package/pip/bbcode/" class="md-nav__link"> | |
1263 | bbcode | |
1264 | </a> | |
1265 | </li> | |
1266 | ||
1267 | ||
1268 | ||
1269 | ||
1270 | ||
1271 | ||
1272 | ||
1273 | <li class="md-nav__item"> | |
1274 | <a href="../../package/pip/box/" class="md-nav__link"> | |
1275 | box | |
1276 | </a> | |
1277 | </li> | |
1278 | ||
1279 | ||
1280 | ||
1281 | ||
1282 | ||
1283 | ||
1284 | ||
1285 | <li class="md-nav__item"> | |
1286 | <a href="../../package/pip/clipboard-action/" class="md-nav__link"> | |
1287 | clipboardAction | |
1288 | </a> | |
1289 | </li> | |
1290 | ||
1291 | ||
1292 | ||
1293 | ||
1294 | ||
1295 | ||
1296 | ||
1297 | <li class="md-nav__item"> | |
1298 | <a href="../../package/pip/core-object/" class="md-nav__link"> | |
1299 | coreObject | |
1300 | </a> | |
1301 | </li> | |
1302 | ||
1303 | ||
1304 | ||
1305 | ||
1306 | ||
1307 | ||
1308 | ||
1309 | <li class="md-nav__item"> | |
1310 | <a href="../../package/pip/cronjob/" class="md-nav__link"> | |
1311 | cronjob | |
1312 | </a> | |
1313 | </li> | |
1314 | ||
1315 | ||
1316 | ||
1317 | ||
1318 | ||
1319 | ||
1320 | ||
6923e968 WG |
1321 | <li class="md-nav__item"> |
1322 | <a href="../../package/pip/database/" class="md-nav__link"> | |
1323 | database | |
1324 | </a> | |
1325 | </li> | |
1326 | ||
1327 | ||
1328 | ||
1329 | ||
1330 | ||
1331 | ||
1332 | ||
0c5338dd TD |
1333 | <li class="md-nav__item"> |
1334 | <a href="../../package/pip/event-listener/" class="md-nav__link"> | |
1335 | eventListener | |
1336 | </a> | |
1337 | </li> | |
1338 | ||
1339 | ||
1340 | ||
1341 | ||
1342 | ||
1343 | ||
1344 | ||
1345 | <li class="md-nav__item"> | |
1346 | <a href="../../package/pip/file/" class="md-nav__link"> | |
1347 | file | |
1348 | </a> | |
1349 | </li> | |
1350 | ||
1351 | ||
1352 | ||
1353 | ||
1354 | ||
1355 | ||
1356 | ||
1357 | <li class="md-nav__item"> | |
1358 | <a href="../../package/pip/language/" class="md-nav__link"> | |
1359 | language | |
1360 | </a> | |
1361 | </li> | |
1362 | ||
1363 | ||
1364 | ||
1365 | ||
1366 | ||
1367 | ||
1368 | ||
1369 | <li class="md-nav__item"> | |
1370 | <a href="../../package/pip/media-provider/" class="md-nav__link"> | |
1371 | mediaProvider | |
1372 | </a> | |
1373 | </li> | |
1374 | ||
1375 | ||
1376 | ||
1377 | ||
1378 | ||
1379 | ||
1380 | ||
1381 | <li class="md-nav__item"> | |
1382 | <a href="../../package/pip/menu/" class="md-nav__link"> | |
1383 | menu | |
1384 | </a> | |
1385 | </li> | |
1386 | ||
1387 | ||
1388 | ||
1389 | ||
1390 | ||
1391 | ||
1392 | ||
1393 | <li class="md-nav__item"> | |
1394 | <a href="../../package/pip/menu-item/" class="md-nav__link"> | |
1395 | menuItem | |
1396 | </a> | |
1397 | </li> | |
1398 | ||
1399 | ||
1400 | ||
1401 | ||
1402 | ||
1403 | ||
1404 | ||
1405 | <li class="md-nav__item"> | |
1406 | <a href="../../package/pip/object-type/" class="md-nav__link"> | |
1407 | objectType | |
1408 | </a> | |
1409 | </li> | |
1410 | ||
1411 | ||
1412 | ||
1413 | ||
1414 | ||
1415 | ||
1416 | ||
1417 | <li class="md-nav__item"> | |
1418 | <a href="../../package/pip/object-type-definition/" class="md-nav__link"> | |
1419 | objectTypeDefinition | |
1420 | </a> | |
1421 | </li> | |
1422 | ||
1423 | ||
1424 | ||
1425 | ||
1426 | ||
1427 | ||
1428 | ||
1429 | <li class="md-nav__item"> | |
1430 | <a href="../../package/pip/option/" class="md-nav__link"> | |
1431 | option | |
1432 | </a> | |
1433 | </li> | |
1434 | ||
1435 | ||
1436 | ||
1437 | ||
1438 | ||
1439 | ||
1440 | ||
1441 | <li class="md-nav__item"> | |
1442 | <a href="../../package/pip/page/" class="md-nav__link"> | |
1443 | page | |
1444 | </a> | |
1445 | </li> | |
1446 | ||
1447 | ||
1448 | ||
1449 | ||
1450 | ||
1451 | ||
1452 | ||
1453 | <li class="md-nav__item"> | |
1454 | <a href="../../package/pip/pip/" class="md-nav__link"> | |
1455 | pip | |
1456 | </a> | |
1457 | </li> | |
1458 | ||
1459 | ||
1460 | ||
1461 | ||
1462 | ||
1463 | ||
1464 | ||
1465 | <li class="md-nav__item"> | |
1466 | <a href="../../package/pip/script/" class="md-nav__link"> | |
1467 | script | |
1468 | </a> | |
1469 | </li> | |
1470 | ||
1471 | ||
1472 | ||
1473 | ||
1474 | ||
1475 | ||
1476 | ||
1477 | <li class="md-nav__item"> | |
1478 | <a href="../../package/pip/smiley/" class="md-nav__link"> | |
1479 | smiley | |
1480 | </a> | |
1481 | </li> | |
1482 | ||
1483 | ||
1484 | ||
1485 | ||
1486 | ||
1487 | ||
1488 | ||
1489 | <li class="md-nav__item"> | |
1490 | <a href="../../package/pip/sql/" class="md-nav__link"> | |
1491 | sql | |
1492 | </a> | |
1493 | </li> | |
1494 | ||
1495 | ||
1496 | ||
1497 | ||
1498 | ||
1499 | ||
1500 | ||
1501 | <li class="md-nav__item"> | |
1502 | <a href="../../package/pip/style/" class="md-nav__link"> | |
1503 | style | |
1504 | </a> | |
1505 | </li> | |
1506 | ||
1507 | ||
1508 | ||
1509 | ||
1510 | ||
1511 | ||
1512 | ||
1513 | <li class="md-nav__item"> | |
1514 | <a href="../../package/pip/template/" class="md-nav__link"> | |
1515 | template | |
1516 | </a> | |
1517 | </li> | |
1518 | ||
1519 | ||
1520 | ||
1521 | ||
1522 | ||
1523 | ||
1524 | ||
1525 | <li class="md-nav__item"> | |
1526 | <a href="../../package/pip/template-listener/" class="md-nav__link"> | |
1527 | templateListener | |
1528 | </a> | |
1529 | </li> | |
1530 | ||
1531 | ||
1532 | ||
1533 | ||
1534 | ||
1535 | ||
1536 | ||
1537 | <li class="md-nav__item"> | |
1538 | <a href="../../package/pip/user-group-option/" class="md-nav__link"> | |
1539 | userGroupOption | |
1540 | </a> | |
1541 | </li> | |
1542 | ||
1543 | ||
1544 | ||
1545 | ||
1546 | ||
1547 | ||
1548 | ||
1549 | <li class="md-nav__item"> | |
1550 | <a href="../../package/pip/user-menu/" class="md-nav__link"> | |
1551 | userMenu | |
1552 | </a> | |
1553 | </li> | |
1554 | ||
1555 | ||
1556 | ||
1557 | ||
1558 | ||
1559 | ||
1560 | ||
1561 | <li class="md-nav__item"> | |
1562 | <a href="../../package/pip/user-notification-event/" class="md-nav__link"> | |
1563 | userNotificationEvent | |
1564 | </a> | |
1565 | </li> | |
1566 | ||
1567 | ||
1568 | ||
1569 | ||
1570 | ||
1571 | ||
1572 | ||
1573 | <li class="md-nav__item"> | |
1574 | <a href="../../package/pip/user-option/" class="md-nav__link"> | |
1575 | userOption | |
1576 | </a> | |
1577 | </li> | |
1578 | ||
1579 | ||
1580 | ||
1581 | ||
1582 | ||
1583 | ||
1584 | ||
1585 | <li class="md-nav__item"> | |
1586 | <a href="../../package/pip/user-profile-menu/" class="md-nav__link"> | |
1587 | userProfileMenu | |
1588 | </a> | |
1589 | </li> | |
1590 | ||
1591 | ||
1592 | ||
1593 | </ul> | |
1594 | </nav> | |
1595 | </li> | |
1596 | ||
1597 | ||
1598 | ||
1599 | ||
1600 | ||
1601 | ||
1602 | ||
1603 | <li class="md-nav__item"> | |
1604 | <a href="../../package/database-php-api/" class="md-nav__link"> | |
1605 | Database PHP API | |
1606 | </a> | |
1607 | </li> | |
1608 | ||
1609 | ||
1610 | ||
1611 | </ul> | |
1612 | </nav> | |
1613 | </li> | |
1614 | ||
1615 | ||
1616 | ||
1617 | ||
1618 | ||
1619 | ||
1620 | ||
1621 | ||
1622 | ||
1623 | ||
1624 | ||
1625 | <li class="md-nav__item md-nav__item--nested"> | |
1626 | ||
1627 | ||
1628 | <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" > | |
1629 | ||
1630 | <label class="md-nav__link" for="__nav_6"> | |
1631 | Migration | |
1632 | <span class="md-nav__icon md-icon"></span> | |
1633 | </label> | |
1634 | <nav class="md-nav" aria-label="Migration" data-md-level="1"> | |
1635 | <label class="md-nav__title" for="__nav_6"> | |
1636 | <span class="md-nav__icon md-icon"></span> | |
1637 | Migration | |
1638 | </label> | |
1639 | <ul class="md-nav__list" data-md-scrollfix> | |
1640 | ||
1641 | ||
1642 | ||
1643 | ||
1644 | ||
1645 | ||
1646 | <li class="md-nav__item md-nav__item--nested"> | |
1647 | ||
1648 | ||
1649 | <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_1" type="checkbox" id="__nav_6_1" > | |
1650 | ||
1651 | <label class="md-nav__link" for="__nav_6_1"> | |
1652 | Migrating from WSC 5.3 | |
1653 | <span class="md-nav__icon md-icon"></span> | |
1654 | </label> | |
1655 | <nav class="md-nav" aria-label="Migrating from WSC 5.3" data-md-level="2"> | |
1656 | <label class="md-nav__title" for="__nav_6_1"> | |
1657 | <span class="md-nav__icon md-icon"></span> | |
1658 | Migrating from WSC 5.3 | |
1659 | </label> | |
1660 | <ul class="md-nav__list" data-md-scrollfix> | |
1661 | ||
1662 | ||
1663 | ||
1664 | ||
1665 | ||
1666 | <li class="md-nav__item"> | |
1667 | <a href="../../migration/wsc53/php/" class="md-nav__link"> | |
1668 | PHP API | |
1669 | </a> | |
1670 | </li> | |
1671 | ||
1672 | ||
1673 | ||
1674 | ||
1675 | ||
1676 | ||
1677 | ||
1678 | <li class="md-nav__item"> | |
1679 | <a href="../../migration/wsc53/session/" class="md-nav__link"> | |
1680 | Session Handling and Authentication | |
1681 | </a> | |
1682 | </li> | |
1683 | ||
1684 | ||
1685 | ||
1686 | ||
1687 | ||
1688 | ||
1689 | ||
1690 | <li class="md-nav__item"> | |
1691 | <a href="../../migration/wsc53/javascript/" class="md-nav__link"> | |
77efcd46 | 1692 | TypeScript and JavaScript |
0c5338dd TD |
1693 | </a> |
1694 | </li> | |
1695 | ||
1696 | ||
1697 | ||
1698 | ||
1699 | ||
1700 | ||
1701 | ||
1702 | <li class="md-nav__item"> | |
1703 | <a href="../../migration/wsc53/templates/" class="md-nav__link"> | |
1704 | Templates | |
1705 | </a> | |
1706 | </li> | |
1707 | ||
1708 | ||
1709 | ||
1710 | ||
1711 | ||
1712 | ||
1713 | ||
1714 | <li class="md-nav__item"> | |
1715 | <a href="../../migration/wsc53/libraries/" class="md-nav__link"> | |
1716 | Third Party Libraries | |
1717 | </a> | |
1718 | </li> | |
1719 | ||
1720 | ||
1721 | ||
1722 | </ul> | |
1723 | </nav> | |
1724 | </li> | |
1725 | ||
1726 | ||
1727 | ||
1728 | ||
1729 | ||
1730 | ||
1731 | ||
1732 | ||
1733 | <li class="md-nav__item md-nav__item--nested"> | |
1734 | ||
1735 | ||
1736 | <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_2" type="checkbox" id="__nav_6_2" > | |
1737 | ||
1738 | <label class="md-nav__link" for="__nav_6_2"> | |
1739 | Migrating from WSC 5.2 | |
1740 | <span class="md-nav__icon md-icon"></span> | |
1741 | </label> | |
1742 | <nav class="md-nav" aria-label="Migrating from WSC 5.2" data-md-level="2"> | |
1743 | <label class="md-nav__title" for="__nav_6_2"> | |
1744 | <span class="md-nav__icon md-icon"></span> | |
1745 | Migrating from WSC 5.2 | |
1746 | </label> | |
1747 | <ul class="md-nav__list" data-md-scrollfix> | |
1748 | ||
1749 | ||
1750 | ||
1751 | ||
1752 | ||
1753 | <li class="md-nav__item"> | |
1754 | <a href="../../migration/wsc52/php/" class="md-nav__link"> | |
1755 | PHP API | |
1756 | </a> | |
1757 | </li> | |
1758 | ||
1759 | ||
1760 | ||
1761 | ||
1762 | ||
1763 | ||
1764 | ||
1765 | <li class="md-nav__item"> | |
1766 | <a href="../../migration/wsc52/templates/" class="md-nav__link"> | |
1767 | Templates and Languages | |
1768 | </a> | |
1769 | </li> | |
1770 | ||
1771 | ||
1772 | ||
1773 | ||
1774 | ||
1775 | ||
1776 | ||
1777 | <li class="md-nav__item"> | |
1778 | <a href="../../migration/wsc52/libraries/" class="md-nav__link"> | |
1779 | Third Party Libraries | |
1780 | </a> | |
1781 | </li> | |
1782 | ||
1783 | ||
1784 | ||
1785 | </ul> | |
1786 | </nav> | |
1787 | </li> | |
1788 | ||
1789 | ||
1790 | ||
1791 | ||
1792 | ||
1793 | ||
1794 | ||
1795 | ||
1796 | <li class="md-nav__item md-nav__item--nested"> | |
1797 | ||
1798 | ||
1799 | <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_3" type="checkbox" id="__nav_6_3" > | |
1800 | ||
1801 | <label class="md-nav__link" for="__nav_6_3"> | |
1802 | Migrating from WSC 3.1 | |
1803 | <span class="md-nav__icon md-icon"></span> | |
1804 | </label> | |
1805 | <nav class="md-nav" aria-label="Migrating from WSC 3.1" data-md-level="2"> | |
1806 | <label class="md-nav__title" for="__nav_6_3"> | |
1807 | <span class="md-nav__icon md-icon"></span> | |
1808 | Migrating from WSC 3.1 | |
1809 | </label> | |
1810 | <ul class="md-nav__list" data-md-scrollfix> | |
1811 | ||
1812 | ||
1813 | ||
1814 | ||
1815 | ||
1816 | <li class="md-nav__item"> | |
1817 | <a href="../../migration/wsc31/php/" class="md-nav__link"> | |
1818 | PHP API | |
1819 | </a> | |
1820 | </li> | |
1821 | ||
1822 | ||
1823 | ||
1824 | </ul> | |
1825 | </nav> | |
1826 | </li> | |
1827 | ||
1828 | ||
1829 | ||
1830 | ||
1831 | ||
1832 | ||
1833 | ||
1834 | ||
1835 | <li class="md-nav__item md-nav__item--nested"> | |
1836 | ||
1837 | ||
1838 | <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_4" type="checkbox" id="__nav_6_4" > | |
1839 | ||
1840 | <label class="md-nav__link" for="__nav_6_4"> | |
1841 | Migrating from WSC 3.0 | |
1842 | <span class="md-nav__icon md-icon"></span> | |
1843 | </label> | |
1844 | <nav class="md-nav" aria-label="Migrating from WSC 3.0" data-md-level="2"> | |
1845 | <label class="md-nav__title" for="__nav_6_4"> | |
1846 | <span class="md-nav__icon md-icon"></span> | |
1847 | Migrating from WSC 3.0 | |
1848 | </label> | |
1849 | <ul class="md-nav__list" data-md-scrollfix> | |
1850 | ||
1851 | ||
1852 | ||
1853 | ||
1854 | ||
1855 | <li class="md-nav__item"> | |
1856 | <a href="../../migration/wsc30/php/" class="md-nav__link"> | |
1857 | PHP API | |
1858 | </a> | |
1859 | </li> | |
1860 | ||
1861 | ||
1862 | ||
1863 | ||
1864 | ||
1865 | ||
1866 | ||
1867 | <li class="md-nav__item"> | |
1868 | <a href="../../migration/wsc30/javascript/" class="md-nav__link"> | |
1869 | JavaScript API | |
1870 | </a> | |
1871 | </li> | |
1872 | ||
1873 | ||
1874 | ||
1875 | ||
1876 | ||
1877 | ||
1878 | ||
1879 | <li class="md-nav__item"> | |
1880 | <a href="../../migration/wsc30/templates/" class="md-nav__link"> | |
1881 | Templates | |
1882 | </a> | |
1883 | </li> | |
1884 | ||
1885 | ||
1886 | ||
1887 | ||
1888 | ||
1889 | ||
1890 | ||
1891 | <li class="md-nav__item"> | |
1892 | <a href="../../migration/wsc30/css/" class="md-nav__link"> | |
1893 | CSS | |
1894 | </a> | |
1895 | </li> | |
1896 | ||
1897 | ||
1898 | ||
1899 | ||
1900 | ||
1901 | ||
1902 | ||
1903 | <li class="md-nav__item"> | |
1904 | <a href="../../migration/wsc30/package/" class="md-nav__link"> | |
1905 | Package Components | |
1906 | </a> | |
1907 | </li> | |
1908 | ||
1909 | ||
1910 | ||
1911 | </ul> | |
1912 | </nav> | |
1913 | </li> | |
1914 | ||
1915 | ||
1916 | ||
1917 | ||
1918 | ||
1919 | ||
1920 | ||
1921 | ||
1922 | <li class="md-nav__item md-nav__item--nested"> | |
1923 | ||
1924 | ||
1925 | <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_5" type="checkbox" id="__nav_6_5" > | |
1926 | ||
1927 | <label class="md-nav__link" for="__nav_6_5"> | |
1928 | Migrating from WCF 2.1 | |
1929 | <span class="md-nav__icon md-icon"></span> | |
1930 | </label> | |
1931 | <nav class="md-nav" aria-label="Migrating from WCF 2.1" data-md-level="2"> | |
1932 | <label class="md-nav__title" for="__nav_6_5"> | |
1933 | <span class="md-nav__icon md-icon"></span> | |
1934 | Migrating from WCF 2.1 | |
1935 | </label> | |
1936 | <ul class="md-nav__list" data-md-scrollfix> | |
1937 | ||
1938 | ||
1939 | ||
1940 | ||
1941 | ||
1942 | <li class="md-nav__item"> | |
1943 | <a href="../../migration/wcf21/php/" class="md-nav__link"> | |
1944 | PHP API | |
1945 | </a> | |
1946 | </li> | |
1947 | ||
1948 | ||
1949 | ||
1950 | ||
1951 | ||
1952 | ||
1953 | ||
1954 | <li class="md-nav__item"> | |
1955 | <a href="../../migration/wcf21/templates/" class="md-nav__link"> | |
1956 | Templates | |
1957 | </a> | |
1958 | </li> | |
1959 | ||
1960 | ||
1961 | ||
1962 | ||
1963 | ||
1964 | ||
1965 | ||
1966 | <li class="md-nav__item"> | |
1967 | <a href="../../migration/wcf21/css/" class="md-nav__link"> | |
1968 | CSS | |
1969 | </a> | |
1970 | </li> | |
1971 | ||
1972 | ||
1973 | ||
1974 | ||
1975 | ||
1976 | ||
1977 | ||
1978 | <li class="md-nav__item"> | |
1979 | <a href="../../migration/wcf21/package/" class="md-nav__link"> | |
1980 | Package Components | |
1981 | </a> | |
1982 | </li> | |
1983 | ||
1984 | ||
1985 | ||
1986 | </ul> | |
1987 | </nav> | |
1988 | </li> | |
1989 | ||
1990 | ||
1991 | ||
1992 | </ul> | |
1993 | </nav> | |
1994 | </li> | |
1995 | ||
1996 | ||
1997 | ||
1998 | ||
1999 | ||
2000 | ||
2001 | ||
2002 | ||
2003 | ||
2004 | ||
2005 | ||
2006 | <li class="md-nav__item md-nav__item--nested"> | |
2007 | ||
2008 | ||
2009 | <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" > | |
2010 | ||
2011 | <label class="md-nav__link" for="__nav_7"> | |
2012 | Tutorials | |
2013 | <span class="md-nav__icon md-icon"></span> | |
2014 | </label> | |
2015 | <nav class="md-nav" aria-label="Tutorials" data-md-level="1"> | |
2016 | <label class="md-nav__title" for="__nav_7"> | |
2017 | <span class="md-nav__icon md-icon"></span> | |
2018 | Tutorials | |
2019 | </label> | |
2020 | <ul class="md-nav__list" data-md-scrollfix> | |
2021 | ||
2022 | ||
2023 | ||
2024 | ||
2025 | ||
2026 | ||
2027 | <li class="md-nav__item md-nav__item--nested"> | |
2028 | ||
2029 | ||
2030 | <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7_1" type="checkbox" id="__nav_7_1" > | |
2031 | ||
2032 | <label class="md-nav__link" for="__nav_7_1"> | |
2033 | Tutorial Series | |
2034 | <span class="md-nav__icon md-icon"></span> | |
2035 | </label> | |
2036 | <nav class="md-nav" aria-label="Tutorial Series" data-md-level="2"> | |
2037 | <label class="md-nav__title" for="__nav_7_1"> | |
2038 | <span class="md-nav__icon md-icon"></span> | |
2039 | Tutorial Series | |
2040 | </label> | |
2041 | <ul class="md-nav__list" data-md-scrollfix> | |
2042 | ||
2043 | ||
2044 | ||
2045 | ||
2046 | ||
2047 | <li class="md-nav__item"> | |
2048 | <a href="../../tutorial/series/overview/" class="md-nav__link"> | |
2049 | Overview | |
2050 | </a> | |
2051 | </li> | |
2052 | ||
2053 | ||
2054 | ||
2055 | ||
2056 | ||
2057 | ||
2058 | ||
2059 | <li class="md-nav__item"> | |
2060 | <a href="../../tutorial/series/part_1/" class="md-nav__link"> | |
2061 | Part 1 | |
2062 | </a> | |
2063 | </li> | |
2064 | ||
2065 | ||
2066 | ||
2067 | ||
2068 | ||
2069 | ||
2070 | ||
2071 | <li class="md-nav__item"> | |
2072 | <a href="../../tutorial/series/part_2/" class="md-nav__link"> | |
2073 | Part 2 | |
2074 | </a> | |
2075 | </li> | |
2076 | ||
2077 | ||
2078 | ||
2079 | ||
2080 | ||
2081 | ||
2082 | ||
2083 | <li class="md-nav__item"> | |
2084 | <a href="../../tutorial/series/part_3/" class="md-nav__link"> | |
2085 | Part 3 | |
2086 | </a> | |
2087 | </li> | |
2088 | ||
2089 | ||
2090 | ||
2091 | </ul> | |
2092 | </nav> | |
2093 | </li> | |
2094 | ||
2095 | ||
2096 | ||
2097 | </ul> | |
2098 | </nav> | |
2099 | </li> | |
2100 | ||
2101 | ||
2102 | ||
2103 | </ul> | |
2104 | </nav> | |
2105 | </div> | |
2106 | </div> | |
2107 | </div> | |
2108 | ||
2109 | ||
2110 | ||
2111 | <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" > | |
2112 | <div class="md-sidebar__scrollwrap"> | |
2113 | <div class="md-sidebar__inner"> | |
2114 | ||
2115 | <nav class="md-nav md-nav--secondary" aria-label="Table of contents"> | |
2116 | ||
2117 | ||
2118 | ||
2119 | ||
2120 | ||
2121 | <label class="md-nav__title" for="__toc"> | |
2122 | <span class="md-nav__icon md-icon"></span> | |
2123 | Table of contents | |
2124 | </label> | |
2125 | <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix> | |
2126 | ||
2127 | <li class="md-nav__item"> | |
2128 | <a href="#introduction" class="md-nav__link"> | |
2129 | Introduction | |
2130 | </a> | |
2131 | ||
2132 | </li> | |
2133 | ||
2134 | <li class="md-nav__item"> | |
2135 | <a href="#elements" class="md-nav__link"> | |
2136 | Elements | |
2137 | </a> | |
2138 | ||
2139 | <nav class="md-nav" aria-label="Elements"> | |
2140 | <ul class="md-nav__list"> | |
2141 | ||
2142 | <li class="md-nav__item"> | |
2143 | <a href="#elcreatetagname-string-element" class="md-nav__link"> | |
2144 | elCreate(tagName: string): Element | |
2145 | </a> | |
2146 | ||
2147 | </li> | |
2148 | ||
2149 | <li class="md-nav__item"> | |
2150 | <a href="#elremoveelement-element" class="md-nav__link"> | |
2151 | elRemove(element: Element) | |
2152 | </a> | |
2153 | ||
2154 | </li> | |
2155 | ||
2156 | <li class="md-nav__item"> | |
2157 | <a href="#elshowelement-element" class="md-nav__link"> | |
2158 | elShow(element: Element) | |
2159 | </a> | |
2160 | ||
2161 | </li> | |
2162 | ||
2163 | <li class="md-nav__item"> | |
2164 | <a href="#elhideelement-element" class="md-nav__link"> | |
2165 | elHide(element: Element) | |
2166 | </a> | |
2167 | ||
2168 | </li> | |
2169 | ||
2170 | <li class="md-nav__item"> | |
2171 | <a href="#eltoggleelement-element" class="md-nav__link"> | |
2172 | elToggle(element: Element) | |
2173 | </a> | |
2174 | ||
2175 | </li> | |
2176 | ||
2177 | </ul> | |
2178 | </nav> | |
2179 | ||
2180 | </li> | |
2181 | ||
2182 | <li class="md-nav__item"> | |
2183 | <a href="#attributes" class="md-nav__link"> | |
2184 | Attributes | |
2185 | </a> | |
2186 | ||
2187 | <nav class="md-nav" aria-label="Attributes"> | |
2188 | <ul class="md-nav__list"> | |
2189 | ||
2190 | <li class="md-nav__item"> | |
2191 | <a href="#elattrelement-element-attribute-string-value-string-string" class="md-nav__link"> | |
2192 | elAttr(element: Element, attribute: string, value?: string): string | |
2193 | </a> | |
2194 | ||
2195 | </li> | |
2196 | ||
2197 | <li class="md-nav__item"> | |
2198 | <a href="#elattrboolelement-element-attribute-string-boolean" class="md-nav__link"> | |
2199 | elAttrBool(element: Element, attribute: string): boolean | |
2200 | </a> | |
2201 | ||
2202 | </li> | |
2203 | ||
2204 | <li class="md-nav__item"> | |
2205 | <a href="#eldataelement-element-attribute-string-value-string-string" class="md-nav__link"> | |
2206 | elData(element: Element, attribute: string, value?: string): string | |
2207 | </a> | |
2208 | ||
2209 | </li> | |
2210 | ||
2211 | <li class="md-nav__item"> | |
2212 | <a href="#eldataboolelement-element-attribute-string-boolean" class="md-nav__link"> | |
2213 | elDataBool(element: Element, attribute: string): boolean | |
2214 | </a> | |
2215 | ||
2216 | </li> | |
2217 | ||
2218 | </ul> | |
2219 | </nav> | |
2220 | ||
2221 | </li> | |
2222 | ||
2223 | <li class="md-nav__item"> | |
2224 | <a href="#selecting-elements" class="md-nav__link"> | |
2225 | Selecting Elements | |
2226 | </a> | |
2227 | ||
2228 | <nav class="md-nav" aria-label="Selecting Elements"> | |
2229 | <ul class="md-nav__list"> | |
2230 | ||
2231 | <li class="md-nav__item"> | |
2232 | <a href="#elbyidid-string-element-null" class="md-nav__link"> | |
2233 | elById(id: string): Element | null | |
2234 | </a> | |
2235 | ||
2236 | </li> | |
2237 | ||
2238 | <li class="md-nav__item"> | |
2239 | <a href="#elbyselselector-string-context-element-element-null" class="md-nav__link"> | |
2240 | elBySel(selector: string, context?: Element): Element | null | |
2241 | </a> | |
2242 | ||
2243 | </li> | |
2244 | ||
2245 | <li class="md-nav__item"> | |
2246 | <a href="#elbyselallselector-string-context-element-callback-element-element-void-nodelist" class="md-nav__link"> | |
2247 | elBySelAll(selector: string, context?: Element, callback: (element: Element) => void): NodeList | |
2248 | </a> | |
2249 | ||
2250 | <nav class="md-nav" aria-label="elBySelAll(selector: string, context?: Element, callback: (element: Element) => void): NodeList"> | |
2251 | <ul class="md-nav__list"> | |
2252 | ||
2253 | <li class="md-nav__item"> | |
2254 | <a href="#callback-to-iterate-over-elements" class="md-nav__link"> | |
2255 | Callback to Iterate Over Elements | |
2256 | </a> | |
2257 | ||
2258 | </li> | |
2259 | ||
2260 | </ul> | |
2261 | </nav> | |
2262 | ||
2263 | </li> | |
2264 | ||
2265 | <li class="md-nav__item"> | |
2266 | <a href="#elclosestelement-element-selector-string-element-null" class="md-nav__link"> | |
2267 | elClosest(element: Element, selector: string): Element | null | |
2268 | </a> | |
2269 | ||
2270 | <nav class="md-nav" aria-label="elClosest(element: Element, selector: string): Element | null"> | |
2271 | <ul class="md-nav__list"> | |
2272 | ||
2273 | <li class="md-nav__item"> | |
2274 | <a href="#text-nodes" class="md-nav__link"> | |
2275 | Text Nodes | |
2276 | </a> | |
2277 | ||
2278 | </li> | |
2279 | ||
2280 | </ul> | |
2281 | </nav> | |
2282 | ||
2283 | </li> | |
2284 | ||
2285 | <li class="md-nav__item"> | |
2286 | <a href="#elbyclassclassname-string-context-element-nodelist" class="md-nav__link"> | |
2287 | elByClass(className: string, context?: Element): NodeList | |
2288 | </a> | |
2289 | ||
2290 | </li> | |
2291 | ||
2292 | <li class="md-nav__item"> | |
2293 | <a href="#elbytagtagname-string-context-element-nodelist" class="md-nav__link"> | |
2294 | elByTag(tagName: string, context?: Element): NodeList | |
2295 | </a> | |
2296 | ||
2297 | </li> | |
2298 | ||
2299 | </ul> | |
2300 | </nav> | |
2301 | ||
2302 | </li> | |
2303 | ||
2304 | <li class="md-nav__item"> | |
2305 | <a href="#utility-functions" class="md-nav__link"> | |
2306 | Utility Functions | |
2307 | </a> | |
2308 | ||
2309 | <nav class="md-nav" aria-label="Utility Functions"> | |
2310 | <ul class="md-nav__list"> | |
2311 | ||
2312 | <li class="md-nav__item"> | |
2313 | <a href="#elinnererrorelement-element-errormessage-string-ishtml-boolean-element-null" class="md-nav__link"> | |
2314 | `elInnerError(element: Element, errorMessage?: string, isHtml?: boolean): Element | null`` | |
2315 | </a> | |
2316 | ||
2317 | </li> | |
2318 | ||
2319 | </ul> | |
2320 | </nav> | |
2321 | ||
2322 | </li> | |
2323 | ||
2324 | <li class="md-nav__item"> | |
2325 | <a href="#string-extensions" class="md-nav__link"> | |
2326 | String Extensions | |
2327 | </a> | |
2328 | ||
2329 | <nav class="md-nav" aria-label="String Extensions"> | |
2330 | <ul class="md-nav__list"> | |
2331 | ||
2332 | <li class="md-nav__item"> | |
2333 | <a href="#hashcode-string" class="md-nav__link"> | |
2334 | hashCode(): string | |
2335 | </a> | |
2336 | ||
2337 | </li> | |
2338 | ||
2339 | </ul> | |
2340 | </nav> | |
2341 | ||
2342 | </li> | |
2343 | ||
2344 | </ul> | |
2345 | ||
2346 | </nav> | |
2347 | </div> | |
2348 | </div> | |
2349 | </div> | |
2350 | ||
2351 | ||
2352 | <div class="md-content" data-md-component="content"> | |
2353 | <article class="md-content__inner md-typeset"> | |
2354 | ||
2355 | ||
9b8bddda | 2356 | <a href="https://github.com/WoltLab/docs.woltlab.com/edit/5.4/docs/javascript/helper-functions.md" title="Edit this page" class="md-content__button md-icon"> |
7124f4cb WG |
2357 | <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20.71 7.04c.39-.39.39-1.04 0-1.41l-2.34-2.34c-.37-.39-1.02-.39-1.41 0l-1.84 1.83 3.75 3.75M3 17.25V21h3.75L17.81 9.93l-3.75-3.75L3 17.25z"/></svg> |
2358 | </a> | |
2359 | ||
0c5338dd TD |
2360 | |
2361 | <h1 id="javascript-helper-functions">JavaScript Helper Functions<a class="headerlink" href="#javascript-helper-functions" title="Permanent link">#</a></h1> | |
2362 | <h2 id="introduction">Introduction<a class="headerlink" href="#introduction" title="Permanent link">#</a></h2> | |
2363 | <p>Since version 3.0, WoltLab Suite ships with a set of global helper functions that are | |
2364 | exposed on the <code>window</code>-object and thus are available regardless of the context. | |
2365 | They are meant to reduce code repetition and to increase readability by moving | |
2366 | potentially relevant parts to the front of an instruction.</p> | |
2367 | <h2 id="elements">Elements<a class="headerlink" href="#elements" title="Permanent link">#</a></h2> | |
2368 | <h3 id="elcreatetagname-string-element"><code>elCreate(tagName: string): Element</code><a class="headerlink" href="#elcreatetagname-string-element" title="Permanent link">#</a></h3> | |
2369 | <p>Creates a new element with the provided tag name.</p> | |
2370 | <div class="highlight"><pre><span></span><code><span class="kd">var</span> <span class="nx">element</span> <span class="o">=</span> <span class="nx">elCreate</span><span class="p">(</span><span class="s2">"div"</span><span class="p">);</span> | |
2371 | <span class="c1">// equals</span> | |
2372 | <span class="kd">var</span> <span class="nx">element</span> <span class="o">=</span> <span class="nb">document</span><span class="p">.</span><span class="nx">createElement</span><span class="p">(</span><span class="s2">"div"</span><span class="p">);</span> | |
2373 | </code></pre></div> | |
0c5338dd TD |
2374 | <h3 id="elremoveelement-element"><code>elRemove(element: Element)</code><a class="headerlink" href="#elremoveelement-element" title="Permanent link">#</a></h3> |
2375 | <p>Removes an element from its parent without returning it. This function will throw | |
2376 | an error if the <code>element</code> doesn't have a parent node.</p> | |
2377 | <div class="highlight"><pre><span></span><code><span class="nx">elRemove</span><span class="p">(</span><span class="nx">element</span><span class="p">);</span> | |
2378 | <span class="c1">// equals</span> | |
2379 | <span class="nx">element</span><span class="p">.</span><span class="nx">parentNode</span><span class="p">.</span><span class="nx">removeChild</span><span class="p">(</span><span class="nx">element</span><span class="p">);</span> | |
2380 | </code></pre></div> | |
0c5338dd TD |
2381 | <h3 id="elshowelement-element"><code>elShow(element: Element)</code><a class="headerlink" href="#elshowelement-element" title="Permanent link">#</a></h3> |
2382 | <p>Attempts to show an element by removing the <code>display</code> CSS-property, usually used | |
2383 | in conjunction with the <code>elHide()</code> function.</p> | |
2384 | <div class="highlight"><pre><span></span><code><span class="nx">elShow</span><span class="p">(</span><span class="nx">element</span><span class="p">);</span> | |
2385 | <span class="c1">// equals</span> | |
2386 | <span class="nx">element</span><span class="p">.</span><span class="nx">style</span><span class="p">.</span><span class="nx">removeProperty</span><span class="p">(</span><span class="s2">"display"</span><span class="p">);</span> | |
2387 | </code></pre></div> | |
0c5338dd TD |
2388 | <h3 id="elhideelement-element"><code>elHide(element: Element)</code><a class="headerlink" href="#elhideelement-element" title="Permanent link">#</a></h3> |
2389 | <p>Attempts to hide an element by setting the <code>display</code> CSS-property to <code>none</code>, this | |
2390 | is intended to be used with <code>elShow()</code> that relies on this behavior.</p> | |
2391 | <div class="highlight"><pre><span></span><code><span class="nx">elHide</span><span class="p">(</span><span class="nx">element</span><span class="p">);</span> | |
2392 | <span class="c1">// equals</span> | |
2393 | <span class="nx">element</span><span class="p">.</span><span class="nx">style</span><span class="p">.</span><span class="nx">setProperty</span><span class="p">(</span><span class="s2">"display"</span><span class="p">,</span> <span class="s2">"none"</span><span class="p">,</span> <span class="s2">""</span><span class="p">);</span> | |
2394 | </code></pre></div> | |
0c5338dd TD |
2395 | <h3 id="eltoggleelement-element"><code>elToggle(element: Element)</code><a class="headerlink" href="#eltoggleelement-element" title="Permanent link">#</a></h3> |
2396 | <p>Attempts to toggle the visibility of an element by examining the value of the | |
2397 | <code>display</code> CSS-property and calls either <code>elShow()</code> or <code>elHide()</code>.</p> | |
2398 | <h2 id="attributes">Attributes<a class="headerlink" href="#attributes" title="Permanent link">#</a></h2> | |
2399 | <h3 id="elattrelement-element-attribute-string-value-string-string"><code>elAttr(element: Element, attribute: string, value?: string): string</code><a class="headerlink" href="#elattrelement-element-attribute-string-value-string-string" title="Permanent link">#</a></h3> | |
2400 | <p>Sets or reads an attribute value, value are implicitly casted into strings and | |
2401 | reading non-existing attributes will always yield an empty string. If you want | |
2402 | to test for attribute existence, you'll have to fall-back to the native | |
2403 | <a href="https://developer.mozilla.org/en-US/docs/Web/API/Element/hasAttribute"><code>Element.hasAttribute()</code></a> | |
2404 | method.</p> | |
2405 | <p>You should read and set native attributes directly, such as <code>img.src</code> rather | |
2406 | than <code>img.getAttribute("src");</code>.</p> | |
2407 | <div class="highlight"><pre><span></span><code><span class="kd">var</span> <span class="nx">value</span> <span class="o">=</span> <span class="nx">elAttr</span><span class="p">(</span><span class="nx">element</span><span class="p">,</span> <span class="s2">"some-attribute"</span><span class="p">);</span> | |
2408 | <span class="c1">// equals</span> | |
2409 | <span class="kd">var</span> <span class="nx">value</span> <span class="o">=</span> <span class="nx">element</span><span class="p">.</span><span class="nx">getAttribute</span><span class="p">(</span><span class="s2">"some-attribute"</span><span class="p">);</span> | |
2410 | ||
2411 | <span class="nx">elAttr</span><span class="p">(</span><span class="nx">element</span><span class="p">,</span> <span class="s2">"some-attribute"</span><span class="p">,</span> <span class="s2">"some value"</span><span class="p">);</span> | |
2412 | <span class="c1">// equals</span> | |
2413 | <span class="nx">element</span><span class="p">.</span><span class="nx">setAttribute</span><span class="p">(</span><span class="s2">"some-attribute"</span><span class="p">,</span> <span class="s2">"some value"</span><span class="p">);</span> | |
2414 | </code></pre></div> | |
0c5338dd TD |
2415 | <h3 id="elattrboolelement-element-attribute-string-boolean"><code>elAttrBool(element: Element, attribute: string): boolean</code><a class="headerlink" href="#elattrboolelement-element-attribute-string-boolean" title="Permanent link">#</a></h3> |
2416 | <p>Reads an attribute and converts it value into a boolean value, the strings <code>"1"</code> | |
2417 | and <code>"true"</code> will evaluate to <code>true</code>. All other values, including a missing attribute, | |
2418 | will return <code>false</code>.</p> | |
2419 | <div class="highlight"><pre><span></span><code><span class="k">if</span> <span class="p">(</span><span class="nx">elAttrBool</span><span class="p">(</span><span class="nx">element</span><span class="p">,</span> <span class="s2">"some-attribute"</span><span class="p">))</span> <span class="p">{</span> | |
2420 | <span class="c1">// attribute is true-ish</span> | |
2421 | <span class="p">}</span> | |
2422 | </code></pre></div> | |
0c5338dd TD |
2423 | <h3 id="eldataelement-element-attribute-string-value-string-string"><code>elData(element: Element, attribute: string, value?: string): string</code><a class="headerlink" href="#eldataelement-element-attribute-string-value-string-string" title="Permanent link">#</a></h3> |
2424 | <p>Short-hand function to read or set HTML5 <code>data-*</code>-attributes, it essentially | |
2425 | prepends the <code>data-</code> prefix before forwarding the call to <code>elAttr()</code>.</p> | |
2426 | <div class="highlight"><pre><span></span><code><span class="kd">var</span> <span class="nx">value</span> <span class="o">=</span> <span class="nx">elData</span><span class="p">(</span><span class="nx">element</span><span class="p">,</span> <span class="s2">"some-attribute"</span><span class="p">);</span> | |
2427 | <span class="c1">// equals</span> | |
2428 | <span class="kd">var</span> <span class="nx">value</span> <span class="o">=</span> <span class="nx">elAttr</span><span class="p">(</span><span class="nx">element</span><span class="p">,</span> <span class="s2">"data-some-attribute"</span><span class="p">);</span> | |
2429 | ||
2430 | <span class="nx">elData</span><span class="p">(</span><span class="nx">element</span><span class="p">,</span> <span class="s2">"some-attribute"</span><span class="p">,</span> <span class="s2">"some value"</span><span class="p">);</span> | |
2431 | <span class="c1">// equals</span> | |
2432 | <span class="nx">elAttr</span><span class="p">(</span><span class="nx">element</span><span class="p">,</span> <span class="s2">"data-some-attribute"</span><span class="p">,</span> <span class="s2">"some value"</span><span class="p">);</span> | |
2433 | </code></pre></div> | |
0c5338dd TD |
2434 | <h3 id="eldataboolelement-element-attribute-string-boolean"><code>elDataBool(element: Element, attribute: string): boolean</code><a class="headerlink" href="#eldataboolelement-element-attribute-string-boolean" title="Permanent link">#</a></h3> |
2435 | <p>Short-hand function to convert a HTML5 <code>data-*</code>-attribute into a boolean value. It | |
2436 | prepends the <code>data-</code> prefix before forwarding the call to <code>elAttrBool()</code>.</p> | |
2437 | <div class="highlight"><pre><span></span><code><span class="k">if</span> <span class="p">(</span><span class="nx">elDataBool</span><span class="p">(</span><span class="nx">element</span><span class="p">,</span> <span class="s2">"some-attribute"</span><span class="p">))</span> <span class="p">{</span> | |
2438 | <span class="c1">// attribute is true-ish</span> | |
2439 | <span class="p">}</span> | |
2440 | <span class="c1">// equals</span> | |
2441 | <span class="k">if</span> <span class="p">(</span><span class="nx">elAttrBool</span><span class="p">(</span><span class="nx">element</span><span class="p">,</span> <span class="s2">"data-some-attribute"</span><span class="p">))</span> <span class="p">{</span> | |
2442 | <span class="c1">// attribute is true-ish</span> | |
2443 | <span class="p">}</span> | |
2444 | </code></pre></div> | |
0c5338dd TD |
2445 | <h2 id="selecting-elements">Selecting Elements<a class="headerlink" href="#selecting-elements" title="Permanent link">#</a></h2> |
2446 | <div class="admonition warning"> | |
2447 | <p class="admonition-title">Unlike libraries like jQuery, these functions will return <code>null</code> if an element is not found. You are responsible to validate if the element exist and to branch accordingly, invoking methods on the return value without checking for <code>null</code> will yield an error.</p> | |
2448 | </div> | |
2449 | <h3 id="elbyidid-string-element-null"><code>elById(id: string): Element | null</code><a class="headerlink" href="#elbyidid-string-element-null" title="Permanent link">#</a></h3> | |
2450 | <p>Selects an element by its <code>id</code>-attribute value.</p> | |
2451 | <div class="highlight"><pre><span></span><code><span class="kd">var</span> <span class="nx">element</span> <span class="o">=</span> <span class="nx">elById</span><span class="p">(</span><span class="s2">"my-awesome-element"</span><span class="p">);</span> | |
2452 | <span class="c1">// equals</span> | |
2453 | <span class="kd">var</span> <span class="nx">element</span> <span class="o">=</span> <span class="nb">document</span><span class="p">.</span><span class="nx">getElementById</span><span class="p">(</span><span class="s2">"my-awesome-element"</span><span class="p">);</span> | |
2454 | </code></pre></div> | |
0c5338dd TD |
2455 | <h3 id="elbyselselector-string-context-element-element-null"><code>elBySel(selector: string, context?: Element): Element | null</code><a class="headerlink" href="#elbyselselector-string-context-element-element-null" title="Permanent link">#</a></h3> |
2456 | <div class="admonition danger"> | |
2457 | <p class="admonition-title">The underlying <code>querySelector()</code>-method works on the entire DOM hierarchy and can yield results outside of your context element! Please read and understand the MDN article on <a href="https://developer.mozilla.org/en-US/docs/Web/API/Element/querySelector#The_entire_hierarchy_counts"><code>Element.querySelector()</code></a> to learn more about this.</p> | |
2458 | </div> | |
2459 | <p>Select a single element based on a CSS selector, optionally limiting the results | |
2460 | to be a direct or indirect children of the context element.</p> | |
2461 | <div class="highlight"><pre><span></span><code><span class="kd">var</span> <span class="nx">element</span> <span class="o">=</span> <span class="nx">elBySel</span><span class="p">(</span><span class="s2">".some-element"</span><span class="p">);</span> | |
2462 | <span class="c1">// equals</span> | |
2463 | <span class="kd">var</span> <span class="nx">element</span> <span class="o">=</span> <span class="nb">document</span><span class="p">.</span><span class="nx">querySelector</span><span class="p">(</span><span class="s2">".some-element"</span><span class="p">);</span> | |
2464 | ||
2465 | <span class="c1">// limiting the scope to a context element:</span> | |
2466 | <span class="kd">var</span> <span class="nx">element</span> <span class="o">=</span> <span class="nx">elBySel</span><span class="p">(</span><span class="s2">".some-element"</span><span class="p">,</span> <span class="nx">context</span><span class="p">);</span> | |
2467 | <span class="c1">// equals</span> | |
2468 | <span class="kd">var</span> <span class="nx">element</span> <span class="o">=</span> <span class="nx">context</span><span class="p">.</span><span class="nx">querySelector</span><span class="p">(</span><span class="s2">".some-element"</span><span class="p">);</span> | |
2469 | </code></pre></div> | |
0c5338dd TD |
2470 | <h3 id="elbyselallselector-string-context-element-callback-element-element-void-nodelist"><code>elBySelAll(selector: string, context?: Element, callback: (element: Element) => void): NodeList</code><a class="headerlink" href="#elbyselallselector-string-context-element-callback-element-element-void-nodelist" title="Permanent link">#</a></h3> |
2471 | <div class="admonition danger"> | |
2472 | <p class="admonition-title">The underlying <code>querySelector()</code>-method works on the entire DOM hierarchy and can yield results outside of your context element! Please read and understand the MDN article on <a href="https://developer.mozilla.org/en-US/docs/Web/API/Element/querySelector#The_entire_hierarchy_counts"><code>Element.querySelector()</code></a> to learn more about this.</p> | |
2473 | </div> | |
2474 | <p>Finds and returns a <code>NodeList</code> containing all elements that match the provided | |
2475 | CSS selector. Although <code>NodeList</code> is an array-like structure, it is not possible | |
2476 | to iterate over it using array functions, including <code>.forEach()</code> which is not | |
2477 | available in Internet Explorer 11.</p> | |
2478 | <div class="highlight"><pre><span></span><code><span class="kd">var</span> <span class="nx">elements</span> <span class="o">=</span> <span class="nx">elBySelAll</span><span class="p">(</span><span class="s2">".some-element"</span><span class="p">);</span> | |
2479 | <span class="c1">// equals</span> | |
2480 | <span class="kd">var</span> <span class="nx">elements</span> <span class="o">=</span> <span class="nb">document</span><span class="p">.</span><span class="nx">querySelectorAll</span><span class="p">(</span><span class="s2">".some-element"</span><span class="p">);</span> | |
2481 | ||
2482 | <span class="c1">// limiting the scope to a context element:</span> | |
2483 | <span class="kd">var</span> <span class="nx">elements</span> <span class="o">=</span> <span class="nx">elBySelAll</span><span class="p">(</span><span class="s2">".some-element"</span><span class="p">,</span> <span class="nx">context</span><span class="p">);</span> | |
2484 | <span class="c1">// equals</span> | |
2485 | <span class="kd">var</span> <span class="nx">elements</span> <span class="o">=</span> <span class="nx">context</span><span class="p">.</span><span class="nx">querySelectorAll</span><span class="p">(</span><span class="s2">".some-element"</span><span class="p">);</span> | |
2486 | </code></pre></div> | |
0c5338dd TD |
2487 | <h4 id="callback-to-iterate-over-elements">Callback to Iterate Over Elements<a class="headerlink" href="#callback-to-iterate-over-elements" title="Permanent link">#</a></h4> |
2488 | <p><code>elBySelAll()</code> supports an optional third parameter that expects a callback function | |
2489 | that is invoked for every element in the list.</p> | |
2490 | <div class="highlight"><pre><span></span><code><span class="c1">// set the 2nd parameter to `undefined` or `null` to query the whole document</span> | |
2491 | <span class="nx">elBySelAll</span><span class="p">(</span><span class="s2">".some-element"</span><span class="p">,</span> <span class="kc">undefined</span><span class="p">,</span> <span class="kd">function</span><span class="p">(</span><span class="nx">element</span><span class="p">)</span> <span class="p">{</span> | |
2492 | <span class="c1">// is called for each element</span> | |
2493 | <span class="p">});</span> | |
2494 | ||
2495 | <span class="c1">// limiting the scope to a context element:</span> | |
2496 | <span class="nx">elBySelAll</span><span class="p">(</span><span class="s2">".some-element"</span><span class="p">,</span> <span class="nx">context</span><span class="p">,</span> <span class="kd">function</span><span class="p">(</span><span class="nx">element</span><span class="p">)</span> <span class="p">{</span> | |
2497 | <span class="c1">// is called for each element</span> | |
2498 | <span class="p">});</span> | |
2499 | </code></pre></div> | |
0c5338dd TD |
2500 | <h3 id="elclosestelement-element-selector-string-element-null"><code>elClosest(element: Element, selector: string): Element | null</code><a class="headerlink" href="#elclosestelement-element-selector-string-element-null" title="Permanent link">#</a></h3> |
2501 | <p>Returns the first <code>Element</code> that matches the provided CSS selector, this will | |
2502 | return the provided element itself if it matches the selector.</p> | |
2503 | <div class="highlight"><pre><span></span><code><span class="kd">var</span> <span class="nx">element</span> <span class="o">=</span> <span class="nx">elClosest</span><span class="p">(</span><span class="nx">context</span><span class="p">,</span> <span class="s2">".some-element"</span><span class="p">);</span> | |
2504 | <span class="c1">// equals</span> | |
2505 | <span class="kd">var</span> <span class="nx">element</span> <span class="o">=</span> <span class="nx">context</span><span class="p">.</span><span class="nx">closest</span><span class="p">(</span><span class="s2">".some-element"</span><span class="p">);</span> | |
2506 | </code></pre></div> | |
0c5338dd TD |
2507 | <h4 id="text-nodes">Text Nodes<a class="headerlink" href="#text-nodes" title="Permanent link">#</a></h4> |
2508 | <p>If the provided context is a <code>Text</code>-node, the function will move the context to | |
2509 | the parent element before applying the CSS selector. If the <code>Text</code> has no parent, | |
2510 | <code>null</code> is returned without evaluating the selector.</p> | |
2511 | <h3 id="elbyclassclassname-string-context-element-nodelist"><code>elByClass(className: string, context?: Element): NodeList</code><a class="headerlink" href="#elbyclassclassname-string-context-element-nodelist" title="Permanent link">#</a></h3> | |
2512 | <p>Returns a live <code>NodeList</code> containing all elements that match the provided CSS | |
2513 | class now <em>and</em> in the future! The collection is automatically updated whenever | |
2514 | an element with that class is added or removed from the DOM, it will also include | |
2515 | elements that get dynamically assigned or removed this CSS class.</p> | |
2516 | <p>You absolutely need to understand that this collection is dynamic, that means that | |
2517 | elements can and will be added and removed from the collection <em>even while</em> you | |
2518 | iterate over it. There are only very few cases where you would need such a collection, | |
2519 | almost always <code>elBySelAll()</code> is what you're looking for.</p> | |
2520 | <div class="highlight"><pre><span></span><code><span class="c1">// no leading dot!</span> | |
2521 | <span class="kd">var</span> <span class="nx">elements</span> <span class="o">=</span> <span class="nx">elByClass</span><span class="p">(</span><span class="s2">"some-element"</span><span class="p">);</span> | |
2522 | <span class="c1">// equals</span> | |
2523 | <span class="kd">var</span> <span class="nx">elements</span> <span class="o">=</span> <span class="nb">document</span><span class="p">.</span><span class="nx">getElementsByClassName</span><span class="p">(</span><span class="s2">"some-element"</span><span class="p">);</span> | |
2524 | ||
2525 | <span class="c1">// limiting the scope to a context element:</span> | |
2526 | <span class="kd">var</span> <span class="nx">elements</span> <span class="o">=</span> <span class="nx">elByClass</span><span class="p">(</span><span class="s2">"some-element"</span><span class="p">,</span> <span class="nx">context</span><span class="p">);</span> | |
2527 | <span class="c1">// equals</span> | |
2528 | <span class="kd">var</span> <span class="nx">elements</span> <span class="o">=</span> <span class="nx">context</span><span class="p">.</span><span class="nx">getElementsByClassName</span><span class="p">(</span><span class="s2">".some-element"</span><span class="p">);</span> | |
2529 | </code></pre></div> | |
0c5338dd TD |
2530 | <h3 id="elbytagtagname-string-context-element-nodelist"><code>elByTag(tagName: string, context?: Element): NodeList</code><a class="headerlink" href="#elbytagtagname-string-context-element-nodelist" title="Permanent link">#</a></h3> |
2531 | <p>Returns a live <code>NodeList</code> containing all elements with the provided tag name now | |
2532 | <em>and</em> in the future! Please read the remarks on <code>elByClass()</code> above to understand | |
2533 | the implications of this.</p> | |
2534 | <div class="highlight"><pre><span></span><code><span class="kd">var</span> <span class="nx">elements</span> <span class="o">=</span> <span class="nx">elByTag</span><span class="p">(</span><span class="s2">"div"</span><span class="p">);</span> | |
2535 | <span class="c1">// equals</span> | |
2536 | <span class="kd">var</span> <span class="nx">elements</span> <span class="o">=</span> <span class="nb">document</span><span class="p">.</span><span class="nx">getElementsByTagName</span><span class="p">(</span><span class="s2">"div"</span><span class="p">);</span> | |
2537 | ||
2538 | <span class="c1">// limiting the scope to a context element:</span> | |
2539 | <span class="kd">var</span> <span class="nx">elements</span> <span class="o">=</span> <span class="nx">elByTag</span><span class="p">(</span><span class="s2">"div"</span><span class="p">,</span> <span class="nx">context</span><span class="p">);</span> | |
2540 | <span class="c1">// equals</span> | |
2541 | <span class="kd">var</span> <span class="nx">elements</span> <span class="o">=</span> <span class="nx">context</span><span class="p">.</span><span class="nx">getElementsByTagName</span><span class="p">(</span><span class="s2">"div"</span><span class="p">);</span> | |
2542 | </code></pre></div> | |
0c5338dd TD |
2543 | <h2 id="utility-functions">Utility Functions<a class="headerlink" href="#utility-functions" title="Permanent link">#</a></h2> |
2544 | <h3 id="elinnererrorelement-element-errormessage-string-ishtml-boolean-element-null">`elInnerError(element: Element, errorMessage?: string, isHtml?: boolean): Element | null``<a class="headerlink" href="#elinnererrorelement-element-errormessage-string-ishtml-boolean-element-null" title="Permanent link">#</a></h3> | |
2545 | <p>Unified function to display and remove inline error messages for input elements, | |
2546 | please read the <a href="../../migration/wsc30/javascript/#helper-function-for-inline-error-messages">section in the migration docs</a> | |
2547 | to learn more about this function.</p> | |
2548 | <h2 id="string-extensions">String Extensions<a class="headerlink" href="#string-extensions" title="Permanent link">#</a></h2> | |
2549 | <h3 id="hashcode-string"><code>hashCode(): string</code><a class="headerlink" href="#hashcode-string" title="Permanent link">#</a></h3> | |
2550 | <p>Computes a numeric hash value of a string similar to Java's <code>String.hashCode()</code> method.</p> | |
2551 | <div class="highlight"><pre><span></span><code><span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="s2">"Hello World"</span><span class="p">.</span><span class="nx">hashCode</span><span class="p">());</span> | |
2552 | <span class="c1">// outputs: -862545276</span> | |
2553 | </code></pre></div> | |
2554 | ||
4a5c32e1 WG |
2555 | |
2556 | ||
2557 | ||
2558 | <hr> | |
2559 | <div class="md-source-date"> | |
2560 | <small> | |
2561 | ||
2562 | Last update: 2021-01-08 | |
2563 | ||
2564 | </small> | |
2565 | </div> | |
2566 | ||
2567 | ||
0c5338dd TD |
2568 | |
2569 | ||
2570 | ||
2571 | ||
2572 | ||
2573 | ||
2574 | </article> | |
2575 | </div> | |
2576 | </div> | |
fb962f09 | 2577 | |
0c5338dd TD |
2578 | </main> |
2579 | ||
2580 | ||
2581 | <footer class="md-footer"> | |
2582 | ||
2583 | <nav class="md-footer__inner md-grid" aria-label="Footer"> | |
2584 | ||
2585 | <a href="../legacy-api/" class="md-footer__link md-footer__link--prev" rel="prev"> | |
2586 | <div class="md-footer__button md-icon"> | |
2587 | <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg> | |
2588 | </div> | |
2589 | <div class="md-footer__title"> | |
2590 | <div class="md-ellipsis"> | |
2591 | <span class="md-footer__direction"> | |
2592 | Previous | |
2593 | </span> | |
2594 | Legacy API | |
2595 | </div> | |
2596 | </div> | |
2597 | </a> | |
2598 | ||
2599 | ||
2600 | <a href="../code-snippets/" class="md-footer__link md-footer__link--next" rel="next"> | |
2601 | <div class="md-footer__title"> | |
2602 | <div class="md-ellipsis"> | |
2603 | <span class="md-footer__direction"> | |
2604 | Next | |
2605 | </span> | |
2606 | Code Snippets | |
2607 | </div> | |
2608 | </div> | |
2609 | <div class="md-footer__button md-icon"> | |
2610 | <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11H4z"/></svg> | |
2611 | </div> | |
2612 | </a> | |
2613 | ||
2614 | </nav> | |
2615 | ||
2616 | <div class="md-footer-meta md-typeset"> | |
2617 | <div class="md-footer-meta__inner md-grid"> | |
2618 | <div class="md-footer-copyright"> | |
2619 | ||
2620 | <div class="md-footer-copyright__highlight"> | |
2621 | Copyright © 2020 WoltLab GmbH | |
2622 | </div> | |
2623 | ||
2624 | Made with | |
2625 | <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener"> | |
2626 | Material for MkDocs | |
2627 | </a> | |
fb88dc6e | 2628 | |
0c5338dd TD |
2629 | </div> |
2630 | <div class="md-footer-copyright"> | |
2631 | <a href="https://www.woltlab.com/legal-notice/">Legal Notice</a> | |
2632 | <a href="https://www.woltlab.com/privacy-policy/">Privacy Policy</a> | |
2633 | </div> | |
2634 | </div> | |
2635 | </div> | |
2636 | </footer> | |
2637 | ||
2638 | </div> | |
2639 | <div class="md-dialog" data-md-component="dialog"> | |
2640 | <div class="md-dialog__inner md-typeset"></div> | |
2641 | </div> | |
fb962f09 | 2642 | <script id="__config" type="application/json">{"base": "../..", "features": [], "translations": {"clipboard.copy": "Copy to clipboard", "clipboard.copied": "Copied to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.placeholder": "Search", "search.result.placeholder": "Type to start searching", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.term.missing": "Missing"}, "search": "../../assets/javascripts/workers/search.fe42c31b.min.js", "version": {"provider": "mike"}}</script> |
0c5338dd TD |
2643 | |
2644 | ||
fb962f09 | 2645 | <script src="../../assets/javascripts/bundle.d892486b.min.js"></script> |
0c5338dd TD |
2646 | |
2647 | ||
2648 | </body> | |
2649 | </html> |