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>DOM - 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=
"#working-with-the-dom-javascript-api" 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">
722 <li class=
"md-nav__item md-nav__item--active md-nav__item--nested">
725 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4_3" type=
"checkbox" id=
"__nav_4_3" checked
>
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">
780 <li class=
"md-nav__item md-nav__item--active">
782 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"toc" type=
"checkbox" id=
"__toc">
787 <label class=
"md-nav__link md-nav__link--active" for=
"__toc">
789 <span class=
"md-nav__icon md-icon"></span>
792 <a href=
"./" class=
"md-nav__link md-nav__link--active">
797 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
803 <label class=
"md-nav__title" for=
"__toc">
804 <span class=
"md-nav__icon md-icon"></span>
807 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
809 <li class=
"md-nav__item">
810 <a href=
"#helper-functions" class=
"md-nav__link">
816 <li class=
"md-nav__item">
817 <a href=
"#domutil" class=
"md-nav__link">
821 <nav class=
"md-nav" aria-label=
"Dom/Util">
822 <ul class=
"md-nav__list">
824 <li class=
"md-nav__item">
825 <a href=
"#createfragmentfromhtmlhtml-string-documentfragment" class=
"md-nav__link">
826 createFragmentFromHtml(html: string): DocumentFragment
831 <li class=
"md-nav__item">
832 <a href=
"#identifyelement-element-string" class=
"md-nav__link">
833 identify(element: Element): string
838 <li class=
"md-nav__item">
839 <a href=
"#outerheightelement-element-styles-cssstyledeclaration-number" class=
"md-nav__link">
840 outerHeight(element: Element, styles?: CSSStyleDeclaration): number
845 <li class=
"md-nav__item">
846 <a href=
"#outerwidthelement-element-styles-cssstyledeclaration-number" class=
"md-nav__link">
847 outerWidth(element: Element, styles?: CSSStyleDeclaration): number
852 <li class=
"md-nav__item">
853 <a href=
"#outerdimensionselement-element-height-number-width-number" class=
"md-nav__link">
854 outerDimensions(element: Element): { height: number, width: number }
859 <li class=
"md-nav__item">
860 <a href=
"#offsetelement-element-top-number-left-number" class=
"md-nav__link">
861 offset(element: Element): { top: number, left: number }
866 <li class=
"md-nav__item">
867 <a href=
"#setinnerhtmlelement-element-innerhtml-string" class=
"md-nav__link">
868 setInnerHtml(element: Element, innerHtml: string)
873 <li class=
"md-nav__item">
874 <a href=
"#containselement-element-child-element-boolean" class=
"md-nav__link">
875 contains(element: Element, child: Element): boolean
880 <li class=
"md-nav__item">
881 <a href=
"#unwrapchildnodeselement-element" class=
"md-nav__link">
882 unwrapChildNodes(element: Element)
892 <li class=
"md-nav__item">
893 <a href=
"#domchangelistener" class=
"md-nav__link">
911 <li class=
"md-nav__item">
912 <a href=
"../new-api_events/" class=
"md-nav__link">
923 <li class=
"md-nav__item">
924 <a href=
"../new-api_ajax/" class=
"md-nav__link">
935 <li class=
"md-nav__item">
936 <a href=
"../new-api_dialogs/" class=
"md-nav__link">
947 <li class=
"md-nav__item">
948 <a href=
"../new-api_browser/" class=
"md-nav__link">
949 Browser and Screen Sizes
959 <li class=
"md-nav__item">
960 <a href=
"../new-api_ui/" class=
"md-nav__link">
977 <li class=
"md-nav__item">
978 <a href=
"../legacy-api/" class=
"md-nav__link">
989 <li class=
"md-nav__item">
990 <a href=
"../helper-functions/" class=
"md-nav__link">
1001 <li class=
"md-nav__item">
1002 <a href=
"../code-snippets/" class=
"md-nav__link">
1023 <li class=
"md-nav__item md-nav__item--nested">
1026 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5" type=
"checkbox" id=
"__nav_5" >
1028 <label class=
"md-nav__link" for=
"__nav_5">
1030 <span class=
"md-nav__icon md-icon"></span>
1032 <nav class=
"md-nav" aria-label=
"Package Components" data-md-level=
"1">
1033 <label class=
"md-nav__title" for=
"__nav_5">
1034 <span class=
"md-nav__icon md-icon"></span>
1037 <ul class=
"md-nav__list" data-md-scrollfix
>
1043 <li class=
"md-nav__item">
1044 <a href=
"../../package/package-xml/" class=
"md-nav__link">
1056 <li class=
"md-nav__item md-nav__item--nested">
1059 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5_2" type=
"checkbox" id=
"__nav_5_2" >
1061 <label class=
"md-nav__link" for=
"__nav_5_2">
1063 <span class=
"md-nav__icon md-icon"></span>
1065 <nav class=
"md-nav" aria-label=
"PIPs" data-md-level=
"2">
1066 <label class=
"md-nav__title" for=
"__nav_5_2">
1067 <span class=
"md-nav__icon md-icon"></span>
1070 <ul class=
"md-nav__list" data-md-scrollfix
>
1076 <li class=
"md-nav__item">
1077 <a href=
"../../package/pip/" class=
"md-nav__link">
1088 <li class=
"md-nav__item">
1089 <a href=
"../../package/pip/acl-option/" class=
"md-nav__link">
1100 <li class=
"md-nav__item">
1101 <a href=
"../../package/pip/acp-menu/" class=
"md-nav__link">
1112 <li class=
"md-nav__item">
1113 <a href=
"../../package/pip/acp-search-provider/" class=
"md-nav__link">
1124 <li class=
"md-nav__item">
1125 <a href=
"../../package/pip/acp-template/" class=
"md-nav__link">
1136 <li class=
"md-nav__item">
1137 <a href=
"../../package/pip/bbcode/" class=
"md-nav__link">
1148 <li class=
"md-nav__item">
1149 <a href=
"../../package/pip/box/" class=
"md-nav__link">
1160 <li class=
"md-nav__item">
1161 <a href=
"../../package/pip/clipboard-action/" class=
"md-nav__link">
1172 <li class=
"md-nav__item">
1173 <a href=
"../../package/pip/core-object/" class=
"md-nav__link">
1184 <li class=
"md-nav__item">
1185 <a href=
"../../package/pip/cronjob/" class=
"md-nav__link">
1196 <li class=
"md-nav__item">
1197 <a href=
"../../package/pip/database/" class=
"md-nav__link">
1208 <li class=
"md-nav__item">
1209 <a href=
"../../package/pip/event-listener/" class=
"md-nav__link">
1220 <li class=
"md-nav__item">
1221 <a href=
"../../package/pip/file/" class=
"md-nav__link">
1232 <li class=
"md-nav__item">
1233 <a href=
"../../package/pip/language/" class=
"md-nav__link">
1244 <li class=
"md-nav__item">
1245 <a href=
"../../package/pip/media-provider/" class=
"md-nav__link">
1256 <li class=
"md-nav__item">
1257 <a href=
"../../package/pip/menu/" class=
"md-nav__link">
1268 <li class=
"md-nav__item">
1269 <a href=
"../../package/pip/menu-item/" class=
"md-nav__link">
1280 <li class=
"md-nav__item">
1281 <a href=
"../../package/pip/object-type/" class=
"md-nav__link">
1292 <li class=
"md-nav__item">
1293 <a href=
"../../package/pip/object-type-definition/" class=
"md-nav__link">
1294 objectTypeDefinition
1304 <li class=
"md-nav__item">
1305 <a href=
"../../package/pip/option/" class=
"md-nav__link">
1316 <li class=
"md-nav__item">
1317 <a href=
"../../package/pip/page/" class=
"md-nav__link">
1328 <li class=
"md-nav__item">
1329 <a href=
"../../package/pip/pip/" class=
"md-nav__link">
1340 <li class=
"md-nav__item">
1341 <a href=
"../../package/pip/script/" class=
"md-nav__link">
1352 <li class=
"md-nav__item">
1353 <a href=
"../../package/pip/smiley/" class=
"md-nav__link">
1364 <li class=
"md-nav__item">
1365 <a href=
"../../package/pip/sql/" class=
"md-nav__link">
1376 <li class=
"md-nav__item">
1377 <a href=
"../../package/pip/style/" class=
"md-nav__link">
1388 <li class=
"md-nav__item">
1389 <a href=
"../../package/pip/template/" class=
"md-nav__link">
1400 <li class=
"md-nav__item">
1401 <a href=
"../../package/pip/template-listener/" class=
"md-nav__link">
1412 <li class=
"md-nav__item">
1413 <a href=
"../../package/pip/user-group-option/" class=
"md-nav__link">
1424 <li class=
"md-nav__item">
1425 <a href=
"../../package/pip/user-menu/" class=
"md-nav__link">
1436 <li class=
"md-nav__item">
1437 <a href=
"../../package/pip/user-notification-event/" class=
"md-nav__link">
1438 userNotificationEvent
1448 <li class=
"md-nav__item">
1449 <a href=
"../../package/pip/user-option/" class=
"md-nav__link">
1460 <li class=
"md-nav__item">
1461 <a href=
"../../package/pip/user-profile-menu/" class=
"md-nav__link">
1478 <li class=
"md-nav__item">
1479 <a href=
"../../package/database-php-api/" class=
"md-nav__link">
1500 <li class=
"md-nav__item md-nav__item--nested">
1503 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6" type=
"checkbox" id=
"__nav_6" >
1505 <label class=
"md-nav__link" for=
"__nav_6">
1507 <span class=
"md-nav__icon md-icon"></span>
1509 <nav class=
"md-nav" aria-label=
"Migration" data-md-level=
"1">
1510 <label class=
"md-nav__title" for=
"__nav_6">
1511 <span class=
"md-nav__icon md-icon"></span>
1514 <ul class=
"md-nav__list" data-md-scrollfix
>
1521 <li class=
"md-nav__item md-nav__item--nested">
1524 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_1" type=
"checkbox" id=
"__nav_6_1" >
1526 <label class=
"md-nav__link" for=
"__nav_6_1">
1527 Migrating from WSC
5.3
1528 <span class=
"md-nav__icon md-icon"></span>
1530 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.3" data-md-level=
"2">
1531 <label class=
"md-nav__title" for=
"__nav_6_1">
1532 <span class=
"md-nav__icon md-icon"></span>
1533 Migrating from WSC
5.3
1535 <ul class=
"md-nav__list" data-md-scrollfix
>
1541 <li class=
"md-nav__item">
1542 <a href=
"../../migration/wsc53/php/" class=
"md-nav__link">
1553 <li class=
"md-nav__item">
1554 <a href=
"../../migration/wsc53/session/" class=
"md-nav__link">
1555 Session Handling and Authentication
1565 <li class=
"md-nav__item">
1566 <a href=
"../../migration/wsc53/javascript/" class=
"md-nav__link">
1567 TypeScript and JavaScript
1577 <li class=
"md-nav__item">
1578 <a href=
"../../migration/wsc53/templates/" class=
"md-nav__link">
1589 <li class=
"md-nav__item">
1590 <a href=
"../../migration/wsc53/libraries/" class=
"md-nav__link">
1591 Third Party Libraries
1608 <li class=
"md-nav__item md-nav__item--nested">
1611 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_2" type=
"checkbox" id=
"__nav_6_2" >
1613 <label class=
"md-nav__link" for=
"__nav_6_2">
1614 Migrating from WSC
5.2
1615 <span class=
"md-nav__icon md-icon"></span>
1617 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.2" data-md-level=
"2">
1618 <label class=
"md-nav__title" for=
"__nav_6_2">
1619 <span class=
"md-nav__icon md-icon"></span>
1620 Migrating from WSC
5.2
1622 <ul class=
"md-nav__list" data-md-scrollfix
>
1628 <li class=
"md-nav__item">
1629 <a href=
"../../migration/wsc52/php/" class=
"md-nav__link">
1640 <li class=
"md-nav__item">
1641 <a href=
"../../migration/wsc52/templates/" class=
"md-nav__link">
1642 Templates and Languages
1652 <li class=
"md-nav__item">
1653 <a href=
"../../migration/wsc52/libraries/" class=
"md-nav__link">
1654 Third Party Libraries
1671 <li class=
"md-nav__item md-nav__item--nested">
1674 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_3" type=
"checkbox" id=
"__nav_6_3" >
1676 <label class=
"md-nav__link" for=
"__nav_6_3">
1677 Migrating from WSC
3.1
1678 <span class=
"md-nav__icon md-icon"></span>
1680 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.1" data-md-level=
"2">
1681 <label class=
"md-nav__title" for=
"__nav_6_3">
1682 <span class=
"md-nav__icon md-icon"></span>
1683 Migrating from WSC
3.1
1685 <ul class=
"md-nav__list" data-md-scrollfix
>
1691 <li class=
"md-nav__item">
1692 <a href=
"../../migration/wsc31/php/" class=
"md-nav__link">
1710 <li class=
"md-nav__item md-nav__item--nested">
1713 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_4" type=
"checkbox" id=
"__nav_6_4" >
1715 <label class=
"md-nav__link" for=
"__nav_6_4">
1716 Migrating from WSC
3.0
1717 <span class=
"md-nav__icon md-icon"></span>
1719 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.0" data-md-level=
"2">
1720 <label class=
"md-nav__title" for=
"__nav_6_4">
1721 <span class=
"md-nav__icon md-icon"></span>
1722 Migrating from WSC
3.0
1724 <ul class=
"md-nav__list" data-md-scrollfix
>
1730 <li class=
"md-nav__item">
1731 <a href=
"../../migration/wsc30/php/" class=
"md-nav__link">
1742 <li class=
"md-nav__item">
1743 <a href=
"../../migration/wsc30/javascript/" class=
"md-nav__link">
1754 <li class=
"md-nav__item">
1755 <a href=
"../../migration/wsc30/templates/" class=
"md-nav__link">
1766 <li class=
"md-nav__item">
1767 <a href=
"../../migration/wsc30/css/" class=
"md-nav__link">
1778 <li class=
"md-nav__item">
1779 <a href=
"../../migration/wsc30/package/" class=
"md-nav__link">
1797 <li class=
"md-nav__item md-nav__item--nested">
1800 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_5" type=
"checkbox" id=
"__nav_6_5" >
1802 <label class=
"md-nav__link" for=
"__nav_6_5">
1803 Migrating from WCF
2.1
1804 <span class=
"md-nav__icon md-icon"></span>
1806 <nav class=
"md-nav" aria-label=
"Migrating from WCF 2.1" data-md-level=
"2">
1807 <label class=
"md-nav__title" for=
"__nav_6_5">
1808 <span class=
"md-nav__icon md-icon"></span>
1809 Migrating from WCF
2.1
1811 <ul class=
"md-nav__list" data-md-scrollfix
>
1817 <li class=
"md-nav__item">
1818 <a href=
"../../migration/wcf21/php/" class=
"md-nav__link">
1829 <li class=
"md-nav__item">
1830 <a href=
"../../migration/wcf21/templates/" class=
"md-nav__link">
1841 <li class=
"md-nav__item">
1842 <a href=
"../../migration/wcf21/css/" class=
"md-nav__link">
1853 <li class=
"md-nav__item">
1854 <a href=
"../../migration/wcf21/package/" class=
"md-nav__link">
1881 <li class=
"md-nav__item md-nav__item--nested">
1884 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7" type=
"checkbox" id=
"__nav_7" >
1886 <label class=
"md-nav__link" for=
"__nav_7">
1888 <span class=
"md-nav__icon md-icon"></span>
1890 <nav class=
"md-nav" aria-label=
"Tutorials" data-md-level=
"1">
1891 <label class=
"md-nav__title" for=
"__nav_7">
1892 <span class=
"md-nav__icon md-icon"></span>
1895 <ul class=
"md-nav__list" data-md-scrollfix
>
1902 <li class=
"md-nav__item md-nav__item--nested">
1905 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7_1" type=
"checkbox" id=
"__nav_7_1" >
1907 <label class=
"md-nav__link" for=
"__nav_7_1">
1909 <span class=
"md-nav__icon md-icon"></span>
1911 <nav class=
"md-nav" aria-label=
"Tutorial Series" data-md-level=
"2">
1912 <label class=
"md-nav__title" for=
"__nav_7_1">
1913 <span class=
"md-nav__icon md-icon"></span>
1916 <ul class=
"md-nav__list" data-md-scrollfix
>
1922 <li class=
"md-nav__item">
1923 <a href=
"../../tutorial/series/overview/" class=
"md-nav__link">
1934 <li class=
"md-nav__item">
1935 <a href=
"../../tutorial/series/part_1/" class=
"md-nav__link">
1946 <li class=
"md-nav__item">
1947 <a href=
"../../tutorial/series/part_2/" class=
"md-nav__link">
1958 <li class=
"md-nav__item">
1959 <a href=
"../../tutorial/series/part_3/" class=
"md-nav__link">
1986 <div class=
"md-sidebar md-sidebar--secondary" data-md-component=
"sidebar" data-md-type=
"toc" >
1987 <div class=
"md-sidebar__scrollwrap">
1988 <div class=
"md-sidebar__inner">
1990 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
1996 <label class=
"md-nav__title" for=
"__toc">
1997 <span class=
"md-nav__icon md-icon"></span>
2000 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
2002 <li class=
"md-nav__item">
2003 <a href=
"#helper-functions" class=
"md-nav__link">
2009 <li class=
"md-nav__item">
2010 <a href=
"#domutil" class=
"md-nav__link">
2014 <nav class=
"md-nav" aria-label=
"Dom/Util">
2015 <ul class=
"md-nav__list">
2017 <li class=
"md-nav__item">
2018 <a href=
"#createfragmentfromhtmlhtml-string-documentfragment" class=
"md-nav__link">
2019 createFragmentFromHtml(html: string): DocumentFragment
2024 <li class=
"md-nav__item">
2025 <a href=
"#identifyelement-element-string" class=
"md-nav__link">
2026 identify(element: Element): string
2031 <li class=
"md-nav__item">
2032 <a href=
"#outerheightelement-element-styles-cssstyledeclaration-number" class=
"md-nav__link">
2033 outerHeight(element: Element, styles?: CSSStyleDeclaration): number
2038 <li class=
"md-nav__item">
2039 <a href=
"#outerwidthelement-element-styles-cssstyledeclaration-number" class=
"md-nav__link">
2040 outerWidth(element: Element, styles?: CSSStyleDeclaration): number
2045 <li class=
"md-nav__item">
2046 <a href=
"#outerdimensionselement-element-height-number-width-number" class=
"md-nav__link">
2047 outerDimensions(element: Element): { height: number, width: number }
2052 <li class=
"md-nav__item">
2053 <a href=
"#offsetelement-element-top-number-left-number" class=
"md-nav__link">
2054 offset(element: Element): { top: number, left: number }
2059 <li class=
"md-nav__item">
2060 <a href=
"#setinnerhtmlelement-element-innerhtml-string" class=
"md-nav__link">
2061 setInnerHtml(element: Element, innerHtml: string)
2066 <li class=
"md-nav__item">
2067 <a href=
"#containselement-element-child-element-boolean" class=
"md-nav__link">
2068 contains(element: Element, child: Element): boolean
2073 <li class=
"md-nav__item">
2074 <a href=
"#unwrapchildnodeselement-element" class=
"md-nav__link">
2075 unwrapChildNodes(element: Element)
2085 <li class=
"md-nav__item">
2086 <a href=
"#domchangelistener" class=
"md-nav__link">
2100 <div class=
"md-content" data-md-component=
"content">
2101 <article class=
"md-content__inner md-typeset">
2104 <a href=
"https://github.com/WoltLab/docs.woltlab.com/edit/5.4/docs/javascript/new-api_dom.md" title=
"Edit this page" class=
"md-content__button md-icon">
2105 <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>
2109 <h1 id=
"working-with-the-dom-javascript-api">Working with the DOM - JavaScript API
<a class=
"headerlink" href=
"#working-with-the-dom-javascript-api" title=
"Permanent link">#
</a></h1>
2110 <h2 id=
"helper-functions">Helper Functions
<a class=
"headerlink" href=
"#helper-functions" title=
"Permanent link">#
</a></h2>
2111 <p>There is large set of
<a href=
"../helper-functions/">helper functions
</a> that assist
2112 you when working with the DOM tree and its elements. These functions are globally
2113 available and do not require explicit module imports.
</p>
2114 <h2 id=
"domutil"><code>Dom/Util
</code><a class=
"headerlink" href=
"#domutil" title=
"Permanent link">#
</a></h2>
2115 <h3 id=
"createfragmentfromhtmlhtml-string-documentfragment"><code>createFragmentFromHtml(html: string): DocumentFragment
</code><a class=
"headerlink" href=
"#createfragmentfromhtmlhtml-string-documentfragment" title=
"Permanent link">#
</a></h3>
2116 <p>Parses a HTML string and creates a
<code>DocumentFragment
</code> object that holds the
2117 resulting nodes.
</p>
2118 <h3 id=
"identifyelement-element-string"><code>identify(element: Element): string
</code><a class=
"headerlink" href=
"#identifyelement-element-string" title=
"Permanent link">#
</a></h3>
2119 <p>Retrieves the unique identifier (
<code>id
</code>) of an element. If it does not currently
2120 have an id assigned, a generic identifier is used instead.
</p>
2121 <h3 id=
"outerheightelement-element-styles-cssstyledeclaration-number"><code>outerHeight(element: Element, styles?: CSSStyleDeclaration): number
</code><a class=
"headerlink" href=
"#outerheightelement-element-styles-cssstyledeclaration-number" title=
"Permanent link">#
</a></h3>
2122 <p>Computes the outer height of an element using the element's
<code>offsetHeight
</code> and
2123 the sum of the rounded down values for
<code>margin-top
</code> and
<code>margin-bottom
</code>.
</p>
2124 <h3 id=
"outerwidthelement-element-styles-cssstyledeclaration-number"><code>outerWidth(element: Element, styles?: CSSStyleDeclaration): number
</code><a class=
"headerlink" href=
"#outerwidthelement-element-styles-cssstyledeclaration-number" title=
"Permanent link">#
</a></h3>
2125 <p>Computes the outer width of an element using the element's
<code>offsetWidth
</code> and
2126 the sum of the rounded down values for
<code>margin-left
</code> and
<code>margin-right
</code>.
</p>
2127 <h3 id=
"outerdimensionselement-element-height-number-width-number"><code>outerDimensions(element: Element): { height: number, width: number }
</code><a class=
"headerlink" href=
"#outerdimensionselement-element-height-number-width-number" title=
"Permanent link">#
</a></h3>
2128 <p>Computes the outer dimensions of an element including its margins.
</p>
2129 <h3 id=
"offsetelement-element-top-number-left-number"><code>offset(element: Element): { top: number, left: number }
</code><a class=
"headerlink" href=
"#offsetelement-element-top-number-left-number" title=
"Permanent link">#
</a></h3>
2130 <p>Computes the element's offset relative to the top left corner of the document.
</p>
2131 <h3 id=
"setinnerhtmlelement-element-innerhtml-string"><code>setInnerHtml(element: Element, innerHtml: string)
</code><a class=
"headerlink" href=
"#setinnerhtmlelement-element-innerhtml-string" title=
"Permanent link">#
</a></h3>
2132 <p>Sets the inner HTML of an element via
<code>element.innerHTML = innerHtml
</code>. Browsers
2133 do not evaluate any embedded
<code><script
></code> tags, therefore this method extracts each
2134 of them, creates new
<code><script
></code> tags and inserts them in their original order of
2136 <h3 id=
"containselement-element-child-element-boolean"><code>contains(element: Element, child: Element): boolean
</code><a class=
"headerlink" href=
"#containselement-element-child-element-boolean" title=
"Permanent link">#
</a></h3>
2137 <p>Evaluates if
<code>element
</code> is a direct or indirect parent element of
<code>child
</code>.
</p>
2138 <h3 id=
"unwrapchildnodeselement-element"><code>unwrapChildNodes(element: Element)
</code><a class=
"headerlink" href=
"#unwrapchildnodeselement-element" title=
"Permanent link">#
</a></h3>
2139 <p>Moves all child nodes out of
<code>element
</code> while maintaining their order, then removes
2140 <code>element
</code> from the document.
</p>
2141 <h2 id=
"domchangelistener"><code>Dom/ChangeListener
</code><a class=
"headerlink" href=
"#domchangelistener" title=
"Permanent link">#
</a></h2>
2142 <p>This class is used to observe specific changes to the DOM, for example after an
2143 Ajax request has completed. For performance reasons this is a manually-invoked
2144 listener that does not rely on a
<code>MutationObserver
</code>.
</p>
2145 <div class=
"highlight"><pre><span></span><code><span class=
"nx">require
</span><span class=
"p">([
</span><span class=
"s2">"Dom/ChangeListener
"</span><span class=
"p">],
</span> <span class=
"kd">function
</span><span class=
"p">(
</span><span class=
"nx">DomChangeListener
</span><span class=
"p">)
</span> <span class=
"p">{
</span>
2146 <span class=
"nx">DomChangeListener
</span><span class=
"p">.
</span><span class=
"nx">add
</span><span class=
"p">(
</span><span class=
"s2">"App/Foo
"</span><span class=
"p">,
</span> <span class=
"kd">function
</span><span class=
"p">()
</span> <span class=
"p">{
</span>
2147 <span class=
"c1">// the DOM may have been altered significantly
</span>
2148 <span class=
"p">});
</span>
2150 <span class=
"c1">// propagate changes to the DOM
</span>
2151 <span class=
"nx">DomChangeListener
</span><span class=
"p">.
</span><span class=
"nx">trigger
</span><span class=
"p">();
</span>
2152 <span class=
"p">});
</span>
2159 <div class=
"md-source-date">
2162 Last update:
2021-
01-
08
2181 <footer class=
"md-footer">
2183 <nav class=
"md-footer__inner md-grid" aria-label=
"Footer">
2185 <a href=
"../new-api_core/" class=
"md-footer__link md-footer__link--prev" rel=
"prev">
2186 <div class=
"md-footer__button md-icon">
2187 <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>
2189 <div class=
"md-footer__title">
2190 <div class=
"md-ellipsis">
2191 <span class=
"md-footer__direction">
2200 <a href=
"../new-api_events/" class=
"md-footer__link md-footer__link--next" rel=
"next">
2201 <div class=
"md-footer__title">
2202 <div class=
"md-ellipsis">
2203 <span class=
"md-footer__direction">
2209 <div class=
"md-footer__button md-icon">
2210 <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>
2216 <div class=
"md-footer-meta md-typeset">
2217 <div class=
"md-footer-meta__inner md-grid">
2218 <div class=
"md-footer-copyright">
2220 <div class=
"md-footer-copyright__highlight">
2221 Copyright ©
2020 WoltLab GmbH
2225 <a href=
"https://squidfunk.github.io/mkdocs-material/" target=
"_blank" rel=
"noopener">
2230 <div class=
"md-footer-copyright">
2231 <a href=
"https://www.woltlab.com/legal-notice/">Legal Notice
</a>
2232 <a href=
"https://www.woltlab.com/privacy-policy/">Privacy Policy
</a>
2239 <div class=
"md-dialog" data-md-component=
"dialog">
2240 <div class=
"md-dialog__inner md-typeset"></div>
2242 <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>
2245 <script src=
"../../assets/javascripts/bundle.d892486b.min.js"></script>