3 <html lang=
"en" class=
"no-js">
7 <meta name=
"viewport" content=
"width=device-width,initial-scale=1">
12 <link rel=
"icon" href=
"../../assets/default.favicon.ico">
13 <meta name=
"generator" content=
"mkdocs-1.1.2, mkdocs-material-7.1.0">
17 <title>Helper Functions - WoltLab Suite Documentation
</title>
21 <link rel=
"stylesheet" href=
"../../assets/stylesheets/main.33e2939f.min.css">
24 <link rel=
"stylesheet" href=
"../../assets/stylesheets/palette.ef6f36e2.min.css">
28 <meta name=
"theme-color" content=
"#009485">
38 <link rel=
"stylesheet" href=
"../../stylesheets/extra.css">
52 <body dir=
"ltr" data-md-color-scheme=
"" data-md-color-primary=
"teal" data-md-color-accent=
"">
55 <script>function __prefix(e){return new URL(
"../..",location).pathname+
"."+e}function __get(e,t=localStorage){return JSON.parse(t.getItem(__prefix(e)))}
</script>
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">
63 <a href=
"#javascript-helper-functions" class=
"md-skip">
68 <div data-md-component=
"announce">
70 <aside class=
"md-announce">
71 <div class=
"md-announce__inner md-grid md-typeset">
73 <a href=
"https://www.woltlab.com">Back to
<strong>woltlab.com
</strong></a>
80 <header class=
"md-header" data-md-component=
"header">
81 <nav class=
"md-header__inner md-grid" aria-label=
"Header">
82 <a href=
"../.." title=
"WoltLab Suite Documentation" class=
"md-header__button md-logo" aria-label=
"WoltLab Suite Documentation" data-md-component=
"logo">
84 <img src=
"../../assets/logo.png" alt=
"logo">
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>
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
97 <div class=
"md-header__topic" data-md-component=
"header-topic">
98 <span class=
"md-ellipsis">
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>
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>
122 <button type=
"reset" class=
"md-search__icon md-icon" aria-label=
"Clear" tabindex=
"-1">
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>
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">
132 <ol class=
"md-search-result__list"></ol>
140 <div class=
"md-header__source">
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">
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>
147 <div class=
"md-source__repository">
156 <div class=
"md-container" data-md-component=
"container">
161 <main class=
"md-main" data-md-component=
"main">
162 <div class=
"md-main__inner md-grid">
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">
172 <nav class=
"md-nav md-nav--primary" aria-label=
"Navigation" data-md-level=
"0">
173 <label class=
"md-nav__title" for=
"__drawer">
174 <a href=
"../.." title=
"WoltLab Suite Documentation" class=
"md-nav__button md-logo" aria-label=
"WoltLab Suite Documentation" data-md-component=
"logo">
176 <img src=
"../../assets/logo.png" alt=
"logo">
179 WoltLab Suite Documentation
182 <div class=
"md-nav__source">
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">
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>
189 <div class=
"md-source__repository">
195 <ul class=
"md-nav__list" data-md-scrollfix
>
204 <li class=
"md-nav__item">
205 <a href=
"../../getting-started/" class=
"md-nav__link">
220 <li class=
"md-nav__item md-nav__item--nested">
223 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2" type=
"checkbox" id=
"__nav_2" >
225 <label class=
"md-nav__link" for=
"__nav_2">
227 <span class=
"md-nav__icon md-icon"></span>
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>
234 <ul class=
"md-nav__list" data-md-scrollfix
>
240 <li class=
"md-nav__item">
241 <a href=
"../../php/pages/" class=
"md-nav__link">
252 <li class=
"md-nav__item">
253 <a href=
"../../php/database-objects/" class=
"md-nav__link">
264 <li class=
"md-nav__item">
265 <a href=
"../../php/database-access/" class=
"md-nav__link">
276 <li class=
"md-nav__item">
277 <a href=
"../../php/exceptions/" class=
"md-nav__link">
289 <li class=
"md-nav__item md-nav__item--nested">
292 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5" type=
"checkbox" id=
"__nav_2_5" >
294 <label class=
"md-nav__link" for=
"__nav_2_5">
296 <span class=
"md-nav__icon md-icon"></span>
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>
303 <ul class=
"md-nav__list" data-md-scrollfix
>
310 <li class=
"md-nav__item md-nav__item--nested">
313 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5_1" type=
"checkbox" id=
"__nav_2_5_1" >
315 <label class=
"md-nav__link" for=
"__nav_2_5_1">
317 <span class=
"md-nav__icon md-icon"></span>
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>
324 <ul class=
"md-nav__list" data-md-scrollfix
>
330 <li class=
"md-nav__item">
331 <a href=
"../../php/api/caches/" class=
"md-nav__link">
342 <li class=
"md-nav__item">
343 <a href=
"../../php/api/caches_persistent-caches/" class=
"md-nav__link">
354 <li class=
"md-nav__item">
355 <a href=
"../../php/api/caches_runtime-caches/" class=
"md-nav__link">
372 <li class=
"md-nav__item">
373 <a href=
"../../php/api/comments/" class=
"md-nav__link">
384 <li class=
"md-nav__item">
385 <a href=
"../../php/api/cronjobs/" class=
"md-nav__link">
396 <li class=
"md-nav__item">
397 <a href=
"../../php/api/events/" class=
"md-nav__link">
409 <li class=
"md-nav__item md-nav__item--nested">
412 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5_5" type=
"checkbox" id=
"__nav_2_5_5" >
414 <label class=
"md-nav__link" for=
"__nav_2_5_5">
416 <span class=
"md-nav__icon md-icon"></span>
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>
423 <ul class=
"md-nav__list" data-md-scrollfix
>
429 <li class=
"md-nav__item">
430 <a href=
"../../php/api/form_builder/overview/" class=
"md-nav__link">
441 <li class=
"md-nav__item">
442 <a href=
"../../php/api/form_builder/structure/" class=
"md-nav__link">
453 <li class=
"md-nav__item">
454 <a href=
"../../php/api/form_builder/form_fields/" class=
"md-nav__link">
465 <li class=
"md-nav__item">
466 <a href=
"../../php/api/form_builder/validation_data/" class=
"md-nav__link">
477 <li class=
"md-nav__item">
478 <a href=
"../../php/api/form_builder/dependencies/" class=
"md-nav__link">
495 <li class=
"md-nav__item">
496 <a href=
"../../php/api/package_installation_plugins/" class=
"md-nav__link">
497 Package Installation Plugins
507 <li class=
"md-nav__item">
508 <a href=
"../../php/api/user_activity_points/" class=
"md-nav__link">
519 <li class=
"md-nav__item">
520 <a href=
"../../php/api/user_notifications/" class=
"md-nav__link">
531 <li class=
"md-nav__item">
532 <a href=
"../../php/api/sitemaps/" class=
"md-nav__link">
549 <li class=
"md-nav__item">
550 <a href=
"../../php/code-style/" class=
"md-nav__link">
561 <li class=
"md-nav__item">
562 <a href=
"../../php/apps/" class=
"md-nav__link">
573 <li class=
"md-nav__item">
574 <a href=
"../../php/gdpr/" class=
"md-nav__link">
595 <li class=
"md-nav__item md-nav__item--nested">
598 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_3" type=
"checkbox" id=
"__nav_3" >
600 <label class=
"md-nav__link" for=
"__nav_3">
601 Languages, Templates & CSS
602 <span class=
"md-nav__icon md-icon"></span>
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
609 <ul class=
"md-nav__list" data-md-scrollfix
>
615 <li class=
"md-nav__item">
616 <a href=
"../../view/languages/" class=
"md-nav__link">
627 <li class=
"md-nav__item">
628 <a href=
"../../view/templates/" class=
"md-nav__link">
639 <li class=
"md-nav__item">
640 <a href=
"../../view/template-plugins/" class=
"md-nav__link">
651 <li class=
"md-nav__item">
652 <a href=
"../../view/css/" class=
"md-nav__link">
675 <li class=
"md-nav__item md-nav__item--active md-nav__item--nested">
678 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4" type=
"checkbox" id=
"__nav_4" checked
>
680 <label class=
"md-nav__link" for=
"__nav_4">
681 TypeScript and JavaScript API
682 <span class=
"md-nav__icon md-icon"></span>
684 <nav class=
"md-nav" aria-label=
"TypeScript and JavaScript API" data-md-level=
"1">
685 <label class=
"md-nav__title" for=
"__nav_4">
686 <span class=
"md-nav__icon md-icon"></span>
687 TypeScript and JavaScript API
689 <ul class=
"md-nav__list" data-md-scrollfix
>
695 <li class=
"md-nav__item">
696 <a href=
"../general-usage/" class=
"md-nav__link">
707 <li class=
"md-nav__item">
708 <a href=
"../typescript/" class=
"md-nav__link">
720 <li class=
"md-nav__item md-nav__item--nested">
723 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4_3" type=
"checkbox" id=
"__nav_4_3" >
725 <label class=
"md-nav__link" for=
"__nav_4_3">
727 <span class=
"md-nav__icon md-icon"></span>
729 <nav class=
"md-nav" aria-label=
"New API" data-md-level=
"2">
730 <label class=
"md-nav__title" for=
"__nav_4_3">
731 <span class=
"md-nav__icon md-icon"></span>
734 <ul class=
"md-nav__list" data-md-scrollfix
>
740 <li class=
"md-nav__item">
741 <a href=
"../new-api_writing-a-module/" class=
"md-nav__link">
752 <li class=
"md-nav__item">
753 <a href=
"../new-api_data-structures/" class=
"md-nav__link">
764 <li class=
"md-nav__item">
765 <a href=
"../new-api_core/" class=
"md-nav__link">
776 <li class=
"md-nav__item">
777 <a href=
"../new-api_dom/" class=
"md-nav__link">
788 <li class=
"md-nav__item">
789 <a href=
"../new-api_events/" class=
"md-nav__link">
800 <li class=
"md-nav__item">
801 <a href=
"../new-api_ajax/" class=
"md-nav__link">
812 <li class=
"md-nav__item">
813 <a href=
"../new-api_dialogs/" class=
"md-nav__link">
824 <li class=
"md-nav__item">
825 <a href=
"../new-api_browser/" class=
"md-nav__link">
826 Browser and Screen Sizes
836 <li class=
"md-nav__item">
837 <a href=
"../new-api_ui/" class=
"md-nav__link">
854 <li class=
"md-nav__item">
855 <a href=
"../legacy-api/" class=
"md-nav__link">
868 <li class=
"md-nav__item md-nav__item--active">
870 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"toc" type=
"checkbox" id=
"__toc">
875 <label class=
"md-nav__link md-nav__link--active" for=
"__toc">
877 <span class=
"md-nav__icon md-icon"></span>
880 <a href=
"./" class=
"md-nav__link md-nav__link--active">
885 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
891 <label class=
"md-nav__title" for=
"__toc">
892 <span class=
"md-nav__icon md-icon"></span>
895 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
897 <li class=
"md-nav__item">
898 <a href=
"#introduction" class=
"md-nav__link">
904 <li class=
"md-nav__item">
905 <a href=
"#elements" class=
"md-nav__link">
909 <nav class=
"md-nav" aria-label=
"Elements">
910 <ul class=
"md-nav__list">
912 <li class=
"md-nav__item">
913 <a href=
"#elcreatetagname-string-element" class=
"md-nav__link">
914 elCreate(tagName: string): Element
919 <li class=
"md-nav__item">
920 <a href=
"#elremoveelement-element" class=
"md-nav__link">
921 elRemove(element: Element)
926 <li class=
"md-nav__item">
927 <a href=
"#elshowelement-element" class=
"md-nav__link">
928 elShow(element: Element)
933 <li class=
"md-nav__item">
934 <a href=
"#elhideelement-element" class=
"md-nav__link">
935 elHide(element: Element)
940 <li class=
"md-nav__item">
941 <a href=
"#eltoggleelement-element" class=
"md-nav__link">
942 elToggle(element: Element)
952 <li class=
"md-nav__item">
953 <a href=
"#attributes" class=
"md-nav__link">
957 <nav class=
"md-nav" aria-label=
"Attributes">
958 <ul class=
"md-nav__list">
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
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
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
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
993 <li class=
"md-nav__item">
994 <a href=
"#selecting-elements" class=
"md-nav__link">
998 <nav class=
"md-nav" aria-label=
"Selecting Elements">
999 <ul class=
"md-nav__list">
1001 <li class=
"md-nav__item">
1002 <a href=
"#elbyidid-string-element-null" class=
"md-nav__link">
1003 elById(id: string): Element | null
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
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
1020 <nav class=
"md-nav" aria-label=
"elBySelAll(selector: string, context?: Element, callback: (element: Element) => void): NodeList">
1021 <ul class=
"md-nav__list">
1023 <li class=
"md-nav__item">
1024 <a href=
"#callback-to-iterate-over-elements" class=
"md-nav__link">
1025 Callback to Iterate Over Elements
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
1040 <nav class=
"md-nav" aria-label=
"elClosest(element: Element, selector: string): Element | null">
1041 <ul class=
"md-nav__list">
1043 <li class=
"md-nav__item">
1044 <a href=
"#text-nodes" class=
"md-nav__link">
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
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
1074 <li class=
"md-nav__item">
1075 <a href=
"#utility-functions" class=
"md-nav__link">
1079 <nav class=
"md-nav" aria-label=
"Utility Functions">
1080 <ul class=
"md-nav__list">
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``
1094 <li class=
"md-nav__item">
1095 <a href=
"#string-extensions" class=
"md-nav__link">
1099 <nav class=
"md-nav" aria-label=
"String Extensions">
1100 <ul class=
"md-nav__list">
1102 <li class=
"md-nav__item">
1103 <a href=
"#hashcode-string" class=
"md-nav__link">
1126 <li class=
"md-nav__item">
1127 <a href=
"../code-snippets/" class=
"md-nav__link">
1148 <li class=
"md-nav__item md-nav__item--nested">
1151 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5" type=
"checkbox" id=
"__nav_5" >
1153 <label class=
"md-nav__link" for=
"__nav_5">
1155 <span class=
"md-nav__icon md-icon"></span>
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>
1162 <ul class=
"md-nav__list" data-md-scrollfix
>
1168 <li class=
"md-nav__item">
1169 <a href=
"../../package/package-xml/" class=
"md-nav__link">
1181 <li class=
"md-nav__item md-nav__item--nested">
1184 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5_2" type=
"checkbox" id=
"__nav_5_2" >
1186 <label class=
"md-nav__link" for=
"__nav_5_2">
1188 <span class=
"md-nav__icon md-icon"></span>
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>
1195 <ul class=
"md-nav__list" data-md-scrollfix
>
1201 <li class=
"md-nav__item">
1202 <a href=
"../../package/pip/" class=
"md-nav__link">
1213 <li class=
"md-nav__item">
1214 <a href=
"../../package/pip/acl-option/" class=
"md-nav__link">
1225 <li class=
"md-nav__item">
1226 <a href=
"../../package/pip/acp-menu/" class=
"md-nav__link">
1237 <li class=
"md-nav__item">
1238 <a href=
"../../package/pip/acp-search-provider/" class=
"md-nav__link">
1249 <li class=
"md-nav__item">
1250 <a href=
"../../package/pip/acp-template/" class=
"md-nav__link">
1261 <li class=
"md-nav__item">
1262 <a href=
"../../package/pip/bbcode/" class=
"md-nav__link">
1273 <li class=
"md-nav__item">
1274 <a href=
"../../package/pip/box/" class=
"md-nav__link">
1285 <li class=
"md-nav__item">
1286 <a href=
"../../package/pip/clipboard-action/" class=
"md-nav__link">
1297 <li class=
"md-nav__item">
1298 <a href=
"../../package/pip/core-object/" class=
"md-nav__link">
1309 <li class=
"md-nav__item">
1310 <a href=
"../../package/pip/cronjob/" class=
"md-nav__link">
1321 <li class=
"md-nav__item">
1322 <a href=
"../../package/pip/database/" class=
"md-nav__link">
1333 <li class=
"md-nav__item">
1334 <a href=
"../../package/pip/event-listener/" class=
"md-nav__link">
1345 <li class=
"md-nav__item">
1346 <a href=
"../../package/pip/file/" class=
"md-nav__link">
1357 <li class=
"md-nav__item">
1358 <a href=
"../../package/pip/language/" class=
"md-nav__link">
1369 <li class=
"md-nav__item">
1370 <a href=
"../../package/pip/media-provider/" class=
"md-nav__link">
1381 <li class=
"md-nav__item">
1382 <a href=
"../../package/pip/menu/" class=
"md-nav__link">
1393 <li class=
"md-nav__item">
1394 <a href=
"../../package/pip/menu-item/" class=
"md-nav__link">
1405 <li class=
"md-nav__item">
1406 <a href=
"../../package/pip/object-type/" class=
"md-nav__link">
1417 <li class=
"md-nav__item">
1418 <a href=
"../../package/pip/object-type-definition/" class=
"md-nav__link">
1419 objectTypeDefinition
1429 <li class=
"md-nav__item">
1430 <a href=
"../../package/pip/option/" class=
"md-nav__link">
1441 <li class=
"md-nav__item">
1442 <a href=
"../../package/pip/page/" class=
"md-nav__link">
1453 <li class=
"md-nav__item">
1454 <a href=
"../../package/pip/pip/" class=
"md-nav__link">
1465 <li class=
"md-nav__item">
1466 <a href=
"../../package/pip/script/" class=
"md-nav__link">
1477 <li class=
"md-nav__item">
1478 <a href=
"../../package/pip/smiley/" class=
"md-nav__link">
1489 <li class=
"md-nav__item">
1490 <a href=
"../../package/pip/sql/" class=
"md-nav__link">
1501 <li class=
"md-nav__item">
1502 <a href=
"../../package/pip/style/" class=
"md-nav__link">
1513 <li class=
"md-nav__item">
1514 <a href=
"../../package/pip/template/" class=
"md-nav__link">
1525 <li class=
"md-nav__item">
1526 <a href=
"../../package/pip/template-listener/" class=
"md-nav__link">
1537 <li class=
"md-nav__item">
1538 <a href=
"../../package/pip/user-group-option/" class=
"md-nav__link">
1549 <li class=
"md-nav__item">
1550 <a href=
"../../package/pip/user-menu/" class=
"md-nav__link">
1561 <li class=
"md-nav__item">
1562 <a href=
"../../package/pip/user-notification-event/" class=
"md-nav__link">
1563 userNotificationEvent
1573 <li class=
"md-nav__item">
1574 <a href=
"../../package/pip/user-option/" class=
"md-nav__link">
1585 <li class=
"md-nav__item">
1586 <a href=
"../../package/pip/user-profile-menu/" class=
"md-nav__link">
1603 <li class=
"md-nav__item">
1604 <a href=
"../../package/database-php-api/" class=
"md-nav__link">
1625 <li class=
"md-nav__item md-nav__item--nested">
1628 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6" type=
"checkbox" id=
"__nav_6" >
1630 <label class=
"md-nav__link" for=
"__nav_6">
1632 <span class=
"md-nav__icon md-icon"></span>
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>
1639 <ul class=
"md-nav__list" data-md-scrollfix
>
1646 <li class=
"md-nav__item md-nav__item--nested">
1649 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_1" type=
"checkbox" id=
"__nav_6_1" >
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>
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
1660 <ul class=
"md-nav__list" data-md-scrollfix
>
1666 <li class=
"md-nav__item">
1667 <a href=
"../../migration/wsc53/php/" class=
"md-nav__link">
1678 <li class=
"md-nav__item">
1679 <a href=
"../../migration/wsc53/session/" class=
"md-nav__link">
1680 Session Handling and Authentication
1690 <li class=
"md-nav__item">
1691 <a href=
"../../migration/wsc53/javascript/" class=
"md-nav__link">
1692 TypeScript and JavaScript
1702 <li class=
"md-nav__item">
1703 <a href=
"../../migration/wsc53/templates/" class=
"md-nav__link">
1714 <li class=
"md-nav__item">
1715 <a href=
"../../migration/wsc53/libraries/" class=
"md-nav__link">
1716 Third Party Libraries
1733 <li class=
"md-nav__item md-nav__item--nested">
1736 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_2" type=
"checkbox" id=
"__nav_6_2" >
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>
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
1747 <ul class=
"md-nav__list" data-md-scrollfix
>
1753 <li class=
"md-nav__item">
1754 <a href=
"../../migration/wsc52/php/" class=
"md-nav__link">
1765 <li class=
"md-nav__item">
1766 <a href=
"../../migration/wsc52/templates/" class=
"md-nav__link">
1767 Templates and Languages
1777 <li class=
"md-nav__item">
1778 <a href=
"../../migration/wsc52/libraries/" class=
"md-nav__link">
1779 Third Party Libraries
1796 <li class=
"md-nav__item md-nav__item--nested">
1799 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_3" type=
"checkbox" id=
"__nav_6_3" >
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>
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
1810 <ul class=
"md-nav__list" data-md-scrollfix
>
1816 <li class=
"md-nav__item">
1817 <a href=
"../../migration/wsc31/php/" class=
"md-nav__link">
1835 <li class=
"md-nav__item md-nav__item--nested">
1838 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_4" type=
"checkbox" id=
"__nav_6_4" >
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>
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
1849 <ul class=
"md-nav__list" data-md-scrollfix
>
1855 <li class=
"md-nav__item">
1856 <a href=
"../../migration/wsc30/php/" class=
"md-nav__link">
1867 <li class=
"md-nav__item">
1868 <a href=
"../../migration/wsc30/javascript/" class=
"md-nav__link">
1879 <li class=
"md-nav__item">
1880 <a href=
"../../migration/wsc30/templates/" class=
"md-nav__link">
1891 <li class=
"md-nav__item">
1892 <a href=
"../../migration/wsc30/css/" class=
"md-nav__link">
1903 <li class=
"md-nav__item">
1904 <a href=
"../../migration/wsc30/package/" class=
"md-nav__link">
1922 <li class=
"md-nav__item md-nav__item--nested">
1925 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_5" type=
"checkbox" id=
"__nav_6_5" >
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>
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
1936 <ul class=
"md-nav__list" data-md-scrollfix
>
1942 <li class=
"md-nav__item">
1943 <a href=
"../../migration/wcf21/php/" class=
"md-nav__link">
1954 <li class=
"md-nav__item">
1955 <a href=
"../../migration/wcf21/templates/" class=
"md-nav__link">
1966 <li class=
"md-nav__item">
1967 <a href=
"../../migration/wcf21/css/" class=
"md-nav__link">
1978 <li class=
"md-nav__item">
1979 <a href=
"../../migration/wcf21/package/" class=
"md-nav__link">
2006 <li class=
"md-nav__item md-nav__item--nested">
2009 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7" type=
"checkbox" id=
"__nav_7" >
2011 <label class=
"md-nav__link" for=
"__nav_7">
2013 <span class=
"md-nav__icon md-icon"></span>
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>
2020 <ul class=
"md-nav__list" data-md-scrollfix
>
2027 <li class=
"md-nav__item md-nav__item--nested">
2030 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7_1" type=
"checkbox" id=
"__nav_7_1" >
2032 <label class=
"md-nav__link" for=
"__nav_7_1">
2034 <span class=
"md-nav__icon md-icon"></span>
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>
2041 <ul class=
"md-nav__list" data-md-scrollfix
>
2047 <li class=
"md-nav__item">
2048 <a href=
"../../tutorial/series/overview/" class=
"md-nav__link">
2059 <li class=
"md-nav__item">
2060 <a href=
"../../tutorial/series/part_1/" class=
"md-nav__link">
2071 <li class=
"md-nav__item">
2072 <a href=
"../../tutorial/series/part_2/" class=
"md-nav__link">
2083 <li class=
"md-nav__item">
2084 <a href=
"../../tutorial/series/part_3/" class=
"md-nav__link">
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">
2115 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
2121 <label class=
"md-nav__title" for=
"__toc">
2122 <span class=
"md-nav__icon md-icon"></span>
2125 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
2127 <li class=
"md-nav__item">
2128 <a href=
"#introduction" class=
"md-nav__link">
2134 <li class=
"md-nav__item">
2135 <a href=
"#elements" class=
"md-nav__link">
2139 <nav class=
"md-nav" aria-label=
"Elements">
2140 <ul class=
"md-nav__list">
2142 <li class=
"md-nav__item">
2143 <a href=
"#elcreatetagname-string-element" class=
"md-nav__link">
2144 elCreate(tagName: string): Element
2149 <li class=
"md-nav__item">
2150 <a href=
"#elremoveelement-element" class=
"md-nav__link">
2151 elRemove(element: Element)
2156 <li class=
"md-nav__item">
2157 <a href=
"#elshowelement-element" class=
"md-nav__link">
2158 elShow(element: Element)
2163 <li class=
"md-nav__item">
2164 <a href=
"#elhideelement-element" class=
"md-nav__link">
2165 elHide(element: Element)
2170 <li class=
"md-nav__item">
2171 <a href=
"#eltoggleelement-element" class=
"md-nav__link">
2172 elToggle(element: Element)
2182 <li class=
"md-nav__item">
2183 <a href=
"#attributes" class=
"md-nav__link">
2187 <nav class=
"md-nav" aria-label=
"Attributes">
2188 <ul class=
"md-nav__list">
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
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
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
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
2223 <li class=
"md-nav__item">
2224 <a href=
"#selecting-elements" class=
"md-nav__link">
2228 <nav class=
"md-nav" aria-label=
"Selecting Elements">
2229 <ul class=
"md-nav__list">
2231 <li class=
"md-nav__item">
2232 <a href=
"#elbyidid-string-element-null" class=
"md-nav__link">
2233 elById(id: string): Element | null
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
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
2250 <nav class=
"md-nav" aria-label=
"elBySelAll(selector: string, context?: Element, callback: (element: Element) => void): NodeList">
2251 <ul class=
"md-nav__list">
2253 <li class=
"md-nav__item">
2254 <a href=
"#callback-to-iterate-over-elements" class=
"md-nav__link">
2255 Callback to Iterate Over Elements
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
2270 <nav class=
"md-nav" aria-label=
"elClosest(element: Element, selector: string): Element | null">
2271 <ul class=
"md-nav__list">
2273 <li class=
"md-nav__item">
2274 <a href=
"#text-nodes" class=
"md-nav__link">
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
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
2304 <li class=
"md-nav__item">
2305 <a href=
"#utility-functions" class=
"md-nav__link">
2309 <nav class=
"md-nav" aria-label=
"Utility Functions">
2310 <ul class=
"md-nav__list">
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``
2324 <li class=
"md-nav__item">
2325 <a href=
"#string-extensions" class=
"md-nav__link">
2329 <nav class=
"md-nav" aria-label=
"String Extensions">
2330 <ul class=
"md-nav__list">
2332 <li class=
"md-nav__item">
2333 <a href=
"#hashcode-string" class=
"md-nav__link">
2352 <div class=
"md-content" data-md-component=
"content">
2353 <article class=
"md-content__inner md-typeset">
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">
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
2559 <div class=
"md-source-date">
2562 Last update:
2021-
01-
08
2581 <footer class=
"md-footer">
2583 <nav class=
"md-footer__inner md-grid" aria-label=
"Footer">
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>
2589 <div class=
"md-footer__title">
2590 <div class=
"md-ellipsis">
2591 <span class=
"md-footer__direction">
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">
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>
2616 <div class=
"md-footer-meta md-typeset">
2617 <div class=
"md-footer-meta__inner md-grid">
2618 <div class=
"md-footer-copyright">
2620 <div class=
"md-footer-copyright__highlight">
2621 Copyright ©
2020 WoltLab GmbH
2625 <a href=
"https://squidfunk.github.io/mkdocs-material/" target=
"_blank" rel=
"noopener">
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>
2639 <div class=
"md-dialog" data-md-component=
"dialog">
2640 <div class=
"md-dialog__inner md-typeset"></div>
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>
2645 <script src=
"../../assets/javascripts/bundle.d892486b.min.js"></script>