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>JavaScript API - 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=
"#migrating-from-wsc-30-javascript" 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">
673 <li class=
"md-nav__item md-nav__item--nested">
676 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4" type=
"checkbox" id=
"__nav_4" >
678 <label class=
"md-nav__link" for=
"__nav_4">
679 TypeScript and JavaScript API
680 <span class=
"md-nav__icon md-icon"></span>
682 <nav class=
"md-nav" aria-label=
"TypeScript and JavaScript API" data-md-level=
"1">
683 <label class=
"md-nav__title" for=
"__nav_4">
684 <span class=
"md-nav__icon md-icon"></span>
685 TypeScript and JavaScript API
687 <ul class=
"md-nav__list" data-md-scrollfix
>
693 <li class=
"md-nav__item">
694 <a href=
"../../../javascript/general-usage/" class=
"md-nav__link">
705 <li class=
"md-nav__item">
706 <a href=
"../../../javascript/typescript/" class=
"md-nav__link">
718 <li class=
"md-nav__item md-nav__item--nested">
721 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4_3" type=
"checkbox" id=
"__nav_4_3" >
723 <label class=
"md-nav__link" for=
"__nav_4_3">
725 <span class=
"md-nav__icon md-icon"></span>
727 <nav class=
"md-nav" aria-label=
"New API" data-md-level=
"2">
728 <label class=
"md-nav__title" for=
"__nav_4_3">
729 <span class=
"md-nav__icon md-icon"></span>
732 <ul class=
"md-nav__list" data-md-scrollfix
>
738 <li class=
"md-nav__item">
739 <a href=
"../../../javascript/new-api_writing-a-module/" class=
"md-nav__link">
750 <li class=
"md-nav__item">
751 <a href=
"../../../javascript/new-api_data-structures/" class=
"md-nav__link">
762 <li class=
"md-nav__item">
763 <a href=
"../../../javascript/new-api_core/" class=
"md-nav__link">
774 <li class=
"md-nav__item">
775 <a href=
"../../../javascript/new-api_dom/" class=
"md-nav__link">
786 <li class=
"md-nav__item">
787 <a href=
"../../../javascript/new-api_events/" class=
"md-nav__link">
798 <li class=
"md-nav__item">
799 <a href=
"../../../javascript/new-api_ajax/" class=
"md-nav__link">
810 <li class=
"md-nav__item">
811 <a href=
"../../../javascript/new-api_dialogs/" class=
"md-nav__link">
822 <li class=
"md-nav__item">
823 <a href=
"../../../javascript/new-api_browser/" class=
"md-nav__link">
824 Browser and Screen Sizes
834 <li class=
"md-nav__item">
835 <a href=
"../../../javascript/new-api_ui/" class=
"md-nav__link">
852 <li class=
"md-nav__item">
853 <a href=
"../../../javascript/legacy-api/" class=
"md-nav__link">
864 <li class=
"md-nav__item">
865 <a href=
"../../../javascript/helper-functions/" class=
"md-nav__link">
876 <li class=
"md-nav__item">
877 <a href=
"../../../javascript/code-snippets/" class=
"md-nav__link">
898 <li class=
"md-nav__item md-nav__item--nested">
901 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5" type=
"checkbox" id=
"__nav_5" >
903 <label class=
"md-nav__link" for=
"__nav_5">
905 <span class=
"md-nav__icon md-icon"></span>
907 <nav class=
"md-nav" aria-label=
"Package Components" data-md-level=
"1">
908 <label class=
"md-nav__title" for=
"__nav_5">
909 <span class=
"md-nav__icon md-icon"></span>
912 <ul class=
"md-nav__list" data-md-scrollfix
>
918 <li class=
"md-nav__item">
919 <a href=
"../../../package/package-xml/" class=
"md-nav__link">
931 <li class=
"md-nav__item md-nav__item--nested">
934 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5_2" type=
"checkbox" id=
"__nav_5_2" >
936 <label class=
"md-nav__link" for=
"__nav_5_2">
938 <span class=
"md-nav__icon md-icon"></span>
940 <nav class=
"md-nav" aria-label=
"PIPs" data-md-level=
"2">
941 <label class=
"md-nav__title" for=
"__nav_5_2">
942 <span class=
"md-nav__icon md-icon"></span>
945 <ul class=
"md-nav__list" data-md-scrollfix
>
951 <li class=
"md-nav__item">
952 <a href=
"../../../package/pip/" class=
"md-nav__link">
963 <li class=
"md-nav__item">
964 <a href=
"../../../package/pip/acl-option/" class=
"md-nav__link">
975 <li class=
"md-nav__item">
976 <a href=
"../../../package/pip/acp-menu/" class=
"md-nav__link">
987 <li class=
"md-nav__item">
988 <a href=
"../../../package/pip/acp-search-provider/" class=
"md-nav__link">
999 <li class=
"md-nav__item">
1000 <a href=
"../../../package/pip/acp-template/" class=
"md-nav__link">
1011 <li class=
"md-nav__item">
1012 <a href=
"../../../package/pip/bbcode/" class=
"md-nav__link">
1023 <li class=
"md-nav__item">
1024 <a href=
"../../../package/pip/box/" class=
"md-nav__link">
1035 <li class=
"md-nav__item">
1036 <a href=
"../../../package/pip/clipboard-action/" class=
"md-nav__link">
1047 <li class=
"md-nav__item">
1048 <a href=
"../../../package/pip/core-object/" class=
"md-nav__link">
1059 <li class=
"md-nav__item">
1060 <a href=
"../../../package/pip/cronjob/" class=
"md-nav__link">
1071 <li class=
"md-nav__item">
1072 <a href=
"../../../package/pip/database/" class=
"md-nav__link">
1083 <li class=
"md-nav__item">
1084 <a href=
"../../../package/pip/event-listener/" class=
"md-nav__link">
1095 <li class=
"md-nav__item">
1096 <a href=
"../../../package/pip/file/" class=
"md-nav__link">
1107 <li class=
"md-nav__item">
1108 <a href=
"../../../package/pip/language/" class=
"md-nav__link">
1119 <li class=
"md-nav__item">
1120 <a href=
"../../../package/pip/media-provider/" class=
"md-nav__link">
1131 <li class=
"md-nav__item">
1132 <a href=
"../../../package/pip/menu/" class=
"md-nav__link">
1143 <li class=
"md-nav__item">
1144 <a href=
"../../../package/pip/menu-item/" class=
"md-nav__link">
1155 <li class=
"md-nav__item">
1156 <a href=
"../../../package/pip/object-type/" class=
"md-nav__link">
1167 <li class=
"md-nav__item">
1168 <a href=
"../../../package/pip/object-type-definition/" class=
"md-nav__link">
1169 objectTypeDefinition
1179 <li class=
"md-nav__item">
1180 <a href=
"../../../package/pip/option/" class=
"md-nav__link">
1191 <li class=
"md-nav__item">
1192 <a href=
"../../../package/pip/page/" class=
"md-nav__link">
1203 <li class=
"md-nav__item">
1204 <a href=
"../../../package/pip/pip/" class=
"md-nav__link">
1215 <li class=
"md-nav__item">
1216 <a href=
"../../../package/pip/script/" class=
"md-nav__link">
1227 <li class=
"md-nav__item">
1228 <a href=
"../../../package/pip/smiley/" class=
"md-nav__link">
1239 <li class=
"md-nav__item">
1240 <a href=
"../../../package/pip/sql/" class=
"md-nav__link">
1251 <li class=
"md-nav__item">
1252 <a href=
"../../../package/pip/style/" class=
"md-nav__link">
1263 <li class=
"md-nav__item">
1264 <a href=
"../../../package/pip/template/" class=
"md-nav__link">
1275 <li class=
"md-nav__item">
1276 <a href=
"../../../package/pip/template-listener/" class=
"md-nav__link">
1287 <li class=
"md-nav__item">
1288 <a href=
"../../../package/pip/user-group-option/" class=
"md-nav__link">
1299 <li class=
"md-nav__item">
1300 <a href=
"../../../package/pip/user-menu/" class=
"md-nav__link">
1311 <li class=
"md-nav__item">
1312 <a href=
"../../../package/pip/user-notification-event/" class=
"md-nav__link">
1313 userNotificationEvent
1323 <li class=
"md-nav__item">
1324 <a href=
"../../../package/pip/user-option/" class=
"md-nav__link">
1335 <li class=
"md-nav__item">
1336 <a href=
"../../../package/pip/user-profile-menu/" class=
"md-nav__link">
1353 <li class=
"md-nav__item">
1354 <a href=
"../../../package/database-php-api/" class=
"md-nav__link">
1377 <li class=
"md-nav__item md-nav__item--active md-nav__item--nested">
1380 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6" type=
"checkbox" id=
"__nav_6" checked
>
1382 <label class=
"md-nav__link" for=
"__nav_6">
1384 <span class=
"md-nav__icon md-icon"></span>
1386 <nav class=
"md-nav" aria-label=
"Migration" data-md-level=
"1">
1387 <label class=
"md-nav__title" for=
"__nav_6">
1388 <span class=
"md-nav__icon md-icon"></span>
1391 <ul class=
"md-nav__list" data-md-scrollfix
>
1398 <li class=
"md-nav__item md-nav__item--nested">
1401 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_1" type=
"checkbox" id=
"__nav_6_1" >
1403 <label class=
"md-nav__link" for=
"__nav_6_1">
1404 Migrating from WSC
5.3
1405 <span class=
"md-nav__icon md-icon"></span>
1407 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.3" data-md-level=
"2">
1408 <label class=
"md-nav__title" for=
"__nav_6_1">
1409 <span class=
"md-nav__icon md-icon"></span>
1410 Migrating from WSC
5.3
1412 <ul class=
"md-nav__list" data-md-scrollfix
>
1418 <li class=
"md-nav__item">
1419 <a href=
"../../wsc53/php/" class=
"md-nav__link">
1430 <li class=
"md-nav__item">
1431 <a href=
"../../wsc53/session/" class=
"md-nav__link">
1432 Session Handling and Authentication
1442 <li class=
"md-nav__item">
1443 <a href=
"../../wsc53/javascript/" class=
"md-nav__link">
1444 TypeScript and JavaScript
1454 <li class=
"md-nav__item">
1455 <a href=
"../../wsc53/templates/" class=
"md-nav__link">
1466 <li class=
"md-nav__item">
1467 <a href=
"../../wsc53/libraries/" class=
"md-nav__link">
1468 Third Party Libraries
1485 <li class=
"md-nav__item md-nav__item--nested">
1488 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_2" type=
"checkbox" id=
"__nav_6_2" >
1490 <label class=
"md-nav__link" for=
"__nav_6_2">
1491 Migrating from WSC
5.2
1492 <span class=
"md-nav__icon md-icon"></span>
1494 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.2" data-md-level=
"2">
1495 <label class=
"md-nav__title" for=
"__nav_6_2">
1496 <span class=
"md-nav__icon md-icon"></span>
1497 Migrating from WSC
5.2
1499 <ul class=
"md-nav__list" data-md-scrollfix
>
1505 <li class=
"md-nav__item">
1506 <a href=
"../../wsc52/php/" class=
"md-nav__link">
1517 <li class=
"md-nav__item">
1518 <a href=
"../../wsc52/templates/" class=
"md-nav__link">
1519 Templates and Languages
1529 <li class=
"md-nav__item">
1530 <a href=
"../../wsc52/libraries/" class=
"md-nav__link">
1531 Third Party Libraries
1548 <li class=
"md-nav__item md-nav__item--nested">
1551 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_3" type=
"checkbox" id=
"__nav_6_3" >
1553 <label class=
"md-nav__link" for=
"__nav_6_3">
1554 Migrating from WSC
3.1
1555 <span class=
"md-nav__icon md-icon"></span>
1557 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.1" data-md-level=
"2">
1558 <label class=
"md-nav__title" for=
"__nav_6_3">
1559 <span class=
"md-nav__icon md-icon"></span>
1560 Migrating from WSC
3.1
1562 <ul class=
"md-nav__list" data-md-scrollfix
>
1568 <li class=
"md-nav__item">
1569 <a href=
"../../wsc31/php/" class=
"md-nav__link">
1589 <li class=
"md-nav__item md-nav__item--active md-nav__item--nested">
1592 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_4" type=
"checkbox" id=
"__nav_6_4" checked
>
1594 <label class=
"md-nav__link" for=
"__nav_6_4">
1595 Migrating from WSC
3.0
1596 <span class=
"md-nav__icon md-icon"></span>
1598 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.0" data-md-level=
"2">
1599 <label class=
"md-nav__title" for=
"__nav_6_4">
1600 <span class=
"md-nav__icon md-icon"></span>
1601 Migrating from WSC
3.0
1603 <ul class=
"md-nav__list" data-md-scrollfix
>
1609 <li class=
"md-nav__item">
1610 <a href=
"../php/" class=
"md-nav__link">
1623 <li class=
"md-nav__item md-nav__item--active">
1625 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"toc" type=
"checkbox" id=
"__toc">
1630 <label class=
"md-nav__link md-nav__link--active" for=
"__toc">
1632 <span class=
"md-nav__icon md-icon"></span>
1635 <a href=
"./" class=
"md-nav__link md-nav__link--active">
1640 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
1646 <label class=
"md-nav__title" for=
"__toc">
1647 <span class=
"md-nav__icon md-icon"></span>
1650 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
1652 <li class=
"md-nav__item">
1653 <a href=
"#accelerated-guest-view-tiny-builds" class=
"md-nav__link">
1654 Accelerated Guest View / Tiny Builds
1657 <nav class=
"md-nav" aria-label=
"Accelerated Guest View / Tiny Builds">
1658 <ul class=
"md-nav__list">
1660 <li class=
"md-nav__item">
1661 <a href=
"#code-templates-for-tiny-builds" class=
"md-nav__link">
1662 Code Templates for Tiny Builds
1665 <nav class=
"md-nav" aria-label=
"Code Templates for Tiny Builds">
1666 <ul class=
"md-nav__list">
1668 <li class=
"md-nav__item">
1669 <a href=
"#legacy-javascript" class=
"md-nav__link">
1675 <li class=
"md-nav__item">
1676 <a href=
"#requirejs-modules" class=
"md-nav__link">
1687 <li class=
"md-nav__item">
1688 <a href=
"#including-tinified-builds-through-js" class=
"md-nav__link">
1689 Including tinified builds through {js}
1699 <li class=
"md-nav__item">
1700 <a href=
"#real-error-messages-for-ajax-responses" class=
"md-nav__link">
1701 Real Error Messages for AJAX Responses
1704 <nav class=
"md-nav" aria-label=
"Real Error Messages for AJAX Responses">
1705 <ul class=
"md-nav__list">
1707 <li class=
"md-nav__item">
1708 <a href=
"#example-code" class=
"md-nav__link">
1719 <li class=
"md-nav__item">
1720 <a href=
"#simplified-form-submit-in-dialogs" class=
"md-nav__link">
1721 Simplified Form Submit in Dialogs
1726 <li class=
"md-nav__item">
1727 <a href=
"#helper-function-for-inline-error-messages" class=
"md-nav__link">
1728 Helper Function for Inline Error Messages
1731 <nav class=
"md-nav" aria-label=
"Helper Function for Inline Error Messages">
1732 <ul class=
"md-nav__list">
1734 <li class=
"md-nav__item">
1735 <a href=
"#example-code_1" class=
"md-nav__link">
1758 <li class=
"md-nav__item">
1759 <a href=
"../templates/" class=
"md-nav__link">
1770 <li class=
"md-nav__item">
1771 <a href=
"../css/" class=
"md-nav__link">
1782 <li class=
"md-nav__item">
1783 <a href=
"../package/" class=
"md-nav__link">
1801 <li class=
"md-nav__item md-nav__item--nested">
1804 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_5" type=
"checkbox" id=
"__nav_6_5" >
1806 <label class=
"md-nav__link" for=
"__nav_6_5">
1807 Migrating from WCF
2.1
1808 <span class=
"md-nav__icon md-icon"></span>
1810 <nav class=
"md-nav" aria-label=
"Migrating from WCF 2.1" data-md-level=
"2">
1811 <label class=
"md-nav__title" for=
"__nav_6_5">
1812 <span class=
"md-nav__icon md-icon"></span>
1813 Migrating from WCF
2.1
1815 <ul class=
"md-nav__list" data-md-scrollfix
>
1821 <li class=
"md-nav__item">
1822 <a href=
"../../wcf21/php/" class=
"md-nav__link">
1833 <li class=
"md-nav__item">
1834 <a href=
"../../wcf21/templates/" class=
"md-nav__link">
1845 <li class=
"md-nav__item">
1846 <a href=
"../../wcf21/css/" class=
"md-nav__link">
1857 <li class=
"md-nav__item">
1858 <a href=
"../../wcf21/package/" class=
"md-nav__link">
1885 <li class=
"md-nav__item md-nav__item--nested">
1888 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7" type=
"checkbox" id=
"__nav_7" >
1890 <label class=
"md-nav__link" for=
"__nav_7">
1892 <span class=
"md-nav__icon md-icon"></span>
1894 <nav class=
"md-nav" aria-label=
"Tutorials" data-md-level=
"1">
1895 <label class=
"md-nav__title" for=
"__nav_7">
1896 <span class=
"md-nav__icon md-icon"></span>
1899 <ul class=
"md-nav__list" data-md-scrollfix
>
1906 <li class=
"md-nav__item md-nav__item--nested">
1909 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7_1" type=
"checkbox" id=
"__nav_7_1" >
1911 <label class=
"md-nav__link" for=
"__nav_7_1">
1913 <span class=
"md-nav__icon md-icon"></span>
1915 <nav class=
"md-nav" aria-label=
"Tutorial Series" data-md-level=
"2">
1916 <label class=
"md-nav__title" for=
"__nav_7_1">
1917 <span class=
"md-nav__icon md-icon"></span>
1920 <ul class=
"md-nav__list" data-md-scrollfix
>
1926 <li class=
"md-nav__item">
1927 <a href=
"../../../tutorial/series/overview/" class=
"md-nav__link">
1938 <li class=
"md-nav__item">
1939 <a href=
"../../../tutorial/series/part_1/" class=
"md-nav__link">
1950 <li class=
"md-nav__item">
1951 <a href=
"../../../tutorial/series/part_2/" class=
"md-nav__link">
1962 <li class=
"md-nav__item">
1963 <a href=
"../../../tutorial/series/part_3/" class=
"md-nav__link">
1990 <div class=
"md-sidebar md-sidebar--secondary" data-md-component=
"sidebar" data-md-type=
"toc" >
1991 <div class=
"md-sidebar__scrollwrap">
1992 <div class=
"md-sidebar__inner">
1994 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
2000 <label class=
"md-nav__title" for=
"__toc">
2001 <span class=
"md-nav__icon md-icon"></span>
2004 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
2006 <li class=
"md-nav__item">
2007 <a href=
"#accelerated-guest-view-tiny-builds" class=
"md-nav__link">
2008 Accelerated Guest View / Tiny Builds
2011 <nav class=
"md-nav" aria-label=
"Accelerated Guest View / Tiny Builds">
2012 <ul class=
"md-nav__list">
2014 <li class=
"md-nav__item">
2015 <a href=
"#code-templates-for-tiny-builds" class=
"md-nav__link">
2016 Code Templates for Tiny Builds
2019 <nav class=
"md-nav" aria-label=
"Code Templates for Tiny Builds">
2020 <ul class=
"md-nav__list">
2022 <li class=
"md-nav__item">
2023 <a href=
"#legacy-javascript" class=
"md-nav__link">
2029 <li class=
"md-nav__item">
2030 <a href=
"#requirejs-modules" class=
"md-nav__link">
2041 <li class=
"md-nav__item">
2042 <a href=
"#including-tinified-builds-through-js" class=
"md-nav__link">
2043 Including tinified builds through {js}
2053 <li class=
"md-nav__item">
2054 <a href=
"#real-error-messages-for-ajax-responses" class=
"md-nav__link">
2055 Real Error Messages for AJAX Responses
2058 <nav class=
"md-nav" aria-label=
"Real Error Messages for AJAX Responses">
2059 <ul class=
"md-nav__list">
2061 <li class=
"md-nav__item">
2062 <a href=
"#example-code" class=
"md-nav__link">
2073 <li class=
"md-nav__item">
2074 <a href=
"#simplified-form-submit-in-dialogs" class=
"md-nav__link">
2075 Simplified Form Submit in Dialogs
2080 <li class=
"md-nav__item">
2081 <a href=
"#helper-function-for-inline-error-messages" class=
"md-nav__link">
2082 Helper Function for Inline Error Messages
2085 <nav class=
"md-nav" aria-label=
"Helper Function for Inline Error Messages">
2086 <ul class=
"md-nav__list">
2088 <li class=
"md-nav__item">
2089 <a href=
"#example-code_1" class=
"md-nav__link">
2108 <div class=
"md-content" data-md-component=
"content">
2109 <article class=
"md-content__inner md-typeset">
2112 <a href=
"https://github.com/WoltLab/docs.woltlab.com/edit/5.4/docs/migration/wsc30/javascript.md" title=
"Edit this page" class=
"md-content__button md-icon">
2113 <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>
2117 <h1 id=
"migrating-from-wsc-30-javascript">Migrating from WSC
3.0 - JavaScript
<a class=
"headerlink" href=
"#migrating-from-wsc-30-javascript" title=
"Permanent link">#
</a></h1>
2118 <h2 id=
"accelerated-guest-view-tiny-builds">Accelerated Guest View / Tiny Builds
<a class=
"headerlink" href=
"#accelerated-guest-view-tiny-builds" title=
"Permanent link">#
</a></h2>
2119 <p>The new tiny builds are highly optimized variants of existing JavaScript files and modules, aiming for significant performance improvements for guests and search engines alike. This is accomplished by heavily restricting page interaction to read-only actions whenever possible, which in return removes the need to provide certain JavaScript modules in general.
</p>
2120 <p>For example, disallowing guests to write any formatted messages will in return remove the need to provide the WYSIWYG editor at all. But it doesn't stop there, there are a lot of other modules that provide additional features for the editor, and by excluding the editor, we can also exclude these modules too.
</p>
2121 <p>Long story short, the tiny mode guarantees that certain actions will never be carried out by guests or search engines, therefore some modules are not going to be needed by them ever.
</p>
2122 <h3 id=
"code-templates-for-tiny-builds">Code Templates for Tiny Builds
<a class=
"headerlink" href=
"#code-templates-for-tiny-builds" title=
"Permanent link">#
</a></h3>
2123 <p>The following examples assume that you use the virtual constant
<code>COMPILER_TARGET_DEFAULT
</code> as a switch for the optimized code path. This is also the constant used by the official
<a href=
"https://github.com/WoltLab/WCF/tree/master/extra">build scripts for JavaScript files
</a>.
</p>
2124 <p>We recommend that you provide a mock implementation for existing code to ensure
3rd party compatibility. It is enough to provide a bare object or class that exposes the original properties using the same primitive data types. This is intended to provide a soft-fail for implementations that are not aware of the tiny mode yet, but is not required for classes that did not exist until now.
</p>
2125 <h4 id=
"legacy-javascript">Legacy JavaScript
<a class=
"headerlink" href=
"#legacy-javascript" title=
"Permanent link">#
</a></h4>
2126 <div class=
"highlight"><pre><span></span><code><span class=
"k">if
</span> <span class=
"p">(
</span><span class=
"nx">COMPILER_TARGET_DEFAULT
</span><span class=
"p">)
</span> <span class=
"p">{
</span>
2127 <span class=
"nx">WCF
</span><span class=
"p">.
</span><span class=
"nx">Example
</span><span class=
"p">.
</span><span class=
"nx">Foo
</span> <span class=
"o">=
</span> <span class=
"p">{
</span>
2128 <span class=
"nx">makeSnafucated
</span><span class=
"o">:
</span> <span class=
"kd">function
</span><span class=
"p">()
</span> <span class=
"p">{
</span>
2129 <span class=
"k">return
</span> <span class=
"s2">"Hello World
"</span><span class=
"p">;
</span>
2130 <span class=
"p">}
</span>
2131 <span class=
"p">};
</span>
2133 <span class=
"nx">WCF
</span><span class=
"p">.
</span><span class=
"nx">Example
</span><span class=
"p">.
</span><span class=
"nx">Bar
</span> <span class=
"o">=
</span> <span class=
"nx">Class
</span><span class=
"p">.
</span><span class=
"nx">extend
</span><span class=
"p">({
</span>
2134 <span class=
"nx">foobar
</span><span class=
"o">:
</span> <span class=
"s2">"baz
"</span><span class=
"p">,
</span>
2136 <span class=
"nx">foo
</span><span class=
"o">:
</span> <span class=
"kd">function
</span><span class=
"p">(
</span><span class=
"nx">$bar
</span><span class=
"p">)
</span> <span class=
"p">{
</span>
2137 <span class=
"k">return
</span> <span class=
"nx">$bar
</span> <span class=
"o">+
</span> <span class=
"k">this
</span><span class=
"p">.
</span><span class=
"nx">foobar
</span><span class=
"p">;
</span>
2138 <span class=
"p">}
</span>
2139 <span class=
"p">});
</span>
2140 <span class=
"p">}
</span>
2141 <span class=
"k">else
</span> <span class=
"p">{
</span>
2142 <span class=
"nx">WCF
</span><span class=
"p">.
</span><span class=
"nx">Example
</span><span class=
"p">.
</span><span class=
"nx">Foo
</span> <span class=
"o">=
</span> <span class=
"p">{
</span>
2143 <span class=
"nx">makeSnafucated
</span><span class=
"o">:
</span> <span class=
"kd">function
</span><span class=
"p">()
</span> <span class=
"p">{}
</span>
2144 <span class=
"p">};
</span>
2146 <span class=
"nx">WCF
</span><span class=
"p">.
</span><span class=
"nx">Example
</span><span class=
"p">.
</span><span class=
"nx">Bar
</span> <span class=
"o">=
</span> <span class=
"nx">Class
</span><span class=
"p">.
</span><span class=
"nx">extend
</span><span class=
"p">({
</span>
2147 <span class=
"nx">foobar
</span><span class=
"o">:
</span> <span class=
"s2">""</span><span class=
"p">,
</span>
2148 <span class=
"nx">foo
</span><span class=
"o">:
</span> <span class=
"kd">function
</span><span class=
"p">()
</span> <span class=
"p">{}
</span>
2149 <span class=
"p">});
</span>
2150 <span class=
"p">}
</span>
2152 <h4 id=
"requirejs-modules">require.js Modules
<a class=
"headerlink" href=
"#requirejs-modules" title=
"Permanent link">#
</a></h4>
2153 <div class=
"highlight"><pre><span></span><code><span class=
"nx">define
</span><span class=
"p">([
</span><span class=
"s2">"some
"</span><span class=
"p">,
</span> <span class=
"s2">"fancy
"</span><span class=
"p">,
</span> <span class=
"s2">"dependencies
"</span><span class=
"p">],
</span> <span class=
"kd">function
</span><span class=
"p">(
</span><span class=
"nx">Some
</span><span class=
"p">,
</span> <span class=
"nx">Fancy
</span><span class=
"p">,
</span> <span class=
"nx">Dependencies
</span><span class=
"p">)
</span> <span class=
"p">{
</span>
2154 <span class=
"s2">"use strict
"</span><span class=
"p">;
</span>
2156 <span class=
"k">if
</span> <span class=
"p">(
</span><span class=
"o">!
</span><span class=
"nx">COMPILER_TARGET_DEFAULT
</span><span class=
"p">)
</span> <span class=
"p">{
</span>
2157 <span class=
"kd">var
</span> <span class=
"nx">Fake
</span> <span class=
"o">=
</span> <span class=
"kd">function
</span><span class=
"p">()
</span> <span class=
"p">{};
</span>
2158 <span class=
"nx">Fake
</span><span class=
"p">.
</span><span class=
"nx">prototype
</span> <span class=
"o">=
</span> <span class=
"p">{
</span>
2159 <span class=
"nx">init
</span><span class=
"o">:
</span> <span class=
"kd">function
</span><span class=
"p">()
</span> <span class=
"p">{},
</span>
2160 <span class=
"nx">makeSnafucated
</span><span class=
"o">:
</span> <span class=
"kd">function
</span><span class=
"p">()
</span> <span class=
"p">{}
</span>
2161 <span class=
"p">};
</span>
2162 <span class=
"k">return
</span> <span class=
"nx">Fake
</span><span class=
"p">;
</span>
2163 <span class=
"p">}
</span>
2165 <span class=
"kd">function
</span> <span class=
"nx">MyAwesomeClass
</span><span class=
"p">(
</span><span class=
"nx">niceArgument
</span><span class=
"p">)
</span> <span class=
"p">{
</span> <span class=
"k">this
</span><span class=
"p">.
</span><span class=
"nx">init
</span><span class=
"p">(
</span><span class=
"nx">niceArgument
</span><span class=
"p">);
</span> <span class=
"p">}
</span>
2166 <span class=
"nx">MyAwesomeClass
</span><span class=
"p">.
</span><span class=
"nx">prototype
</span> <span class=
"o">=
</span> <span class=
"p">{
</span>
2167 <span class=
"nx">init
</span><span class=
"o">:
</span> <span class=
"kd">function
</span><span class=
"p">(
</span><span class=
"nx">niceArgument
</span><span class=
"p">)
</span> <span class=
"p">{
</span>
2168 <span class=
"k">if
</span> <span class=
"p">(
</span><span class=
"nx">niceArgument
</span><span class=
"p">)
</span> <span class=
"p">{
</span>
2169 <span class=
"k">this
</span><span class=
"p">.
</span><span class=
"nx">makeSnafucated
</span><span class=
"p">();
</span>
2170 <span class=
"p">}
</span>
2171 <span class=
"p">},
</span>
2173 <span class=
"nx">makeSnafucated
</span><span class=
"o">:
</span> <span class=
"kd">function
</span><span class=
"p">()
</span> <span class=
"p">{
</span>
2174 <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>
2175 <span class=
"p">}
</span>
2176 <span class=
"p">}
</span>
2178 <span class=
"k">return
</span> <span class=
"nx">MyAwesomeClass
</span><span class=
"p">;
</span>
2179 <span class=
"p">});
</span>
2181 <h3 id=
"including-tinified-builds-through-js">Including tinified builds through
<code>{js}
</code><a class=
"headerlink" href=
"#including-tinified-builds-through-js" title=
"Permanent link">#
</a></h3>
2182 <p>The
<code>{js}
</code> template-plugin has been updated to include support for tiny builds controlled through the optional flag
<code>hasTiny=true
</code>:
</p>
2183 <div class=
"highlight"><pre><span></span><code>{js application=
'wcf
' file=
'WCF.Example
' hasTiny=true}
2185 <p>This line generates a different output depending on the debug mode and the user login-state.
</p>
2186 <h2 id=
"real-error-messages-for-ajax-responses">Real Error Messages for AJAX Responses
<a class=
"headerlink" href=
"#real-error-messages-for-ajax-responses" title=
"Permanent link">#
</a></h2>
2187 <p>The
<code>errorMessage
</code> property in the returned response object for failed AJAX requests contained an exception-specific but still highly generic error message. This issue has been around for quite a long time and countless of implementations are relying on this false behavior, eventually forcing us to leave the value unchanged.
</p>
2188 <p>This problem is solved by adding the new property
<code>realErrorMessage
</code> that exposes the message exactly as it was provided and now matches the value that would be displayed to users in traditional forms.
</p>
2189 <h3 id=
"example-code">Example Code
<a class=
"headerlink" href=
"#example-code" title=
"Permanent link">#
</a></h3>
2190 <div class=
"highlight"><pre><span></span><code><span class=
"nx">define
</span><span class=
"p">([
</span><span class=
"s1">'Ajax
'</span><span class=
"p">],
</span> <span class=
"kd">function
</span><span class=
"p">(
</span><span class=
"nx">Ajax
</span><span class=
"p">)
</span> <span class=
"p">{
</span>
2191 <span class=
"k">return
</span> <span class=
"p">{
</span>
2192 <span class=
"c1">// ...
</span>
2193 <span class=
"nx">_ajaxFailure
</span><span class=
"o">:
</span> <span class=
"kd">function
</span><span class=
"p">(
</span><span class=
"nx">responseData
</span><span class=
"p">,
</span> <span class=
"nx">responseText
</span><span class=
"p">,
</span> <span class=
"nx">xhr
</span><span class=
"p">,
</span> <span class=
"nx">requestData
</span><span class=
"p">)
</span> <span class=
"p">{
</span>
2194 <span class=
"nx">console
</span><span class=
"p">.
</span><span class=
"nx">log
</span><span class=
"p">(
</span><span class=
"nx">responseData
</span><span class=
"p">.
</span><span class=
"nx">realErrorMessage
</span><span class=
"p">);
</span>
2195 <span class=
"p">}
</span>
2196 <span class=
"c1">// ...
</span>
2197 <span class=
"p">};
</span>
2198 <span class=
"p">});
</span>
2200 <h2 id=
"simplified-form-submit-in-dialogs">Simplified Form Submit in Dialogs
<a class=
"headerlink" href=
"#simplified-form-submit-in-dialogs" title=
"Permanent link">#
</a></h2>
2201 <p>Forms embedded in dialogs often do not contain the HTML
<code><form
></code>-element and instead rely on JavaScript click- and key-handlers to emulate a
<code><form
></code>-like submit behavior. This has spawned a great amount of nearly identical implementations that all aim to handle the form submit through the
<code>Enter
</code>-key, still leaving some dialogs behind.
</p>
2202 <p>WoltLab Suite
3.1 offers automatic form submit that is enabled through a set of specific conditions and data attributes:
</p>
2204 <li>There must be a submit button that matches the selector
<code>.formSubmit
> input[
type=
"submit"], .formSubmit
> button[
data-type=
"submit"]
</code>.
</li>
2205 <li>The dialog object provided to
<code>UiDialog.open()
</code> implements the method
<code>_dialogSubmit()
</code>.
</li>
2206 <li>Input fields require the attribute
<code>data-dialog-submit-on-enter=
"true"</code> to be set, the
<code>type
</code> must be one of
<code>number
</code>,
<code>password
</code>,
<code>search
</code>,
<code>tel
</code>,
<code>text
</code> or
<code>url
</code>.
</li>
2208 <p>Clicking on the submit button or pressing the
<code>Enter
</code>-key in any watched input field will start the submit process. This is done automatically and does not require a manual interaction in your code, therefore you should not bind any click listeners on the submit button yourself.
</p>
2209 <p>Any input field with the
<code>required
</code> attribute set will be validated to contain a non-empty string after processing the value with
<code>String.prototype.trim()
</code>. An empty field will abort the submit process and display a visible error message next to the offending field.
</p>
2210 <h2 id=
"helper-function-for-inline-error-messages">Helper Function for Inline Error Messages
<a class=
"headerlink" href=
"#helper-function-for-inline-error-messages" title=
"Permanent link">#
</a></h2>
2211 <p>Displaying inline error messages on-the-fly required quite a few DOM operations that were quite simple but also super repetitive and thus error-prone when incorrectly copied over. The global helper function
<code>elInnerError()
</code> was added to provide a simple and consistent behavior of inline error messages.
</p>
2212 <p>You can display an error message by invoking
<code>elInnerError(elementRef,
"Your Error Message")
</code>, it will insert a new
<code><small
class=
"innerError"></code> and sets the given message. If there is already an inner error present, then the message will be replaced instead.
</p>
2213 <p>Hiding messages is done by setting the
2nd parameter to
<code>false
</code> or an empty string:
</p>
2215 <li><code>elInnerError(elementRef, false)
</code></li>
2216 <li><code>elInnerError(elementRef, '')
</code></li>
2218 <p>The special values
<code>null
</code> and
<code>undefined
</code> are supported too, but their usage is discouraged, because they make it harder to understand the intention by reading the code:
</p>
2220 <li><code>elInnerError(elementRef, null)
</code></li>
2221 <li><code>elInnerError(elementRef)
</code></li>
2223 <h3 id=
"example-code_1">Example Code
<a class=
"headerlink" href=
"#example-code_1" title=
"Permanent link">#
</a></h3>
2224 <div class=
"highlight"><pre><span></span><code><span class=
"nx">require
</span><span class=
"p">([
</span><span class=
"s1">'Language
'</span><span class=
"p">],
</span> <span class=
"kd">function
</span><span class=
"p">(
</span><span class=
"nx">Language
</span><span class=
"p">))
</span> <span class=
"p">{
</span>
2225 <span class=
"kd">var
</span> <span class=
"nx">input
</span> <span class=
"o">=
</span> <span class=
"nx">elBySel
</span><span class=
"p">(
</span><span class=
"s1">'input[type=
"text
"]
'</span><span class=
"p">);
</span>
2226 <span class=
"k">if
</span> <span class=
"p">(
</span><span class=
"nx">input
</span><span class=
"p">.
</span><span class=
"nx">value
</span><span class=
"p">.
</span><span class=
"nx">trim
</span><span class=
"p">()
</span> <span class=
"o">===
</span> <span class=
"s1">''</span><span class=
"p">)
</span> <span class=
"p">{
</span>
2227 <span class=
"c1">// displays a new inline error or replaces the message if there is one already
</span>
2228 <span class=
"nx">elInnerError
</span><span class=
"p">(
</span><span class=
"nx">input
</span><span class=
"p">,
</span> <span class=
"nx">Language
</span><span class=
"p">.
</span><span class=
"nx">get
</span><span class=
"p">(
</span><span class=
"s1">'wcf.global.form.error.empty
'</span><span class=
"p">));
</span>
2229 <span class=
"p">}
</span>
2230 <span class=
"k">else
</span> <span class=
"p">{
</span>
2231 <span class=
"c1">// removes the inline error if it exists
</span>
2232 <span class=
"nx">elInnerError
</span><span class=
"p">(
</span><span class=
"nx">input
</span><span class=
"p">,
</span> <span class=
"kc">false
</span><span class=
"p">);
</span>
2233 <span class=
"p">}
</span>
2235 <span class=
"c1">// the above condition is equivalent to this:
</span>
2236 <span class=
"nx">elInnerError
</span><span class=
"p">(
</span><span class=
"nx">input
</span><span class=
"p">,
</span> <span class=
"p">(
</span><span class=
"nx">input
</span><span class=
"p">.
</span><span class=
"nx">value
</span><span class=
"p">.
</span><span class=
"nx">trim
</span><span class=
"p">()
</span> <span class=
"o">===
</span> <span class=
"s1">''</span> <span class=
"o">?
</span> <span class=
"nx">Language
</span><span class=
"p">.
</span><span class=
"nx">get
</span><span class=
"p">(
</span><span class=
"s1">'wcf.global.form.error.empty
'</span><span class=
"p">)
</span> <span class=
"o">:
</span> <span class=
"kc">false
</span><span class=
"p">));
</span>
2237 <span class=
"p">}
</span>
2244 <div class=
"md-source-date">
2247 Last update:
2021-
01-
08
2266 <footer class=
"md-footer">
2268 <nav class=
"md-footer__inner md-grid" aria-label=
"Footer">
2270 <a href=
"../php/" class=
"md-footer__link md-footer__link--prev" rel=
"prev">
2271 <div class=
"md-footer__button md-icon">
2272 <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>
2274 <div class=
"md-footer__title">
2275 <div class=
"md-ellipsis">
2276 <span class=
"md-footer__direction">
2285 <a href=
"../templates/" class=
"md-footer__link md-footer__link--next" rel=
"next">
2286 <div class=
"md-footer__title">
2287 <div class=
"md-ellipsis">
2288 <span class=
"md-footer__direction">
2294 <div class=
"md-footer__button md-icon">
2295 <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>
2301 <div class=
"md-footer-meta md-typeset">
2302 <div class=
"md-footer-meta__inner md-grid">
2303 <div class=
"md-footer-copyright">
2305 <div class=
"md-footer-copyright__highlight">
2306 Copyright ©
2020 WoltLab GmbH
2310 <a href=
"https://squidfunk.github.io/mkdocs-material/" target=
"_blank" rel=
"noopener">
2315 <div class=
"md-footer-copyright">
2316 <a href=
"https://www.woltlab.com/legal-notice/">Legal Notice
</a>
2317 <a href=
"https://www.woltlab.com/privacy-policy/">Privacy Policy
</a>
2324 <div class=
"md-dialog" data-md-component=
"dialog">
2325 <div class=
"md-dialog__inner md-typeset"></div>
2327 <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>
2330 <script src=
"../../../assets/javascripts/bundle.d892486b.min.js"></script>