3 <html lang=
"en" class=
"no-js">
7 <meta name=
"viewport" content=
"width=device-width,initial-scale=1">
11 <link rel=
"canonical" href=
"https://docs.woltlab.com/6.0/migration/wsc54/javascript/">
14 <link rel=
"prev" href=
"../php/">
17 <link rel=
"next" href=
"../templates/">
19 <link rel=
"icon" href=
"../../../assets/default.favicon.ico">
20 <meta name=
"generator" content=
"mkdocs-1.4.2, mkdocs-material-9.0.9">
24 <title>TypeScript and JavaScript - WoltLab Suite Documentation
</title>
28 <link rel=
"stylesheet" href=
"../../../assets/stylesheets/main.0d440cfe.min.css">
31 <link rel=
"stylesheet" href=
"../../../assets/stylesheets/palette.2505c338.min.css">
41 <link rel=
"stylesheet" href=
"../../../stylesheets/extra.css">
43 <script>__md_scope=new URL(
"../../..",location),__md_hash=e=
>[...e].reduce((e,_)=
>(e<
<5)-e+_.charCodeAt(
0),
0),__md_get=(e,_=localStorage,t=__md_scope)=
>JSON.parse(_.getItem(t.pathname+
"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=
>{try{t.setItem(a.pathname+
"."+e,JSON.stringify(_))}catch(e){}}
</script>
58 <body dir=
"ltr" data-md-color-scheme=
"default" data-md-color-primary=
"teal" data-md-color-accent=
"">
62 <input class=
"md-toggle" data-md-toggle=
"drawer" type=
"checkbox" id=
"__drawer" autocomplete=
"off">
63 <input class=
"md-toggle" data-md-toggle=
"search" type=
"checkbox" id=
"__search" autocomplete=
"off">
64 <label class=
"md-overlay" for=
"__drawer"></label>
65 <div data-md-component=
"skip">
68 <a href=
"#migrating-from-woltlab-suite-54-typescript-and-javascript" class=
"md-skip">
73 <div data-md-component=
"announce">
75 <aside class=
"md-banner">
76 <div class=
"md-banner__inner md-grid md-typeset">
79 <a href=
"https://www.woltlab.com">Back to
<strong>woltlab.com
</strong></a>
87 <div data-md-component=
"outdated" hidden
>
94 <header class=
"md-header" data-md-component=
"header">
95 <nav class=
"md-header__inner md-grid" aria-label=
"Header">
96 <a href=
"../../.." title=
"WoltLab Suite Documentation" class=
"md-header__button md-logo" aria-label=
"WoltLab Suite Documentation" data-md-component=
"logo">
98 <img src=
"../../../assets/logo.png" alt=
"logo">
101 <label class=
"md-header__button md-icon" for=
"__drawer">
102 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg>
104 <div class=
"md-header__title" data-md-component=
"header-title">
105 <div class=
"md-header__ellipsis">
106 <div class=
"md-header__topic">
107 <span class=
"md-ellipsis">
108 WoltLab Suite Documentation
111 <div class=
"md-header__topic" data-md-component=
"header-topic">
112 <span class=
"md-ellipsis">
114 TypeScript and JavaScript
123 <label class=
"md-header__button md-icon" for=
"__search">
124 <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>
126 <div class=
"md-search" data-md-component=
"search" role=
"dialog">
127 <label class=
"md-search__overlay" for=
"__search"></label>
128 <div class=
"md-search__inner" role=
"search">
129 <form class=
"md-search__form" name=
"search">
130 <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" required
>
131 <label class=
"md-search__icon md-icon" for=
"__search">
132 <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>
133 <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>
135 <nav class=
"md-search__options" aria-label=
"Search">
137 <button type=
"reset" class=
"md-search__icon md-icon" title=
"Clear" aria-label=
"Clear" tabindex=
"-1">
138 <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>
143 <div class=
"md-search__output">
144 <div class=
"md-search__scrollwrap" data-md-scrollfix
>
145 <div class=
"md-search-result" data-md-component=
"search-result">
146 <div class=
"md-search-result__meta">
149 <ol class=
"md-search-result__list" role=
"presentation"></ol>
157 <div class=
"md-header__source">
158 <a href=
"https://github.com/WoltLab/docs.woltlab.com/" title=
"Go to repository" class=
"md-source" data-md-component=
"source">
159 <div class=
"md-source__icon md-icon">
161 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 448 512"><!--! Font Awesome Free 6.2.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc.--><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>
163 <div class=
"md-source__repository">
173 <div class=
"md-container" data-md-component=
"container">
180 <main class=
"md-main" data-md-component=
"main">
181 <div class=
"md-main__inner md-grid">
185 <div class=
"md-sidebar md-sidebar--primary" data-md-component=
"sidebar" data-md-type=
"navigation" >
186 <div class=
"md-sidebar__scrollwrap">
187 <div class=
"md-sidebar__inner">
191 <nav class=
"md-nav md-nav--primary" aria-label=
"Navigation" data-md-level=
"0">
192 <label class=
"md-nav__title" for=
"__drawer">
193 <a href=
"../../.." title=
"WoltLab Suite Documentation" class=
"md-nav__button md-logo" aria-label=
"WoltLab Suite Documentation" data-md-component=
"logo">
195 <img src=
"../../../assets/logo.png" alt=
"logo">
198 WoltLab Suite Documentation
201 <div class=
"md-nav__source">
202 <a href=
"https://github.com/WoltLab/docs.woltlab.com/" title=
"Go to repository" class=
"md-source" data-md-component=
"source">
203 <div class=
"md-source__icon md-icon">
205 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 448 512"><!--! Font Awesome Free 6.2.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc.--><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>
207 <div class=
"md-source__repository">
213 <ul class=
"md-nav__list" data-md-scrollfix
>
222 <li class=
"md-nav__item">
223 <a href=
"../../../getting-started/" class=
"md-nav__link">
238 <li class=
"md-nav__item md-nav__item--nested">
243 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_2" >
247 <label class=
"md-nav__link" for=
"__nav_2" id=
"__nav_2_label" tabindex=
"0">
249 <span class=
"md-nav__icon md-icon"></span>
252 <nav class=
"md-nav" data-md-level=
"1" aria-labelledby=
"__nav_2_label" aria-expanded=
"false">
253 <label class=
"md-nav__title" for=
"__nav_2">
254 <span class=
"md-nav__icon md-icon"></span>
257 <ul class=
"md-nav__list" data-md-scrollfix
>
264 <li class=
"md-nav__item">
265 <a href=
"../../../php/pages/" class=
"md-nav__link">
278 <li class=
"md-nav__item">
279 <a href=
"../../../php/database-objects/" class=
"md-nav__link">
292 <li class=
"md-nav__item">
293 <a href=
"../../../php/database-access/" class=
"md-nav__link">
306 <li class=
"md-nav__item">
307 <a href=
"../../../php/exceptions/" class=
"md-nav__link">
321 <li class=
"md-nav__item md-nav__item--nested">
326 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_2_5" >
330 <label class=
"md-nav__link" for=
"__nav_2_5" id=
"__nav_2_5_label" tabindex=
"0">
332 <span class=
"md-nav__icon md-icon"></span>
335 <nav class=
"md-nav" data-md-level=
"2" aria-labelledby=
"__nav_2_5_label" aria-expanded=
"false">
336 <label class=
"md-nav__title" for=
"__nav_2_5">
337 <span class=
"md-nav__icon md-icon"></span>
340 <ul class=
"md-nav__list" data-md-scrollfix
>
348 <li class=
"md-nav__item md-nav__item--nested">
353 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_2_5_1" >
357 <label class=
"md-nav__link" for=
"__nav_2_5_1" id=
"__nav_2_5_1_label" tabindex=
"0">
359 <span class=
"md-nav__icon md-icon"></span>
362 <nav class=
"md-nav" data-md-level=
"3" aria-labelledby=
"__nav_2_5_1_label" aria-expanded=
"false">
363 <label class=
"md-nav__title" for=
"__nav_2_5_1">
364 <span class=
"md-nav__icon md-icon"></span>
367 <ul class=
"md-nav__list" data-md-scrollfix
>
374 <li class=
"md-nav__item">
375 <a href=
"../../../php/api/caches/" class=
"md-nav__link">
388 <li class=
"md-nav__item">
389 <a href=
"../../../php/api/caches_persistent-caches/" class=
"md-nav__link">
402 <li class=
"md-nav__item">
403 <a href=
"../../../php/api/caches_runtime-caches/" class=
"md-nav__link">
423 <li class=
"md-nav__item">
424 <a href=
"../../../php/api/comments/" class=
"md-nav__link">
437 <li class=
"md-nav__item">
438 <a href=
"../../../php/api/cronjobs/" class=
"md-nav__link">
451 <li class=
"md-nav__item">
452 <a href=
"../../../php/api/events/" class=
"md-nav__link">
466 <li class=
"md-nav__item md-nav__item--nested">
471 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_2_5_5" >
475 <label class=
"md-nav__link" for=
"__nav_2_5_5" id=
"__nav_2_5_5_label" tabindex=
"0">
477 <span class=
"md-nav__icon md-icon"></span>
480 <nav class=
"md-nav" data-md-level=
"3" aria-labelledby=
"__nav_2_5_5_label" aria-expanded=
"false">
481 <label class=
"md-nav__title" for=
"__nav_2_5_5">
482 <span class=
"md-nav__icon md-icon"></span>
485 <ul class=
"md-nav__list" data-md-scrollfix
>
492 <li class=
"md-nav__item">
493 <a href=
"../../../php/api/form_builder/overview/" class=
"md-nav__link">
506 <li class=
"md-nav__item">
507 <a href=
"../../../php/api/form_builder/structure/" class=
"md-nav__link">
520 <li class=
"md-nav__item">
521 <a href=
"../../../php/api/form_builder/form_fields/" class=
"md-nav__link">
534 <li class=
"md-nav__item">
535 <a href=
"../../../php/api/form_builder/validation_data/" class=
"md-nav__link">
548 <li class=
"md-nav__item">
549 <a href=
"../../../php/api/form_builder/dependencies/" class=
"md-nav__link">
569 <li class=
"md-nav__item">
570 <a href=
"../../../php/api/package_installation_plugins/" class=
"md-nav__link">
571 Package Installation Plugins
583 <li class=
"md-nav__item">
584 <a href=
"../../../php/api/user_activity_points/" class=
"md-nav__link">
597 <li class=
"md-nav__item">
598 <a href=
"../../../php/api/user_notifications/" class=
"md-nav__link">
611 <li class=
"md-nav__item">
612 <a href=
"../../../php/api/sitemaps/" class=
"md-nav__link">
632 <li class=
"md-nav__item">
633 <a href=
"../../../php/code-style/" class=
"md-nav__link">
646 <li class=
"md-nav__item">
647 <a href=
"../../../php/apps/" class=
"md-nav__link">
660 <li class=
"md-nav__item">
661 <a href=
"../../../php/gdpr/" class=
"md-nav__link">
683 <li class=
"md-nav__item md-nav__item--nested">
688 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_3" >
692 <label class=
"md-nav__link" for=
"__nav_3" id=
"__nav_3_label" tabindex=
"0">
693 Languages, Templates & CSS
694 <span class=
"md-nav__icon md-icon"></span>
697 <nav class=
"md-nav" data-md-level=
"1" aria-labelledby=
"__nav_3_label" aria-expanded=
"false">
698 <label class=
"md-nav__title" for=
"__nav_3">
699 <span class=
"md-nav__icon md-icon"></span>
700 Languages, Templates & CSS
702 <ul class=
"md-nav__list" data-md-scrollfix
>
709 <li class=
"md-nav__item">
710 <a href=
"../../../view/languages/" class=
"md-nav__link">
723 <li class=
"md-nav__item">
724 <a href=
"../../../view/templates/" class=
"md-nav__link">
737 <li class=
"md-nav__item">
738 <a href=
"../../../view/template-plugins/" class=
"md-nav__link">
751 <li class=
"md-nav__item">
752 <a href=
"../../../view/css/" class=
"md-nav__link">
774 <li class=
"md-nav__item md-nav__item--nested">
779 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_4" >
783 <label class=
"md-nav__link" for=
"__nav_4" id=
"__nav_4_label" tabindex=
"0">
784 TypeScript and JavaScript API
785 <span class=
"md-nav__icon md-icon"></span>
788 <nav class=
"md-nav" data-md-level=
"1" aria-labelledby=
"__nav_4_label" aria-expanded=
"false">
789 <label class=
"md-nav__title" for=
"__nav_4">
790 <span class=
"md-nav__icon md-icon"></span>
791 TypeScript and JavaScript API
793 <ul class=
"md-nav__list" data-md-scrollfix
>
800 <li class=
"md-nav__item">
801 <a href=
"../../../javascript/general-usage/" class=
"md-nav__link">
814 <li class=
"md-nav__item">
815 <a href=
"../../../javascript/typescript/" class=
"md-nav__link">
829 <li class=
"md-nav__item md-nav__item--nested">
834 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_4_3" >
838 <label class=
"md-nav__link" for=
"__nav_4_3" id=
"__nav_4_3_label" tabindex=
"0">
840 <span class=
"md-nav__icon md-icon"></span>
843 <nav class=
"md-nav" data-md-level=
"2" aria-labelledby=
"__nav_4_3_label" aria-expanded=
"false">
844 <label class=
"md-nav__title" for=
"__nav_4_3">
845 <span class=
"md-nav__icon md-icon"></span>
848 <ul class=
"md-nav__list" data-md-scrollfix
>
855 <li class=
"md-nav__item">
856 <a href=
"../../../javascript/components_confirmation/" class=
"md-nav__link">
869 <li class=
"md-nav__item">
870 <a href=
"../../../javascript/components_dialog/" class=
"md-nav__link">
883 <li class=
"md-nav__item">
884 <a href=
"../../../javascript/components_google_maps/" class=
"md-nav__link">
897 <li class=
"md-nav__item">
898 <a href=
"../../../javascript/components_pagination/" class=
"md-nav__link">
919 <li class=
"md-nav__item md-nav__item--nested">
924 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_4_4" >
928 <label class=
"md-nav__link" for=
"__nav_4_4" id=
"__nav_4_4_label" tabindex=
"0">
930 <span class=
"md-nav__icon md-icon"></span>
933 <nav class=
"md-nav" data-md-level=
"2" aria-labelledby=
"__nav_4_4_label" aria-expanded=
"false">
934 <label class=
"md-nav__title" for=
"__nav_4_4">
935 <span class=
"md-nav__icon md-icon"></span>
938 <ul class=
"md-nav__list" data-md-scrollfix
>
945 <li class=
"md-nav__item">
946 <a href=
"../../../javascript/new-api_writing-a-module/" class=
"md-nav__link">
959 <li class=
"md-nav__item">
960 <a href=
"../../../javascript/new-api_core/" class=
"md-nav__link">
973 <li class=
"md-nav__item">
974 <a href=
"../../../javascript/new-api_dom/" class=
"md-nav__link">
987 <li class=
"md-nav__item">
988 <a href=
"../../../javascript/new-api_events/" class=
"md-nav__link">
1001 <li class=
"md-nav__item">
1002 <a href=
"../../../javascript/new-api_ajax/" class=
"md-nav__link">
1015 <li class=
"md-nav__item">
1016 <a href=
"../../../javascript/new-api_dialogs/" class=
"md-nav__link">
1029 <li class=
"md-nav__item">
1030 <a href=
"../../../javascript/new-api_browser/" class=
"md-nav__link">
1031 Browser and Screen Sizes
1043 <li class=
"md-nav__item">
1044 <a href=
"../../../javascript/new-api_ui/" class=
"md-nav__link">
1064 <li class=
"md-nav__item">
1065 <a href=
"../../../javascript/legacy-api/" class=
"md-nav__link">
1078 <li class=
"md-nav__item">
1079 <a href=
"../../../javascript/code-snippets/" class=
"md-nav__link">
1101 <li class=
"md-nav__item md-nav__item--nested">
1106 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_5" >
1110 <label class=
"md-nav__link" for=
"__nav_5" id=
"__nav_5_label" tabindex=
"0">
1112 <span class=
"md-nav__icon md-icon"></span>
1115 <nav class=
"md-nav" data-md-level=
"1" aria-labelledby=
"__nav_5_label" aria-expanded=
"false">
1116 <label class=
"md-nav__title" for=
"__nav_5">
1117 <span class=
"md-nav__icon md-icon"></span>
1120 <ul class=
"md-nav__list" data-md-scrollfix
>
1127 <li class=
"md-nav__item">
1128 <a href=
"../../../package/package-xml/" class=
"md-nav__link">
1142 <li class=
"md-nav__item md-nav__item--nested">
1147 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_5_2" >
1151 <label class=
"md-nav__link" for=
"__nav_5_2" id=
"__nav_5_2_label" tabindex=
"0">
1153 <span class=
"md-nav__icon md-icon"></span>
1156 <nav class=
"md-nav" data-md-level=
"2" aria-labelledby=
"__nav_5_2_label" aria-expanded=
"false">
1157 <label class=
"md-nav__title" for=
"__nav_5_2">
1158 <span class=
"md-nav__icon md-icon"></span>
1161 <ul class=
"md-nav__list" data-md-scrollfix
>
1168 <li class=
"md-nav__item">
1169 <a href=
"../../../package/pip/" class=
"md-nav__link">
1182 <li class=
"md-nav__item">
1183 <a href=
"../../../package/pip/acl-option/" class=
"md-nav__link">
1196 <li class=
"md-nav__item">
1197 <a href=
"../../../package/pip/acp-menu/" class=
"md-nav__link">
1210 <li class=
"md-nav__item">
1211 <a href=
"../../../package/pip/acp-search-provider/" class=
"md-nav__link">
1224 <li class=
"md-nav__item">
1225 <a href=
"../../../package/pip/acp-template/" class=
"md-nav__link">
1238 <li class=
"md-nav__item">
1239 <a href=
"../../../package/pip/acp-template-delete/" class=
"md-nav__link">
1252 <li class=
"md-nav__item">
1253 <a href=
"../../../package/pip/bbcode/" class=
"md-nav__link">
1266 <li class=
"md-nav__item">
1267 <a href=
"../../../package/pip/box/" class=
"md-nav__link">
1280 <li class=
"md-nav__item">
1281 <a href=
"../../../package/pip/clipboard-action/" class=
"md-nav__link">
1294 <li class=
"md-nav__item">
1295 <a href=
"../../../package/pip/core-object/" class=
"md-nav__link">
1308 <li class=
"md-nav__item">
1309 <a href=
"../../../package/pip/cronjob/" class=
"md-nav__link">
1322 <li class=
"md-nav__item">
1323 <a href=
"../../../package/pip/database/" class=
"md-nav__link">
1336 <li class=
"md-nav__item">
1337 <a href=
"../../../package/pip/event-listener/" class=
"md-nav__link">
1350 <li class=
"md-nav__item">
1351 <a href=
"../../../package/pip/file/" class=
"md-nav__link">
1364 <li class=
"md-nav__item">
1365 <a href=
"../../../package/pip/file-delete/" class=
"md-nav__link">
1378 <li class=
"md-nav__item">
1379 <a href=
"../../../package/pip/language/" class=
"md-nav__link">
1392 <li class=
"md-nav__item">
1393 <a href=
"../../../package/pip/media-provider/" class=
"md-nav__link">
1406 <li class=
"md-nav__item">
1407 <a href=
"../../../package/pip/menu/" class=
"md-nav__link">
1420 <li class=
"md-nav__item">
1421 <a href=
"../../../package/pip/menu-item/" class=
"md-nav__link">
1434 <li class=
"md-nav__item">
1435 <a href=
"../../../package/pip/object-type/" class=
"md-nav__link">
1448 <li class=
"md-nav__item">
1449 <a href=
"../../../package/pip/object-type-definition/" class=
"md-nav__link">
1450 objectTypeDefinition
1462 <li class=
"md-nav__item">
1463 <a href=
"../../../package/pip/option/" class=
"md-nav__link">
1476 <li class=
"md-nav__item">
1477 <a href=
"../../../package/pip/page/" class=
"md-nav__link">
1490 <li class=
"md-nav__item">
1491 <a href=
"../../../package/pip/pip/" class=
"md-nav__link">
1504 <li class=
"md-nav__item">
1505 <a href=
"../../../package/pip/script/" class=
"md-nav__link">
1518 <li class=
"md-nav__item">
1519 <a href=
"../../../package/pip/smiley/" class=
"md-nav__link">
1532 <li class=
"md-nav__item">
1533 <a href=
"../../../package/pip/sql/" class=
"md-nav__link">
1546 <li class=
"md-nav__item">
1547 <a href=
"../../../package/pip/style/" class=
"md-nav__link">
1560 <li class=
"md-nav__item">
1561 <a href=
"../../../package/pip/template/" class=
"md-nav__link">
1574 <li class=
"md-nav__item">
1575 <a href=
"../../../package/pip/template-delete/" class=
"md-nav__link">
1588 <li class=
"md-nav__item">
1589 <a href=
"../../../package/pip/template-listener/" class=
"md-nav__link">
1602 <li class=
"md-nav__item">
1603 <a href=
"../../../package/pip/user-group-option/" class=
"md-nav__link">
1616 <li class=
"md-nav__item">
1617 <a href=
"../../../package/pip/user-menu/" class=
"md-nav__link">
1630 <li class=
"md-nav__item">
1631 <a href=
"../../../package/pip/user-notification-event/" class=
"md-nav__link">
1632 userNotificationEvent
1644 <li class=
"md-nav__item">
1645 <a href=
"../../../package/pip/user-option/" class=
"md-nav__link">
1658 <li class=
"md-nav__item">
1659 <a href=
"../../../package/pip/user-profile-menu/" class=
"md-nav__link">
1679 <li class=
"md-nav__item">
1680 <a href=
"../../../package/database-php-api/" class=
"md-nav__link">
1704 <li class=
"md-nav__item md-nav__item--active md-nav__item--nested">
1709 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_6" checked
>
1713 <label class=
"md-nav__link" for=
"__nav_6" id=
"__nav_6_label" tabindex=
"0">
1715 <span class=
"md-nav__icon md-icon"></span>
1718 <nav class=
"md-nav" data-md-level=
"1" aria-labelledby=
"__nav_6_label" aria-expanded=
"true">
1719 <label class=
"md-nav__title" for=
"__nav_6">
1720 <span class=
"md-nav__icon md-icon"></span>
1723 <ul class=
"md-nav__list" data-md-scrollfix
>
1731 <li class=
"md-nav__item md-nav__item--nested">
1736 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_6_1" >
1740 <label class=
"md-nav__link" for=
"__nav_6_1" id=
"__nav_6_1_label" tabindex=
"0">
1741 From WoltLab Suite
5.5
1742 <span class=
"md-nav__icon md-icon"></span>
1745 <nav class=
"md-nav" data-md-level=
"2" aria-labelledby=
"__nav_6_1_label" aria-expanded=
"false">
1746 <label class=
"md-nav__title" for=
"__nav_6_1">
1747 <span class=
"md-nav__icon md-icon"></span>
1748 From WoltLab Suite
5.5
1750 <ul class=
"md-nav__list" data-md-scrollfix
>
1757 <li class=
"md-nav__item">
1758 <a href=
"../../wsc55/php/" class=
"md-nav__link">
1771 <li class=
"md-nav__item">
1772 <a href=
"../../wsc55/javascript/" class=
"md-nav__link">
1773 TypeScript and JavaScript
1785 <li class=
"md-nav__item">
1786 <a href=
"../../wsc55/templates/" class=
"md-nav__link">
1799 <li class=
"md-nav__item">
1800 <a href=
"../../wsc55/icons/" class=
"md-nav__link">
1813 <li class=
"md-nav__item">
1814 <a href=
"../../wsc55/dialogs/" class=
"md-nav__link">
1827 <li class=
"md-nav__item">
1828 <a href=
"../../wsc55/libraries/" class=
"md-nav__link">
1829 Third Party Libraries
1841 <li class=
"md-nav__item">
1842 <a href=
"../../wsc55/deprecations_removals/" class=
"md-nav__link">
1843 Deprecations and Removals
1865 <li class=
"md-nav__item md-nav__item--active md-nav__item--nested">
1870 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_6_2" checked
>
1874 <label class=
"md-nav__link" for=
"__nav_6_2" id=
"__nav_6_2_label" tabindex=
"0">
1875 From WoltLab Suite
5.4
1876 <span class=
"md-nav__icon md-icon"></span>
1879 <nav class=
"md-nav" data-md-level=
"2" aria-labelledby=
"__nav_6_2_label" aria-expanded=
"true">
1880 <label class=
"md-nav__title" for=
"__nav_6_2">
1881 <span class=
"md-nav__icon md-icon"></span>
1882 From WoltLab Suite
5.4
1884 <ul class=
"md-nav__list" data-md-scrollfix
>
1891 <li class=
"md-nav__item">
1892 <a href=
"../php/" class=
"md-nav__link">
1907 <li class=
"md-nav__item md-nav__item--active">
1909 <input class=
"md-nav__toggle md-toggle" type=
"checkbox" id=
"__toc">
1915 <label class=
"md-nav__link md-nav__link--active" for=
"__toc">
1916 TypeScript and JavaScript
1917 <span class=
"md-nav__icon md-icon"></span>
1920 <a href=
"./" class=
"md-nav__link md-nav__link--active">
1921 TypeScript and JavaScript
1926 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
1933 <label class=
"md-nav__title" for=
"__toc">
1934 <span class=
"md-nav__icon md-icon"></span>
1937 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
1939 <li class=
"md-nav__item">
1940 <a href=
"#ajaxdboaction" class=
"md-nav__link">
1946 <li class=
"md-nav__item">
1947 <a href=
"#wcfcolorpicker" class=
"md-nav__link">
1953 <li class=
"md-nav__item">
1954 <a href=
"#codemirror" class=
"md-nav__link">
1960 <li class=
"md-nav__item">
1961 <a href=
"#new-user-menu" class=
"md-nav__link">
1981 <li class=
"md-nav__item">
1982 <a href=
"../templates/" class=
"md-nav__link">
1995 <li class=
"md-nav__item">
1996 <a href=
"../libraries/" class=
"md-nav__link">
1997 Third Party Libraries
2009 <li class=
"md-nav__item">
2010 <a href=
"../deprecations_removals/" class=
"md-nav__link">
2011 Deprecations and Removals
2031 <li class=
"md-nav__item md-nav__item--nested">
2036 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_6_3" >
2040 <label class=
"md-nav__link" for=
"__nav_6_3" id=
"__nav_6_3_label" tabindex=
"0">
2041 From WoltLab Suite
5.3
2042 <span class=
"md-nav__icon md-icon"></span>
2045 <nav class=
"md-nav" data-md-level=
"2" aria-labelledby=
"__nav_6_3_label" aria-expanded=
"false">
2046 <label class=
"md-nav__title" for=
"__nav_6_3">
2047 <span class=
"md-nav__icon md-icon"></span>
2048 From WoltLab Suite
5.3
2050 <ul class=
"md-nav__list" data-md-scrollfix
>
2057 <li class=
"md-nav__item">
2058 <a href=
"../../wsc53/php/" class=
"md-nav__link">
2071 <li class=
"md-nav__item">
2072 <a href=
"../../wsc53/session/" class=
"md-nav__link">
2073 Session Handling and Authentication
2085 <li class=
"md-nav__item">
2086 <a href=
"../../wsc53/javascript/" class=
"md-nav__link">
2087 TypeScript and JavaScript
2099 <li class=
"md-nav__item">
2100 <a href=
"../../wsc53/templates/" class=
"md-nav__link">
2113 <li class=
"md-nav__item">
2114 <a href=
"../../wsc53/libraries/" class=
"md-nav__link">
2115 Third Party Libraries
2135 <li class=
"md-nav__item md-nav__item--nested">
2140 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_6_4" >
2144 <label class=
"md-nav__link" for=
"__nav_6_4" id=
"__nav_6_4_label" tabindex=
"0">
2145 From WoltLab Suite
5.2
2146 <span class=
"md-nav__icon md-icon"></span>
2149 <nav class=
"md-nav" data-md-level=
"2" aria-labelledby=
"__nav_6_4_label" aria-expanded=
"false">
2150 <label class=
"md-nav__title" for=
"__nav_6_4">
2151 <span class=
"md-nav__icon md-icon"></span>
2152 From WoltLab Suite
5.2
2154 <ul class=
"md-nav__list" data-md-scrollfix
>
2161 <li class=
"md-nav__item">
2162 <a href=
"../../wsc52/php/" class=
"md-nav__link">
2175 <li class=
"md-nav__item">
2176 <a href=
"../../wsc52/templates/" class=
"md-nav__link">
2177 Templates and Languages
2189 <li class=
"md-nav__item">
2190 <a href=
"../../wsc52/libraries/" class=
"md-nav__link">
2191 Third Party Libraries
2211 <li class=
"md-nav__item md-nav__item--nested">
2216 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_6_5" >
2220 <label class=
"md-nav__link" for=
"__nav_6_5" id=
"__nav_6_5_label" tabindex=
"0">
2221 From WoltLab Suite
3.1
2222 <span class=
"md-nav__icon md-icon"></span>
2225 <nav class=
"md-nav" data-md-level=
"2" aria-labelledby=
"__nav_6_5_label" aria-expanded=
"false">
2226 <label class=
"md-nav__title" for=
"__nav_6_5">
2227 <span class=
"md-nav__icon md-icon"></span>
2228 From WoltLab Suite
3.1
2230 <ul class=
"md-nav__list" data-md-scrollfix
>
2237 <li class=
"md-nav__item">
2238 <a href=
"../../wsc31/php/" class=
"md-nav__link">
2259 <li class=
"md-nav__item md-nav__item--nested">
2264 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_6_6" >
2268 <label class=
"md-nav__link" for=
"__nav_6_6" id=
"__nav_6_6_label" tabindex=
"0">
2269 From WoltLab Suite
3.0
2270 <span class=
"md-nav__icon md-icon"></span>
2273 <nav class=
"md-nav" data-md-level=
"2" aria-labelledby=
"__nav_6_6_label" aria-expanded=
"false">
2274 <label class=
"md-nav__title" for=
"__nav_6_6">
2275 <span class=
"md-nav__icon md-icon"></span>
2276 From WoltLab Suite
3.0
2278 <ul class=
"md-nav__list" data-md-scrollfix
>
2285 <li class=
"md-nav__item">
2286 <a href=
"../../wsc30/php/" class=
"md-nav__link">
2299 <li class=
"md-nav__item">
2300 <a href=
"../../wsc30/javascript/" class=
"md-nav__link">
2313 <li class=
"md-nav__item">
2314 <a href=
"../../wsc30/templates/" class=
"md-nav__link">
2327 <li class=
"md-nav__item">
2328 <a href=
"../../wsc30/css/" class=
"md-nav__link">
2341 <li class=
"md-nav__item">
2342 <a href=
"../../wsc30/package/" class=
"md-nav__link">
2363 <li class=
"md-nav__item md-nav__item--nested">
2368 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_6_7" >
2372 <label class=
"md-nav__link" for=
"__nav_6_7" id=
"__nav_6_7_label" tabindex=
"0">
2374 <span class=
"md-nav__icon md-icon"></span>
2377 <nav class=
"md-nav" data-md-level=
"2" aria-labelledby=
"__nav_6_7_label" aria-expanded=
"false">
2378 <label class=
"md-nav__title" for=
"__nav_6_7">
2379 <span class=
"md-nav__icon md-icon"></span>
2382 <ul class=
"md-nav__list" data-md-scrollfix
>
2389 <li class=
"md-nav__item">
2390 <a href=
"../../wcf21/php/" class=
"md-nav__link">
2403 <li class=
"md-nav__item">
2404 <a href=
"../../wcf21/templates/" class=
"md-nav__link">
2417 <li class=
"md-nav__item">
2418 <a href=
"../../wcf21/css/" class=
"md-nav__link">
2431 <li class=
"md-nav__item">
2432 <a href=
"../../wcf21/package/" class=
"md-nav__link">
2461 <li class=
"md-nav__item md-nav__item--nested">
2466 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_7" >
2470 <label class=
"md-nav__link" for=
"__nav_7" id=
"__nav_7_label" tabindex=
"0">
2472 <span class=
"md-nav__icon md-icon"></span>
2475 <nav class=
"md-nav" data-md-level=
"1" aria-labelledby=
"__nav_7_label" aria-expanded=
"false">
2476 <label class=
"md-nav__title" for=
"__nav_7">
2477 <span class=
"md-nav__icon md-icon"></span>
2480 <ul class=
"md-nav__list" data-md-scrollfix
>
2488 <li class=
"md-nav__item md-nav__item--nested">
2493 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_7_1" >
2497 <label class=
"md-nav__link" for=
"__nav_7_1" id=
"__nav_7_1_label" tabindex=
"0">
2499 <span class=
"md-nav__icon md-icon"></span>
2502 <nav class=
"md-nav" data-md-level=
"2" aria-labelledby=
"__nav_7_1_label" aria-expanded=
"false">
2503 <label class=
"md-nav__title" for=
"__nav_7_1">
2504 <span class=
"md-nav__icon md-icon"></span>
2507 <ul class=
"md-nav__list" data-md-scrollfix
>
2514 <li class=
"md-nav__item">
2515 <a href=
"../../../tutorial/series/overview/" class=
"md-nav__link">
2528 <li class=
"md-nav__item">
2529 <a href=
"../../../tutorial/series/part_1/" class=
"md-nav__link">
2542 <li class=
"md-nav__item">
2543 <a href=
"../../../tutorial/series/part_2/" class=
"md-nav__link">
2556 <li class=
"md-nav__item">
2557 <a href=
"../../../tutorial/series/part_3/" class=
"md-nav__link">
2570 <li class=
"md-nav__item">
2571 <a href=
"../../../tutorial/series/part_4/" class=
"md-nav__link">
2584 <li class=
"md-nav__item">
2585 <a href=
"../../../tutorial/series/part_5/" class=
"md-nav__link">
2598 <li class=
"md-nav__item">
2599 <a href=
"../../../tutorial/series/part_6/" class=
"md-nav__link">
2628 <div class=
"md-sidebar md-sidebar--secondary" data-md-component=
"sidebar" data-md-type=
"toc" >
2629 <div class=
"md-sidebar__scrollwrap">
2630 <div class=
"md-sidebar__inner">
2633 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
2640 <label class=
"md-nav__title" for=
"__toc">
2641 <span class=
"md-nav__icon md-icon"></span>
2644 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
2646 <li class=
"md-nav__item">
2647 <a href=
"#ajaxdboaction" class=
"md-nav__link">
2653 <li class=
"md-nav__item">
2654 <a href=
"#wcfcolorpicker" class=
"md-nav__link">
2660 <li class=
"md-nav__item">
2661 <a href=
"#codemirror" class=
"md-nav__link">
2667 <li class=
"md-nav__item">
2668 <a href=
"#new-user-menu" class=
"md-nav__link">
2683 <div class=
"md-content" data-md-component=
"content">
2684 <article class=
"md-content__inner md-typeset">
2693 <h1 id=
"migrating-from-woltlab-suite-54-typescript-and-javascript">Migrating from WoltLab Suite
5.4 - TypeScript and JavaScript
<a class=
"headerlink" href=
"#migrating-from-woltlab-suite-54-typescript-and-javascript" title=
"Permanent link">#
</a></h1>
2694 <h2 id=
"ajaxdboaction"><code>Ajax.dboAction()
</code><a class=
"headerlink" href=
"#ajaxdboaction" title=
"Permanent link">#
</a></h2>
2695 <p>We have introduced a new
<code>Promise
</code> based API for the interaction with
<code>wcf\data\DatabaseObjectAction
</code>.
2696 It provides full IDE autocompletion support and transparent error handling, but is designed to be used with
<code>DatabaseObjectAction
</code> only.
</p>
2697 <p>See
<a href=
"../../../javascript/new-api_ajax/">the documentation for the new API
</a> and
<a href=
"https://github.com/WoltLab/WCF/pull/4585">WoltLab/WCF#
4585</a> for details.
</p>
2698 <h2 id=
"wcfcolorpicker"><code>WCF.ColorPicker
</code><a class=
"headerlink" href=
"#wcfcolorpicker" title=
"Permanent link">#
</a></h2>
2699 <p>We have replaced the old jQuery-based color picker
<code>WCF.ColorPicker
</code> with a more lightweight replacement
<code>WoltLabSuite/Core/Ui/Color/Picker
</code>, which uses the build-in
<code>input[type=color]
</code> field.
2700 To support transparency, which
<code>input[type=color]
</code> does not, we also added a slider to set the alpha value.
2701 <code>WCF.ColorPicker
</code> has been adjusted to internally use
<code>WoltLabSuite/Core/Ui/Color/Picker
</code> and it has been deprecated.
</p>
2702 <p>Be aware that the new color picker requires the following new phrases to be available in the TypeScript/JavaScript code:
</p>
2704 <li><code>wcf.style.colorPicker.alpha
</code>,
</li>
2705 <li><code>wcf.style.colorPicker.color
</code>,
</li>
2706 <li><code>wcf.style.colorPicker.error.invalidColor
</code>,
</li>
2707 <li><code>wcf.style.colorPicker.hexAlpha
</code>,
</li>
2708 <li><code>wcf.style.colorPicker.new
</code>.
</li>
2710 <p>See
<a href=
"https://github.com/WoltLab/WCF/pull/4353">WoltLab/WCF#
4353</a> for details.
</p>
2711 <h2 id=
"codemirror">CodeMirror
<a class=
"headerlink" href=
"#codemirror" title=
"Permanent link">#
</a></h2>
2712 <p>The bundled version of CodeMirror was updated and should be loaded using the AMD loader going forward.
</p>
2713 <p>See the
<a href=
"../libraries/#codemirror">third party libraries migration guide
</a> for details.
</p>
2714 <h2 id=
"new-user-menu">New User Menu
<a class=
"headerlink" href=
"#new-user-menu" title=
"Permanent link">#
</a></h2>
2715 <p>The legacy implementation
<code>WCF.User.Panel.Abstract
</code> was based on jQuery and has now been retired in favor of a new lightweight implementation that provides a clean interface and improved accessibility.
2716 You are strongly encouraged to migrate your existing implementation to integrate with existing menus.
</p>
2717 <p>Please use
<code>WoltLabSuite/Core/Ui/User/Menu/Data/ModerationQueue.ts
</code> as a template for your own implementation, it contains only strictly the code you will need. It makes use of the new
<code>Ajax.dboAction()
</code> (see above) for improved readability and flexibility.
</p>
2718 <p>You must update your trigger button to include the
<code>role
</code>,
<code>tabindex
</code> and ARIA attributes! Please take a look at the links in
<code>pageHeaderUser.tpl
</code> to see these four attributes in action.
</p>
2719 <p>See
<a href=
"https://github.com/WoltLab/WCF/pull/4603">WoltLab/WCF#
4603</a> for details.
</p>
2722 <div class=
"md-source-file">
2744 <footer class=
"md-footer">
2746 <div class=
"md-footer-meta md-typeset">
2747 <div class=
"md-footer-meta__inner md-grid">
2748 <div class=
"md-copyright">
2750 <div class=
"md-copyright__highlight">
2751 Copyright ©
2020 WoltLab GmbH
2756 <a href=
"https://squidfunk.github.io/mkdocs-material/" target=
"_blank" rel=
"noopener">
2762 <div class=
"md-copyright">
2763 <a href=
"https://www.woltlab.com/legal-notice/">Legal Notice
</a>
2764 <a href=
"https://www.woltlab.com/privacy-policy/">Privacy Policy
</a>
2772 <div class=
"md-dialog" data-md-component=
"dialog">
2773 <div class=
"md-dialog__inner md-typeset"></div>
2776 <script id=
"__config" type=
"application/json">{
"base":
"../../..",
"features": [
"navigation.tracking"],
"search":
"../../../assets/javascripts/workers/search.db81ec45.min.js",
"translations": {
"clipboard.copied":
"Copied to clipboard",
"clipboard.copy":
"Copy to clipboard",
"search.result.more.one":
"1 more on this page",
"search.result.more.other":
"# more on this page",
"search.result.none":
"No matching documents",
"search.result.one":
"1 matching document",
"search.result.other":
"# matching documents",
"search.result.placeholder":
"Type to start searching",
"search.result.term.missing":
"Missing",
"select.version":
"Select version"},
"version": {
"provider":
"mike"}}
</script>
2779 <script src=
"../../../assets/javascripts/bundle.a00a7c5e.min.js"></script>