3 <html lang=
"en" class=
"no-js">
7 <meta name=
"viewport" content=
"width=device-width,initial-scale=1">
12 <link rel=
"canonical" href=
"https://docs.woltlab.com/5.4/javascript/helper-functions/">
14 <link rel=
"icon" href=
"../../assets/default.favicon.ico">
15 <meta name=
"generator" content=
"mkdocs-1.1.2, mkdocs-material-7.1.3">
19 <title>Helper Functions - WoltLab Suite Documentation
</title>
23 <link rel=
"stylesheet" href=
"../../assets/stylesheets/main.e35208c4.min.css">
26 <link rel=
"stylesheet" href=
"../../assets/stylesheets/palette.ef6f36e2.min.css">
30 <meta name=
"theme-color" content=
"#009485">
40 <link rel=
"stylesheet" href=
"../../stylesheets/extra.css">
54 <body dir=
"ltr" data-md-color-scheme=
"" data-md-color-primary=
"teal" data-md-color-accent=
"">
57 <script>function __prefix(e){return new URL(
"../..",location).pathname+
"."+e}function __get(e,t=localStorage){return JSON.parse(t.getItem(__prefix(e)))}
</script>
59 <input class=
"md-toggle" data-md-toggle=
"drawer" type=
"checkbox" id=
"__drawer" autocomplete=
"off">
60 <input class=
"md-toggle" data-md-toggle=
"search" type=
"checkbox" id=
"__search" autocomplete=
"off">
61 <label class=
"md-overlay" for=
"__drawer"></label>
62 <div data-md-component=
"skip">
65 <a href=
"#javascript-helper-functions" class=
"md-skip">
70 <div data-md-component=
"announce">
72 <aside class=
"md-announce">
73 <div class=
"md-announce__inner md-grid md-typeset">
75 <a href=
"https://www.woltlab.com">Back to
<strong>woltlab.com
</strong></a>
82 <header class=
"md-header" data-md-component=
"header">
83 <nav class=
"md-header__inner md-grid" aria-label=
"Header">
84 <a href=
"../.." title=
"WoltLab Suite Documentation" class=
"md-header__button md-logo" aria-label=
"WoltLab Suite Documentation" data-md-component=
"logo">
86 <img src=
"../../assets/logo.png" alt=
"logo">
89 <label class=
"md-header__button md-icon" for=
"__drawer">
90 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"/></svg>
92 <div class=
"md-header__title" data-md-component=
"header-title">
93 <div class=
"md-header__ellipsis">
94 <div class=
"md-header__topic">
95 <span class=
"md-ellipsis">
96 WoltLab Suite Documentation
99 <div class=
"md-header__topic" data-md-component=
"header-topic">
100 <span class=
"md-ellipsis">
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>
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>
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.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>
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">
134 <ol class=
"md-search-result__list"></ol>
142 <div class=
"md-header__source">
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">
147 <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>
149 <div class=
"md-source__repository">
158 <div class=
"md-container" data-md-component=
"container">
163 <main class=
"md-main" data-md-component=
"main">
164 <div class=
"md-main__inner md-grid">
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">
174 <nav class=
"md-nav md-nav--primary" aria-label=
"Navigation" data-md-level=
"0">
175 <label class=
"md-nav__title" for=
"__drawer">
176 <a href=
"../.." title=
"WoltLab Suite Documentation" class=
"md-nav__button md-logo" aria-label=
"WoltLab Suite Documentation" data-md-component=
"logo">
178 <img src=
"../../assets/logo.png" alt=
"logo">
181 WoltLab Suite Documentation
184 <div class=
"md-nav__source">
186 <a href=
"https://github.com/WoltLab/docs.woltlab.com/" title=
"Go to repository" class=
"md-source" data-md-component=
"source">
187 <div class=
"md-source__icon md-icon">
189 <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>
191 <div class=
"md-source__repository">
197 <ul class=
"md-nav__list" data-md-scrollfix
>
206 <li class=
"md-nav__item">
207 <a href=
"../../getting-started/" class=
"md-nav__link">
222 <li class=
"md-nav__item md-nav__item--nested">
225 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2" type=
"checkbox" id=
"__nav_2" >
227 <label class=
"md-nav__link" for=
"__nav_2">
229 <span class=
"md-nav__icon md-icon"></span>
231 <nav class=
"md-nav" aria-label=
"PHP API" data-md-level=
"1">
232 <label class=
"md-nav__title" for=
"__nav_2">
233 <span class=
"md-nav__icon md-icon"></span>
236 <ul class=
"md-nav__list" data-md-scrollfix
>
242 <li class=
"md-nav__item">
243 <a href=
"../../php/pages/" class=
"md-nav__link">
254 <li class=
"md-nav__item">
255 <a href=
"../../php/database-objects/" class=
"md-nav__link">
266 <li class=
"md-nav__item">
267 <a href=
"../../php/database-access/" class=
"md-nav__link">
278 <li class=
"md-nav__item">
279 <a href=
"../../php/exceptions/" class=
"md-nav__link">
291 <li class=
"md-nav__item md-nav__item--nested">
294 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5" type=
"checkbox" id=
"__nav_2_5" >
296 <label class=
"md-nav__link" for=
"__nav_2_5">
298 <span class=
"md-nav__icon md-icon"></span>
300 <nav class=
"md-nav" aria-label=
"API" data-md-level=
"2">
301 <label class=
"md-nav__title" for=
"__nav_2_5">
302 <span class=
"md-nav__icon md-icon"></span>
305 <ul class=
"md-nav__list" data-md-scrollfix
>
312 <li class=
"md-nav__item md-nav__item--nested">
315 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5_1" type=
"checkbox" id=
"__nav_2_5_1" >
317 <label class=
"md-nav__link" for=
"__nav_2_5_1">
319 <span class=
"md-nav__icon md-icon"></span>
321 <nav class=
"md-nav" aria-label=
"Caches" data-md-level=
"3">
322 <label class=
"md-nav__title" for=
"__nav_2_5_1">
323 <span class=
"md-nav__icon md-icon"></span>
326 <ul class=
"md-nav__list" data-md-scrollfix
>
332 <li class=
"md-nav__item">
333 <a href=
"../../php/api/caches/" class=
"md-nav__link">
344 <li class=
"md-nav__item">
345 <a href=
"../../php/api/caches_persistent-caches/" class=
"md-nav__link">
356 <li class=
"md-nav__item">
357 <a href=
"../../php/api/caches_runtime-caches/" class=
"md-nav__link">
374 <li class=
"md-nav__item">
375 <a href=
"../../php/api/comments/" class=
"md-nav__link">
386 <li class=
"md-nav__item">
387 <a href=
"../../php/api/cronjobs/" class=
"md-nav__link">
398 <li class=
"md-nav__item">
399 <a href=
"../../php/api/events/" class=
"md-nav__link">
411 <li class=
"md-nav__item md-nav__item--nested">
414 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5_5" type=
"checkbox" id=
"__nav_2_5_5" >
416 <label class=
"md-nav__link" for=
"__nav_2_5_5">
418 <span class=
"md-nav__icon md-icon"></span>
420 <nav class=
"md-nav" aria-label=
"Form Builder" data-md-level=
"3">
421 <label class=
"md-nav__title" for=
"__nav_2_5_5">
422 <span class=
"md-nav__icon md-icon"></span>
425 <ul class=
"md-nav__list" data-md-scrollfix
>
431 <li class=
"md-nav__item">
432 <a href=
"../../php/api/form_builder/overview/" class=
"md-nav__link">
443 <li class=
"md-nav__item">
444 <a href=
"../../php/api/form_builder/structure/" class=
"md-nav__link">
455 <li class=
"md-nav__item">
456 <a href=
"../../php/api/form_builder/form_fields/" class=
"md-nav__link">
467 <li class=
"md-nav__item">
468 <a href=
"../../php/api/form_builder/validation_data/" class=
"md-nav__link">
479 <li class=
"md-nav__item">
480 <a href=
"../../php/api/form_builder/dependencies/" class=
"md-nav__link">
497 <li class=
"md-nav__item">
498 <a href=
"../../php/api/package_installation_plugins/" class=
"md-nav__link">
499 Package Installation Plugins
509 <li class=
"md-nav__item">
510 <a href=
"../../php/api/user_activity_points/" class=
"md-nav__link">
521 <li class=
"md-nav__item">
522 <a href=
"../../php/api/user_notifications/" class=
"md-nav__link">
533 <li class=
"md-nav__item">
534 <a href=
"../../php/api/sitemaps/" class=
"md-nav__link">
551 <li class=
"md-nav__item">
552 <a href=
"../../php/code-style/" class=
"md-nav__link">
563 <li class=
"md-nav__item">
564 <a href=
"../../php/apps/" class=
"md-nav__link">
575 <li class=
"md-nav__item">
576 <a href=
"../../php/gdpr/" class=
"md-nav__link">
597 <li class=
"md-nav__item md-nav__item--nested">
600 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_3" type=
"checkbox" id=
"__nav_3" >
602 <label class=
"md-nav__link" for=
"__nav_3">
603 Languages, Templates & CSS
604 <span class=
"md-nav__icon md-icon"></span>
606 <nav class=
"md-nav" aria-label=
"Languages, Templates & CSS" data-md-level=
"1">
607 <label class=
"md-nav__title" for=
"__nav_3">
608 <span class=
"md-nav__icon md-icon"></span>
609 Languages, Templates & CSS
611 <ul class=
"md-nav__list" data-md-scrollfix
>
617 <li class=
"md-nav__item">
618 <a href=
"../../view/languages/" class=
"md-nav__link">
629 <li class=
"md-nav__item">
630 <a href=
"../../view/templates/" class=
"md-nav__link">
641 <li class=
"md-nav__item">
642 <a href=
"../../view/template-plugins/" class=
"md-nav__link">
653 <li class=
"md-nav__item">
654 <a href=
"../../view/css/" class=
"md-nav__link">
677 <li class=
"md-nav__item md-nav__item--active md-nav__item--nested">
680 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4" type=
"checkbox" id=
"__nav_4" checked
>
682 <label class=
"md-nav__link" for=
"__nav_4">
683 TypeScript and JavaScript API
684 <span class=
"md-nav__icon md-icon"></span>
686 <nav class=
"md-nav" aria-label=
"TypeScript and JavaScript API" data-md-level=
"1">
687 <label class=
"md-nav__title" for=
"__nav_4">
688 <span class=
"md-nav__icon md-icon"></span>
689 TypeScript and JavaScript API
691 <ul class=
"md-nav__list" data-md-scrollfix
>
697 <li class=
"md-nav__item">
698 <a href=
"../general-usage/" class=
"md-nav__link">
709 <li class=
"md-nav__item">
710 <a href=
"../typescript/" class=
"md-nav__link">
722 <li class=
"md-nav__item md-nav__item--nested">
725 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4_3" type=
"checkbox" id=
"__nav_4_3" >
727 <label class=
"md-nav__link" for=
"__nav_4_3">
729 <span class=
"md-nav__icon md-icon"></span>
731 <nav class=
"md-nav" aria-label=
"New API" data-md-level=
"2">
732 <label class=
"md-nav__title" for=
"__nav_4_3">
733 <span class=
"md-nav__icon md-icon"></span>
736 <ul class=
"md-nav__list" data-md-scrollfix
>
742 <li class=
"md-nav__item">
743 <a href=
"../new-api_writing-a-module/" class=
"md-nav__link">
754 <li class=
"md-nav__item">
755 <a href=
"../new-api_data-structures/" class=
"md-nav__link">
766 <li class=
"md-nav__item">
767 <a href=
"../new-api_core/" class=
"md-nav__link">
778 <li class=
"md-nav__item">
779 <a href=
"../new-api_dom/" class=
"md-nav__link">
790 <li class=
"md-nav__item">
791 <a href=
"../new-api_events/" class=
"md-nav__link">
802 <li class=
"md-nav__item">
803 <a href=
"../new-api_ajax/" class=
"md-nav__link">
814 <li class=
"md-nav__item">
815 <a href=
"../new-api_dialogs/" class=
"md-nav__link">
826 <li class=
"md-nav__item">
827 <a href=
"../new-api_browser/" class=
"md-nav__link">
828 Browser and Screen Sizes
838 <li class=
"md-nav__item">
839 <a href=
"../new-api_ui/" class=
"md-nav__link">
856 <li class=
"md-nav__item">
857 <a href=
"../legacy-api/" class=
"md-nav__link">
870 <li class=
"md-nav__item md-nav__item--active">
872 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"toc" type=
"checkbox" id=
"__toc">
878 <label class=
"md-nav__link md-nav__link--active" for=
"__toc">
880 <span class=
"md-nav__icon md-icon"></span>
883 <a href=
"./" class=
"md-nav__link md-nav__link--active">
888 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
895 <label class=
"md-nav__title" for=
"__toc">
896 <span class=
"md-nav__icon md-icon"></span>
899 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
901 <li class=
"md-nav__item">
902 <a href=
"#introduction" class=
"md-nav__link">
908 <li class=
"md-nav__item">
909 <a href=
"#elements" class=
"md-nav__link">
913 <nav class=
"md-nav" aria-label=
"Elements">
914 <ul class=
"md-nav__list">
916 <li class=
"md-nav__item">
917 <a href=
"#elcreatetagname-string-element" class=
"md-nav__link">
918 elCreate(tagName: string): Element
923 <li class=
"md-nav__item">
924 <a href=
"#elremoveelement-element" class=
"md-nav__link">
925 elRemove(element: Element)
930 <li class=
"md-nav__item">
931 <a href=
"#elshowelement-element" class=
"md-nav__link">
932 elShow(element: Element)
937 <li class=
"md-nav__item">
938 <a href=
"#elhideelement-element" class=
"md-nav__link">
939 elHide(element: Element)
944 <li class=
"md-nav__item">
945 <a href=
"#eltoggleelement-element" class=
"md-nav__link">
946 elToggle(element: Element)
956 <li class=
"md-nav__item">
957 <a href=
"#attributes" class=
"md-nav__link">
961 <nav class=
"md-nav" aria-label=
"Attributes">
962 <ul class=
"md-nav__list">
964 <li class=
"md-nav__item">
965 <a href=
"#elattrelement-element-attribute-string-value-string-string" class=
"md-nav__link">
966 elAttr(element: Element, attribute: string, value?: string): string
971 <li class=
"md-nav__item">
972 <a href=
"#elattrboolelement-element-attribute-string-boolean" class=
"md-nav__link">
973 elAttrBool(element: Element, attribute: string): boolean
978 <li class=
"md-nav__item">
979 <a href=
"#eldataelement-element-attribute-string-value-string-string" class=
"md-nav__link">
980 elData(element: Element, attribute: string, value?: string): string
985 <li class=
"md-nav__item">
986 <a href=
"#eldataboolelement-element-attribute-string-boolean" class=
"md-nav__link">
987 elDataBool(element: Element, attribute: string): boolean
997 <li class=
"md-nav__item">
998 <a href=
"#selecting-elements" class=
"md-nav__link">
1002 <nav class=
"md-nav" aria-label=
"Selecting Elements">
1003 <ul class=
"md-nav__list">
1005 <li class=
"md-nav__item">
1006 <a href=
"#elbyidid-string-element-null" class=
"md-nav__link">
1007 elById(id: string): Element | null
1012 <li class=
"md-nav__item">
1013 <a href=
"#elbyselselector-string-context-element-element-null" class=
"md-nav__link">
1014 elBySel(selector: string, context?: Element): Element | null
1019 <li class=
"md-nav__item">
1020 <a href=
"#elbyselallselector-string-context-element-callback-element-element-void-nodelist" class=
"md-nav__link">
1021 elBySelAll(selector: string, context?: Element, callback: (element: Element) =
> void): NodeList
1024 <nav class=
"md-nav" aria-label=
"elBySelAll(selector: string, context?: Element, callback: (element: Element) => void): NodeList">
1025 <ul class=
"md-nav__list">
1027 <li class=
"md-nav__item">
1028 <a href=
"#callback-to-iterate-over-elements" class=
"md-nav__link">
1029 Callback to Iterate Over Elements
1039 <li class=
"md-nav__item">
1040 <a href=
"#elclosestelement-element-selector-string-element-null" class=
"md-nav__link">
1041 elClosest(element: Element, selector: string): Element | null
1044 <nav class=
"md-nav" aria-label=
"elClosest(element: Element, selector: string): Element | null">
1045 <ul class=
"md-nav__list">
1047 <li class=
"md-nav__item">
1048 <a href=
"#text-nodes" class=
"md-nav__link">
1059 <li class=
"md-nav__item">
1060 <a href=
"#elbyclassclassname-string-context-element-nodelist" class=
"md-nav__link">
1061 elByClass(className: string, context?: Element): NodeList
1066 <li class=
"md-nav__item">
1067 <a href=
"#elbytagtagname-string-context-element-nodelist" class=
"md-nav__link">
1068 elByTag(tagName: string, context?: Element): NodeList
1078 <li class=
"md-nav__item">
1079 <a href=
"#utility-functions" class=
"md-nav__link">
1083 <nav class=
"md-nav" aria-label=
"Utility Functions">
1084 <ul class=
"md-nav__list">
1086 <li class=
"md-nav__item">
1087 <a href=
"#elinnererrorelement-element-errormessage-string-ishtml-boolean-element-null" class=
"md-nav__link">
1088 `elInnerError(element: Element, errorMessage?: string, isHtml?: boolean): Element | null``
1098 <li class=
"md-nav__item">
1099 <a href=
"#string-extensions" class=
"md-nav__link">
1103 <nav class=
"md-nav" aria-label=
"String Extensions">
1104 <ul class=
"md-nav__list">
1106 <li class=
"md-nav__item">
1107 <a href=
"#hashcode-string" class=
"md-nav__link">
1130 <li class=
"md-nav__item">
1131 <a href=
"../code-snippets/" class=
"md-nav__link">
1152 <li class=
"md-nav__item md-nav__item--nested">
1155 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5" type=
"checkbox" id=
"__nav_5" >
1157 <label class=
"md-nav__link" for=
"__nav_5">
1159 <span class=
"md-nav__icon md-icon"></span>
1161 <nav class=
"md-nav" aria-label=
"Package Components" data-md-level=
"1">
1162 <label class=
"md-nav__title" for=
"__nav_5">
1163 <span class=
"md-nav__icon md-icon"></span>
1166 <ul class=
"md-nav__list" data-md-scrollfix
>
1172 <li class=
"md-nav__item">
1173 <a href=
"../../package/package-xml/" class=
"md-nav__link">
1185 <li class=
"md-nav__item md-nav__item--nested">
1188 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5_2" type=
"checkbox" id=
"__nav_5_2" >
1190 <label class=
"md-nav__link" for=
"__nav_5_2">
1192 <span class=
"md-nav__icon md-icon"></span>
1194 <nav class=
"md-nav" aria-label=
"PIPs" data-md-level=
"2">
1195 <label class=
"md-nav__title" for=
"__nav_5_2">
1196 <span class=
"md-nav__icon md-icon"></span>
1199 <ul class=
"md-nav__list" data-md-scrollfix
>
1205 <li class=
"md-nav__item">
1206 <a href=
"../../package/pip/" class=
"md-nav__link">
1217 <li class=
"md-nav__item">
1218 <a href=
"../../package/pip/acl-option/" class=
"md-nav__link">
1229 <li class=
"md-nav__item">
1230 <a href=
"../../package/pip/acp-menu/" class=
"md-nav__link">
1241 <li class=
"md-nav__item">
1242 <a href=
"../../package/pip/acp-search-provider/" class=
"md-nav__link">
1253 <li class=
"md-nav__item">
1254 <a href=
"../../package/pip/acp-template/" class=
"md-nav__link">
1265 <li class=
"md-nav__item">
1266 <a href=
"../../package/pip/bbcode/" class=
"md-nav__link">
1277 <li class=
"md-nav__item">
1278 <a href=
"../../package/pip/box/" class=
"md-nav__link">
1289 <li class=
"md-nav__item">
1290 <a href=
"../../package/pip/clipboard-action/" class=
"md-nav__link">
1301 <li class=
"md-nav__item">
1302 <a href=
"../../package/pip/core-object/" class=
"md-nav__link">
1313 <li class=
"md-nav__item">
1314 <a href=
"../../package/pip/cronjob/" class=
"md-nav__link">
1325 <li class=
"md-nav__item">
1326 <a href=
"../../package/pip/database/" class=
"md-nav__link">
1337 <li class=
"md-nav__item">
1338 <a href=
"../../package/pip/event-listener/" class=
"md-nav__link">
1349 <li class=
"md-nav__item">
1350 <a href=
"../../package/pip/file/" class=
"md-nav__link">
1361 <li class=
"md-nav__item">
1362 <a href=
"../../package/pip/language/" class=
"md-nav__link">
1373 <li class=
"md-nav__item">
1374 <a href=
"../../package/pip/media-provider/" class=
"md-nav__link">
1385 <li class=
"md-nav__item">
1386 <a href=
"../../package/pip/menu/" class=
"md-nav__link">
1397 <li class=
"md-nav__item">
1398 <a href=
"../../package/pip/menu-item/" class=
"md-nav__link">
1409 <li class=
"md-nav__item">
1410 <a href=
"../../package/pip/object-type/" class=
"md-nav__link">
1421 <li class=
"md-nav__item">
1422 <a href=
"../../package/pip/object-type-definition/" class=
"md-nav__link">
1423 objectTypeDefinition
1433 <li class=
"md-nav__item">
1434 <a href=
"../../package/pip/option/" class=
"md-nav__link">
1445 <li class=
"md-nav__item">
1446 <a href=
"../../package/pip/page/" class=
"md-nav__link">
1457 <li class=
"md-nav__item">
1458 <a href=
"../../package/pip/pip/" class=
"md-nav__link">
1469 <li class=
"md-nav__item">
1470 <a href=
"../../package/pip/script/" class=
"md-nav__link">
1481 <li class=
"md-nav__item">
1482 <a href=
"../../package/pip/smiley/" class=
"md-nav__link">
1493 <li class=
"md-nav__item">
1494 <a href=
"../../package/pip/sql/" class=
"md-nav__link">
1505 <li class=
"md-nav__item">
1506 <a href=
"../../package/pip/style/" class=
"md-nav__link">
1517 <li class=
"md-nav__item">
1518 <a href=
"../../package/pip/template/" class=
"md-nav__link">
1529 <li class=
"md-nav__item">
1530 <a href=
"../../package/pip/template-listener/" class=
"md-nav__link">
1541 <li class=
"md-nav__item">
1542 <a href=
"../../package/pip/user-group-option/" class=
"md-nav__link">
1553 <li class=
"md-nav__item">
1554 <a href=
"../../package/pip/user-menu/" class=
"md-nav__link">
1565 <li class=
"md-nav__item">
1566 <a href=
"../../package/pip/user-notification-event/" class=
"md-nav__link">
1567 userNotificationEvent
1577 <li class=
"md-nav__item">
1578 <a href=
"../../package/pip/user-option/" class=
"md-nav__link">
1589 <li class=
"md-nav__item">
1590 <a href=
"../../package/pip/user-profile-menu/" class=
"md-nav__link">
1607 <li class=
"md-nav__item">
1608 <a href=
"../../package/database-php-api/" class=
"md-nav__link">
1629 <li class=
"md-nav__item md-nav__item--nested">
1632 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6" type=
"checkbox" id=
"__nav_6" >
1634 <label class=
"md-nav__link" for=
"__nav_6">
1636 <span class=
"md-nav__icon md-icon"></span>
1638 <nav class=
"md-nav" aria-label=
"Migration" data-md-level=
"1">
1639 <label class=
"md-nav__title" for=
"__nav_6">
1640 <span class=
"md-nav__icon md-icon"></span>
1643 <ul class=
"md-nav__list" data-md-scrollfix
>
1650 <li class=
"md-nav__item md-nav__item--nested">
1653 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_1" type=
"checkbox" id=
"__nav_6_1" >
1655 <label class=
"md-nav__link" for=
"__nav_6_1">
1656 Migrating from WSC
5.3
1657 <span class=
"md-nav__icon md-icon"></span>
1659 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.3" data-md-level=
"2">
1660 <label class=
"md-nav__title" for=
"__nav_6_1">
1661 <span class=
"md-nav__icon md-icon"></span>
1662 Migrating from WSC
5.3
1664 <ul class=
"md-nav__list" data-md-scrollfix
>
1670 <li class=
"md-nav__item">
1671 <a href=
"../../migration/wsc53/php/" class=
"md-nav__link">
1682 <li class=
"md-nav__item">
1683 <a href=
"../../migration/wsc53/session/" class=
"md-nav__link">
1684 Session Handling and Authentication
1694 <li class=
"md-nav__item">
1695 <a href=
"../../migration/wsc53/javascript/" class=
"md-nav__link">
1696 TypeScript and JavaScript
1706 <li class=
"md-nav__item">
1707 <a href=
"../../migration/wsc53/templates/" class=
"md-nav__link">
1718 <li class=
"md-nav__item">
1719 <a href=
"../../migration/wsc53/libraries/" class=
"md-nav__link">
1720 Third Party Libraries
1737 <li class=
"md-nav__item md-nav__item--nested">
1740 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_2" type=
"checkbox" id=
"__nav_6_2" >
1742 <label class=
"md-nav__link" for=
"__nav_6_2">
1743 Migrating from WSC
5.2
1744 <span class=
"md-nav__icon md-icon"></span>
1746 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.2" data-md-level=
"2">
1747 <label class=
"md-nav__title" for=
"__nav_6_2">
1748 <span class=
"md-nav__icon md-icon"></span>
1749 Migrating from WSC
5.2
1751 <ul class=
"md-nav__list" data-md-scrollfix
>
1757 <li class=
"md-nav__item">
1758 <a href=
"../../migration/wsc52/php/" class=
"md-nav__link">
1769 <li class=
"md-nav__item">
1770 <a href=
"../../migration/wsc52/templates/" class=
"md-nav__link">
1771 Templates and Languages
1781 <li class=
"md-nav__item">
1782 <a href=
"../../migration/wsc52/libraries/" class=
"md-nav__link">
1783 Third Party Libraries
1800 <li class=
"md-nav__item md-nav__item--nested">
1803 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_3" type=
"checkbox" id=
"__nav_6_3" >
1805 <label class=
"md-nav__link" for=
"__nav_6_3">
1806 Migrating from WSC
3.1
1807 <span class=
"md-nav__icon md-icon"></span>
1809 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.1" data-md-level=
"2">
1810 <label class=
"md-nav__title" for=
"__nav_6_3">
1811 <span class=
"md-nav__icon md-icon"></span>
1812 Migrating from WSC
3.1
1814 <ul class=
"md-nav__list" data-md-scrollfix
>
1820 <li class=
"md-nav__item">
1821 <a href=
"../../migration/wsc31/php/" class=
"md-nav__link">
1839 <li class=
"md-nav__item md-nav__item--nested">
1842 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_4" type=
"checkbox" id=
"__nav_6_4" >
1844 <label class=
"md-nav__link" for=
"__nav_6_4">
1845 Migrating from WSC
3.0
1846 <span class=
"md-nav__icon md-icon"></span>
1848 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.0" data-md-level=
"2">
1849 <label class=
"md-nav__title" for=
"__nav_6_4">
1850 <span class=
"md-nav__icon md-icon"></span>
1851 Migrating from WSC
3.0
1853 <ul class=
"md-nav__list" data-md-scrollfix
>
1859 <li class=
"md-nav__item">
1860 <a href=
"../../migration/wsc30/php/" class=
"md-nav__link">
1871 <li class=
"md-nav__item">
1872 <a href=
"../../migration/wsc30/javascript/" class=
"md-nav__link">
1883 <li class=
"md-nav__item">
1884 <a href=
"../../migration/wsc30/templates/" class=
"md-nav__link">
1895 <li class=
"md-nav__item">
1896 <a href=
"../../migration/wsc30/css/" class=
"md-nav__link">
1907 <li class=
"md-nav__item">
1908 <a href=
"../../migration/wsc30/package/" class=
"md-nav__link">
1926 <li class=
"md-nav__item md-nav__item--nested">
1929 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_5" type=
"checkbox" id=
"__nav_6_5" >
1931 <label class=
"md-nav__link" for=
"__nav_6_5">
1932 Migrating from WCF
2.1
1933 <span class=
"md-nav__icon md-icon"></span>
1935 <nav class=
"md-nav" aria-label=
"Migrating from WCF 2.1" data-md-level=
"2">
1936 <label class=
"md-nav__title" for=
"__nav_6_5">
1937 <span class=
"md-nav__icon md-icon"></span>
1938 Migrating from WCF
2.1
1940 <ul class=
"md-nav__list" data-md-scrollfix
>
1946 <li class=
"md-nav__item">
1947 <a href=
"../../migration/wcf21/php/" class=
"md-nav__link">
1958 <li class=
"md-nav__item">
1959 <a href=
"../../migration/wcf21/templates/" class=
"md-nav__link">
1970 <li class=
"md-nav__item">
1971 <a href=
"../../migration/wcf21/css/" class=
"md-nav__link">
1982 <li class=
"md-nav__item">
1983 <a href=
"../../migration/wcf21/package/" class=
"md-nav__link">
2010 <li class=
"md-nav__item md-nav__item--nested">
2013 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7" type=
"checkbox" id=
"__nav_7" >
2015 <label class=
"md-nav__link" for=
"__nav_7">
2017 <span class=
"md-nav__icon md-icon"></span>
2019 <nav class=
"md-nav" aria-label=
"Tutorials" data-md-level=
"1">
2020 <label class=
"md-nav__title" for=
"__nav_7">
2021 <span class=
"md-nav__icon md-icon"></span>
2024 <ul class=
"md-nav__list" data-md-scrollfix
>
2031 <li class=
"md-nav__item md-nav__item--nested">
2034 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7_1" type=
"checkbox" id=
"__nav_7_1" >
2036 <label class=
"md-nav__link" for=
"__nav_7_1">
2038 <span class=
"md-nav__icon md-icon"></span>
2040 <nav class=
"md-nav" aria-label=
"Tutorial Series" data-md-level=
"2">
2041 <label class=
"md-nav__title" for=
"__nav_7_1">
2042 <span class=
"md-nav__icon md-icon"></span>
2045 <ul class=
"md-nav__list" data-md-scrollfix
>
2051 <li class=
"md-nav__item">
2052 <a href=
"../../tutorial/series/overview/" class=
"md-nav__link">
2063 <li class=
"md-nav__item">
2064 <a href=
"../../tutorial/series/part_1/" class=
"md-nav__link">
2075 <li class=
"md-nav__item">
2076 <a href=
"../../tutorial/series/part_2/" class=
"md-nav__link">
2087 <li class=
"md-nav__item">
2088 <a href=
"../../tutorial/series/part_3/" class=
"md-nav__link">
2099 <li class=
"md-nav__item">
2100 <a href=
"../../tutorial/series/part_4/" class=
"md-nav__link">
2111 <li class=
"md-nav__item">
2112 <a href=
"../../tutorial/series/part_5/" class=
"md-nav__link">
2139 <div class=
"md-sidebar md-sidebar--secondary" data-md-component=
"sidebar" data-md-type=
"toc" >
2140 <div class=
"md-sidebar__scrollwrap">
2141 <div class=
"md-sidebar__inner">
2143 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
2150 <label class=
"md-nav__title" for=
"__toc">
2151 <span class=
"md-nav__icon md-icon"></span>
2154 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
2156 <li class=
"md-nav__item">
2157 <a href=
"#introduction" class=
"md-nav__link">
2163 <li class=
"md-nav__item">
2164 <a href=
"#elements" class=
"md-nav__link">
2168 <nav class=
"md-nav" aria-label=
"Elements">
2169 <ul class=
"md-nav__list">
2171 <li class=
"md-nav__item">
2172 <a href=
"#elcreatetagname-string-element" class=
"md-nav__link">
2173 elCreate(tagName: string): Element
2178 <li class=
"md-nav__item">
2179 <a href=
"#elremoveelement-element" class=
"md-nav__link">
2180 elRemove(element: Element)
2185 <li class=
"md-nav__item">
2186 <a href=
"#elshowelement-element" class=
"md-nav__link">
2187 elShow(element: Element)
2192 <li class=
"md-nav__item">
2193 <a href=
"#elhideelement-element" class=
"md-nav__link">
2194 elHide(element: Element)
2199 <li class=
"md-nav__item">
2200 <a href=
"#eltoggleelement-element" class=
"md-nav__link">
2201 elToggle(element: Element)
2211 <li class=
"md-nav__item">
2212 <a href=
"#attributes" class=
"md-nav__link">
2216 <nav class=
"md-nav" aria-label=
"Attributes">
2217 <ul class=
"md-nav__list">
2219 <li class=
"md-nav__item">
2220 <a href=
"#elattrelement-element-attribute-string-value-string-string" class=
"md-nav__link">
2221 elAttr(element: Element, attribute: string, value?: string): string
2226 <li class=
"md-nav__item">
2227 <a href=
"#elattrboolelement-element-attribute-string-boolean" class=
"md-nav__link">
2228 elAttrBool(element: Element, attribute: string): boolean
2233 <li class=
"md-nav__item">
2234 <a href=
"#eldataelement-element-attribute-string-value-string-string" class=
"md-nav__link">
2235 elData(element: Element, attribute: string, value?: string): string
2240 <li class=
"md-nav__item">
2241 <a href=
"#eldataboolelement-element-attribute-string-boolean" class=
"md-nav__link">
2242 elDataBool(element: Element, attribute: string): boolean
2252 <li class=
"md-nav__item">
2253 <a href=
"#selecting-elements" class=
"md-nav__link">
2257 <nav class=
"md-nav" aria-label=
"Selecting Elements">
2258 <ul class=
"md-nav__list">
2260 <li class=
"md-nav__item">
2261 <a href=
"#elbyidid-string-element-null" class=
"md-nav__link">
2262 elById(id: string): Element | null
2267 <li class=
"md-nav__item">
2268 <a href=
"#elbyselselector-string-context-element-element-null" class=
"md-nav__link">
2269 elBySel(selector: string, context?: Element): Element | null
2274 <li class=
"md-nav__item">
2275 <a href=
"#elbyselallselector-string-context-element-callback-element-element-void-nodelist" class=
"md-nav__link">
2276 elBySelAll(selector: string, context?: Element, callback: (element: Element) =
> void): NodeList
2279 <nav class=
"md-nav" aria-label=
"elBySelAll(selector: string, context?: Element, callback: (element: Element) => void): NodeList">
2280 <ul class=
"md-nav__list">
2282 <li class=
"md-nav__item">
2283 <a href=
"#callback-to-iterate-over-elements" class=
"md-nav__link">
2284 Callback to Iterate Over Elements
2294 <li class=
"md-nav__item">
2295 <a href=
"#elclosestelement-element-selector-string-element-null" class=
"md-nav__link">
2296 elClosest(element: Element, selector: string): Element | null
2299 <nav class=
"md-nav" aria-label=
"elClosest(element: Element, selector: string): Element | null">
2300 <ul class=
"md-nav__list">
2302 <li class=
"md-nav__item">
2303 <a href=
"#text-nodes" class=
"md-nav__link">
2314 <li class=
"md-nav__item">
2315 <a href=
"#elbyclassclassname-string-context-element-nodelist" class=
"md-nav__link">
2316 elByClass(className: string, context?: Element): NodeList
2321 <li class=
"md-nav__item">
2322 <a href=
"#elbytagtagname-string-context-element-nodelist" class=
"md-nav__link">
2323 elByTag(tagName: string, context?: Element): NodeList
2333 <li class=
"md-nav__item">
2334 <a href=
"#utility-functions" class=
"md-nav__link">
2338 <nav class=
"md-nav" aria-label=
"Utility Functions">
2339 <ul class=
"md-nav__list">
2341 <li class=
"md-nav__item">
2342 <a href=
"#elinnererrorelement-element-errormessage-string-ishtml-boolean-element-null" class=
"md-nav__link">
2343 `elInnerError(element: Element, errorMessage?: string, isHtml?: boolean): Element | null``
2353 <li class=
"md-nav__item">
2354 <a href=
"#string-extensions" class=
"md-nav__link">
2358 <nav class=
"md-nav" aria-label=
"String Extensions">
2359 <ul class=
"md-nav__list">
2361 <li class=
"md-nav__item">
2362 <a href=
"#hashcode-string" class=
"md-nav__link">
2381 <div class=
"md-content" data-md-component=
"content">
2382 <article class=
"md-content__inner md-typeset">
2385 <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">
2386 <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>
2390 <h1 id=
"javascript-helper-functions">JavaScript Helper Functions
<a class=
"headerlink" href=
"#javascript-helper-functions" title=
"Permanent link">#
</a></h1>
2391 <h2 id=
"introduction">Introduction
<a class=
"headerlink" href=
"#introduction" title=
"Permanent link">#
</a></h2>
2392 <p>Since version
3.0, WoltLab Suite ships with a set of global helper functions that are
2393 exposed on the
<code>window
</code>-object and thus are available regardless of the context.
2394 They are meant to reduce code repetition and to increase readability by moving
2395 potentially relevant parts to the front of an instruction.
</p>
2396 <h2 id=
"elements">Elements
<a class=
"headerlink" href=
"#elements" title=
"Permanent link">#
</a></h2>
2397 <h3 id=
"elcreatetagname-string-element"><code>elCreate(tagName: string): Element
</code><a class=
"headerlink" href=
"#elcreatetagname-string-element" title=
"Permanent link">#
</a></h3>
2398 <p>Creates a new element with the provided tag name.
</p>
2399 <table class=
"highlighttable"><tr><td class=
"linenos"><div class=
"linenodiv"><pre><span></span><span class=
"normal">1</span>
2400 <span class=
"normal">2</span>
2401 <span class=
"normal">3</span></pre></div></td><td class=
"code"><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>
2402 <span class=
"c1">// equals
</span>
2403 <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>
2406 <h3 id=
"elremoveelement-element"><code>elRemove(element: Element)
</code><a class=
"headerlink" href=
"#elremoveelement-element" title=
"Permanent link">#
</a></h3>
2407 <p>Removes an element from its parent without returning it. This function will throw
2408 an error if the
<code>element
</code> doesn't have a parent node.
</p>
2409 <table class=
"highlighttable"><tr><td class=
"linenos"><div class=
"linenodiv"><pre><span></span><span class=
"normal">1</span>
2410 <span class=
"normal">2</span>
2411 <span class=
"normal">3</span></pre></div></td><td class=
"code"><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>
2412 <span class=
"c1">// equals
</span>
2413 <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>
2416 <h3 id=
"elshowelement-element"><code>elShow(element: Element)
</code><a class=
"headerlink" href=
"#elshowelement-element" title=
"Permanent link">#
</a></h3>
2417 <p>Attempts to show an element by removing the
<code>display
</code> CSS-property, usually used
2418 in conjunction with the
<code>elHide()
</code> function.
</p>
2419 <table class=
"highlighttable"><tr><td class=
"linenos"><div class=
"linenodiv"><pre><span></span><span class=
"normal">1</span>
2420 <span class=
"normal">2</span>
2421 <span class=
"normal">3</span></pre></div></td><td class=
"code"><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>
2422 <span class=
"c1">// equals
</span>
2423 <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>
2426 <h3 id=
"elhideelement-element"><code>elHide(element: Element)
</code><a class=
"headerlink" href=
"#elhideelement-element" title=
"Permanent link">#
</a></h3>
2427 <p>Attempts to hide an element by setting the
<code>display
</code> CSS-property to
<code>none
</code>, this
2428 is intended to be used with
<code>elShow()
</code> that relies on this behavior.
</p>
2429 <table class=
"highlighttable"><tr><td class=
"linenos"><div class=
"linenodiv"><pre><span></span><span class=
"normal">1</span>
2430 <span class=
"normal">2</span>
2431 <span class=
"normal">3</span></pre></div></td><td class=
"code"><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>
2432 <span class=
"c1">// equals
</span>
2433 <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>
2436 <h3 id=
"eltoggleelement-element"><code>elToggle(element: Element)
</code><a class=
"headerlink" href=
"#eltoggleelement-element" title=
"Permanent link">#
</a></h3>
2437 <p>Attempts to toggle the visibility of an element by examining the value of the
2438 <code>display
</code> CSS-property and calls either
<code>elShow()
</code> or
<code>elHide()
</code>.
</p>
2439 <h2 id=
"attributes">Attributes
<a class=
"headerlink" href=
"#attributes" title=
"Permanent link">#
</a></h2>
2440 <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>
2441 <p>Sets or reads an attribute value, value are implicitly casted into strings and
2442 reading non-existing attributes will always yield an empty string. If you want
2443 to test for attribute existence, you'll have to fall-back to the native
2444 <a href=
"https://developer.mozilla.org/en-US/docs/Web/API/Element/hasAttribute"><code>Element.hasAttribute()
</code></a>
2446 <p>You should read and set native attributes directly, such as
<code>img.src
</code> rather
2447 than
<code>img.getAttribute(
"src");
</code>.
</p>
2448 <table class=
"highlighttable"><tr><td class=
"linenos"><div class=
"linenodiv"><pre><span></span><span class=
"normal">1</span>
2449 <span class=
"normal">2</span>
2450 <span class=
"normal">3</span>
2451 <span class=
"normal">4</span>
2452 <span class=
"normal">5</span>
2453 <span class=
"normal">6</span>
2454 <span class=
"normal">7</span></pre></div></td><td class=
"code"><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>
2455 <span class=
"c1">// equals
</span>
2456 <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>
2458 <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>
2459 <span class=
"c1">// equals
</span>
2460 <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>
2463 <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>
2464 <p>Reads an attribute and converts it value into a boolean value, the strings
<code>"1"</code>
2465 and
<code>"true"</code> will evaluate to
<code>true
</code>. All other values, including a missing attribute,
2466 will return
<code>false
</code>.
</p>
2467 <table class=
"highlighttable"><tr><td class=
"linenos"><div class=
"linenodiv"><pre><span></span><span class=
"normal">1</span>
2468 <span class=
"normal">2</span>
2469 <span class=
"normal">3</span></pre></div></td><td class=
"code"><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>
2470 <span class=
"c1">// attribute is true-ish
</span>
2471 <span class=
"p">}
</span>
2474 <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>
2475 <p>Short-hand function to read or set HTML5
<code>data-*
</code>-attributes, it essentially
2476 prepends the
<code>data-
</code> prefix before forwarding the call to
<code>elAttr()
</code>.
</p>
2477 <table class=
"highlighttable"><tr><td class=
"linenos"><div class=
"linenodiv"><pre><span></span><span class=
"normal">1</span>
2478 <span class=
"normal">2</span>
2479 <span class=
"normal">3</span>
2480 <span class=
"normal">4</span>
2481 <span class=
"normal">5</span>
2482 <span class=
"normal">6</span>
2483 <span class=
"normal">7</span></pre></div></td><td class=
"code"><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>
2484 <span class=
"c1">// equals
</span>
2485 <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>
2487 <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>
2488 <span class=
"c1">// equals
</span>
2489 <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>
2492 <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>
2493 <p>Short-hand function to convert a HTML5
<code>data-*
</code>-attribute into a boolean value. It
2494 prepends the
<code>data-
</code> prefix before forwarding the call to
<code>elAttrBool()
</code>.
</p>
2495 <table class=
"highlighttable"><tr><td class=
"linenos"><div class=
"linenodiv"><pre><span></span><span class=
"normal">1</span>
2496 <span class=
"normal">2</span>
2497 <span class=
"normal">3</span>
2498 <span class=
"normal">4</span>
2499 <span class=
"normal">5</span>
2500 <span class=
"normal">6</span>
2501 <span class=
"normal">7</span></pre></div></td><td class=
"code"><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>
2502 <span class=
"c1">// attribute is true-ish
</span>
2503 <span class=
"p">}
</span>
2504 <span class=
"c1">// equals
</span>
2505 <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>
2506 <span class=
"c1">// attribute is true-ish
</span>
2507 <span class=
"p">}
</span>
2510 <h2 id=
"selecting-elements">Selecting Elements
<a class=
"headerlink" href=
"#selecting-elements" title=
"Permanent link">#
</a></h2>
2511 <div class=
"admonition warning">
2512 <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>
2514 <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>
2515 <p>Selects an element by its
<code>id
</code>-attribute value.
</p>
2516 <table class=
"highlighttable"><tr><td class=
"linenos"><div class=
"linenodiv"><pre><span></span><span class=
"normal">1</span>
2517 <span class=
"normal">2</span>
2518 <span class=
"normal">3</span></pre></div></td><td class=
"code"><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>
2519 <span class=
"c1">// equals
</span>
2520 <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>
2523 <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>
2524 <div class=
"admonition danger">
2525 <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>
2527 <p>Select a single element based on a CSS selector, optionally limiting the results
2528 to be a direct or indirect children of the context element.
</p>
2529 <table class=
"highlighttable"><tr><td class=
"linenos"><div class=
"linenodiv"><pre><span></span><span class=
"normal">1</span>
2530 <span class=
"normal">2</span>
2531 <span class=
"normal">3</span>
2532 <span class=
"normal">4</span>
2533 <span class=
"normal">5</span>
2534 <span class=
"normal">6</span>
2535 <span class=
"normal">7</span>
2536 <span class=
"normal">8</span></pre></div></td><td class=
"code"><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>
2537 <span class=
"c1">// equals
</span>
2538 <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>
2540 <span class=
"c1">// limiting the scope to a context element:
</span>
2541 <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>
2542 <span class=
"c1">// equals
</span>
2543 <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>
2546 <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>
2547 <div class=
"admonition danger">
2548 <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>
2550 <p>Finds and returns a
<code>NodeList
</code> containing all elements that match the provided
2551 CSS selector. Although
<code>NodeList
</code> is an array-like structure, it is not possible
2552 to iterate over it using array functions, including
<code>.forEach()
</code> which is not
2553 available in Internet Explorer
11.
</p>
2554 <table class=
"highlighttable"><tr><td class=
"linenos"><div class=
"linenodiv"><pre><span></span><span class=
"normal">1</span>
2555 <span class=
"normal">2</span>
2556 <span class=
"normal">3</span>
2557 <span class=
"normal">4</span>
2558 <span class=
"normal">5</span>
2559 <span class=
"normal">6</span>
2560 <span class=
"normal">7</span>
2561 <span class=
"normal">8</span></pre></div></td><td class=
"code"><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>
2562 <span class=
"c1">// equals
</span>
2563 <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>
2565 <span class=
"c1">// limiting the scope to a context element:
</span>
2566 <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>
2567 <span class=
"c1">// equals
</span>
2568 <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>
2571 <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>
2572 <p><code>elBySelAll()
</code> supports an optional third parameter that expects a callback function
2573 that is invoked for every element in the list.
</p>
2574 <table class=
"highlighttable"><tr><td class=
"linenos"><div class=
"linenodiv"><pre><span></span><span class=
"normal">1</span>
2575 <span class=
"normal">2</span>
2576 <span class=
"normal">3</span>
2577 <span class=
"normal">4</span>
2578 <span class=
"normal">5</span>
2579 <span class=
"normal">6</span>
2580 <span class=
"normal">7</span>
2581 <span class=
"normal">8</span>
2582 <span class=
"normal">9</span></pre></div></td><td class=
"code"><div class=
"highlight"><pre><span></span><code><span class=
"c1">// set the
2nd parameter to `undefined` or `null` to query the whole document
</span>
2583 <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>
2584 <span class=
"c1">// is called for each element
</span>
2585 <span class=
"p">});
</span>
2587 <span class=
"c1">// limiting the scope to a context element:
</span>
2588 <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>
2589 <span class=
"c1">// is called for each element
</span>
2590 <span class=
"p">});
</span>
2593 <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>
2594 <p>Returns the first
<code>Element
</code> that matches the provided CSS selector, this will
2595 return the provided element itself if it matches the selector.
</p>
2596 <table class=
"highlighttable"><tr><td class=
"linenos"><div class=
"linenodiv"><pre><span></span><span class=
"normal">1</span>
2597 <span class=
"normal">2</span>
2598 <span class=
"normal">3</span></pre></div></td><td class=
"code"><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>
2599 <span class=
"c1">// equals
</span>
2600 <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>
2603 <h4 id=
"text-nodes">Text Nodes
<a class=
"headerlink" href=
"#text-nodes" title=
"Permanent link">#
</a></h4>
2604 <p>If the provided context is a
<code>Text
</code>-node, the function will move the context to
2605 the parent element before applying the CSS selector. If the
<code>Text
</code> has no parent,
2606 <code>null
</code> is returned without evaluating the selector.
</p>
2607 <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>
2608 <p>Returns a live
<code>NodeList
</code> containing all elements that match the provided CSS
2609 class now
<em>and
</em> in the future! The collection is automatically updated whenever
2610 an element with that class is added or removed from the DOM, it will also include
2611 elements that get dynamically assigned or removed this CSS class.
</p>
2612 <p>You absolutely need to understand that this collection is dynamic, that means that
2613 elements can and will be added and removed from the collection
<em>even while
</em> you
2614 iterate over it. There are only very few cases where you would need such a collection,
2615 almost always
<code>elBySelAll()
</code> is what you're looking for.
</p>
2616 <table class=
"highlighttable"><tr><td class=
"linenos"><div class=
"linenodiv"><pre><span></span><span class=
"normal">1</span>
2617 <span class=
"normal">2</span>
2618 <span class=
"normal">3</span>
2619 <span class=
"normal">4</span>
2620 <span class=
"normal">5</span>
2621 <span class=
"normal">6</span>
2622 <span class=
"normal">7</span>
2623 <span class=
"normal">8</span>
2624 <span class=
"normal">9</span></pre></div></td><td class=
"code"><div class=
"highlight"><pre><span></span><code><span class=
"c1">// no leading dot!
</span>
2625 <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>
2626 <span class=
"c1">// equals
</span>
2627 <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>
2629 <span class=
"c1">// limiting the scope to a context element:
</span>
2630 <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>
2631 <span class=
"c1">// equals
</span>
2632 <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>
2635 <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>
2636 <p>Returns a live
<code>NodeList
</code> containing all elements with the provided tag name now
2637 <em>and
</em> in the future! Please read the remarks on
<code>elByClass()
</code> above to understand
2638 the implications of this.
</p>
2639 <table class=
"highlighttable"><tr><td class=
"linenos"><div class=
"linenodiv"><pre><span></span><span class=
"normal">1</span>
2640 <span class=
"normal">2</span>
2641 <span class=
"normal">3</span>
2642 <span class=
"normal">4</span>
2643 <span class=
"normal">5</span>
2644 <span class=
"normal">6</span>
2645 <span class=
"normal">7</span>
2646 <span class=
"normal">8</span></pre></div></td><td class=
"code"><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>
2647 <span class=
"c1">// equals
</span>
2648 <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>
2650 <span class=
"c1">// limiting the scope to a context element:
</span>
2651 <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>
2652 <span class=
"c1">// equals
</span>
2653 <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>
2656 <h2 id=
"utility-functions">Utility Functions
<a class=
"headerlink" href=
"#utility-functions" title=
"Permanent link">#
</a></h2>
2657 <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>
2658 <p>Unified function to display and remove inline error messages for input elements,
2659 please read the
<a href=
"../../migration/wsc30/javascript/#helper-function-for-inline-error-messages">section in the migration docs
</a>
2660 to learn more about this function.
</p>
2661 <h2 id=
"string-extensions">String Extensions
<a class=
"headerlink" href=
"#string-extensions" title=
"Permanent link">#
</a></h2>
2662 <h3 id=
"hashcode-string"><code>hashCode(): string
</code><a class=
"headerlink" href=
"#hashcode-string" title=
"Permanent link">#
</a></h3>
2663 <p>Computes a numeric hash value of a string similar to Java's
<code>String.hashCode()
</code> method.
</p>
2664 <table class=
"highlighttable"><tr><td class=
"linenos"><div class=
"linenodiv"><pre><span></span><span class=
"normal">1</span>
2665 <span class=
"normal">2</span></pre></div></td><td class=
"code"><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>
2666 <span class=
"c1">// outputs: -
862545276</span>
2674 <div class=
"md-source-date">
2677 Last update:
2021-
01-
08
2696 <footer class=
"md-footer">
2698 <nav class=
"md-footer__inner md-grid" aria-label=
"Footer">
2700 <a href=
"../legacy-api/" class=
"md-footer__link md-footer__link--prev" rel=
"prev">
2701 <div class=
"md-footer__button md-icon">
2702 <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>
2704 <div class=
"md-footer__title">
2705 <div class=
"md-ellipsis">
2706 <span class=
"md-footer__direction">
2715 <a href=
"../code-snippets/" class=
"md-footer__link md-footer__link--next" rel=
"next">
2716 <div class=
"md-footer__title">
2717 <div class=
"md-ellipsis">
2718 <span class=
"md-footer__direction">
2724 <div class=
"md-footer__button md-icon">
2725 <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>
2731 <div class=
"md-footer-meta md-typeset">
2732 <div class=
"md-footer-meta__inner md-grid">
2733 <div class=
"md-footer-copyright">
2735 <div class=
"md-footer-copyright__highlight">
2736 Copyright ©
2020 WoltLab GmbH
2740 <a href=
"https://squidfunk.github.io/mkdocs-material/" target=
"_blank" rel=
"noopener">
2745 <div class=
"md-footer-copyright">
2746 <a href=
"https://www.woltlab.com/legal-notice/">Legal Notice
</a>
2747 <a href=
"https://www.woltlab.com/privacy-policy/">Privacy Policy
</a>
2754 <div class=
"md-dialog" data-md-component=
"dialog">
2755 <div class=
"md-dialog__inner md-typeset"></div>
2757 <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>
2760 <script src=
"../../assets/javascripts/bundle.4ea5477f.min.js"></script>