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