Deployed a4b680e to 5.4 with MkDocs 1.1.2 and mike 1.0.0
[GitHub/WoltLab/woltlab.github.io.git] / 5.4 / migration / wsc53 / javascript / index.html
CommitLineData
45ca63d0
TD
1
2<!doctype html>
3<html lang="en" class="no-js">
4 <head>
5
6 <meta charset="utf-8">
7 <meta name="viewport" content="width=device-width,initial-scale=1">
8
9
10
11
fb962f09 12 <link rel="icon" href="../../../assets/default.favicon.ico">
a4835aa6 13 <meta name="generator" content="mkdocs-1.1.2, mkdocs-material-7.1.2">
45ca63d0
TD
14
15
16
77efcd46 17 <title>TypeScript and JavaScript - WoltLab Suite Documentation</title>
45ca63d0
TD
18
19
20
a4835aa6 21 <link rel="stylesheet" href="../../../assets/stylesheets/main.6f955dcd.min.css">
45ca63d0
TD
22
23
fb962f09 24 <link rel="stylesheet" href="../../../assets/stylesheets/palette.ef6f36e2.min.css">
45ca63d0
TD
25
26
27
28 <meta name="theme-color" content="#009485">
29
30
31
32
33
fd8430cb
WG
34
35
45ca63d0
TD
36
37
38 <link rel="stylesheet" href="../../../stylesheets/extra.css">
39
40
41
42
43
44 </head>
45
46
47
48
49
50
51
52 <body dir="ltr" data-md-color-scheme="" data-md-color-primary="teal" data-md-color-accent="">
45ca63d0
TD
53
54
fb962f09
WG
55 <script>function __prefix(e){return new URL("../../..",location).pathname+"."+e}function __get(e,t=localStorage){return JSON.parse(t.getItem(__prefix(e)))}</script>
56
45ca63d0
TD
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">
61
62
77efcd46 63 <a href="#migrating-from-wsc-53-typescript-and-javascript" class="md-skip">
45ca63d0
TD
64 Skip to content
65 </a>
66
67 </div>
68 <div data-md-component="announce">
69
70 <aside class="md-announce">
71 <div class="md-announce__inner md-grid md-typeset">
72
73 <a href="https://www.woltlab.com">Back to <strong>woltlab.com</strong></a>
74
75 </div>
76 </aside>
77
78 </div>
79
fb962f09 80 <header class="md-header" data-md-component="header">
45ca63d0 81 <nav class="md-header__inner md-grid" aria-label="Header">
fb962f09 82 <a href="../../.." title="WoltLab Suite Documentation" class="md-header__button md-logo" aria-label="WoltLab Suite Documentation" data-md-component="logo">
45ca63d0
TD
83
84 <img src="../../../assets/logo.png" alt="logo">
85
86 </a>
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>
89 </label>
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
95 </span>
96 </div>
97 <div class="md-header__topic" data-md-component="header-topic">
98 <span class="md-ellipsis">
99
77efcd46 100 TypeScript and JavaScript
45ca63d0
TD
101
102 </span>
103 </div>
104 </div>
45ca63d0
TD
105 </div>
106
fb962f09
WG
107
108
a3639e76
WG
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>
111 </label>
112
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>
121 </label>
122 <button type="reset" class="md-search__icon md-icon" aria-label="Clear" tabindex="-1">
fb962f09 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>
a3639e76
WG
124 </button>
125 </form>
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">
130 Initializing search
131 </div>
132 <ol class="md-search-result__list"></ol>
133 </div>
134 </div>
135 </div>
136 </div>
137</div>
138
45ca63d0 139
7124f4cb
WG
140 <div class="md-header__source">
141
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">
144
fb962f09 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>
7124f4cb
WG
146 </div>
147 <div class="md-source__repository">
148 GitHub
149 </div>
150</a>
151 </div>
152
45ca63d0
TD
153 </nav>
154</header>
155
156 <div class="md-container" data-md-component="container">
157
158
159
160
161 <main class="md-main" data-md-component="main">
162 <div class="md-main__inner md-grid">
163
164
165
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">
169
170
171
45ca63d0
TD
172<nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
173 <label class="md-nav__title" for="__drawer">
fb962f09 174 <a href="../../.." title="WoltLab Suite Documentation" class="md-nav__button md-logo" aria-label="WoltLab Suite Documentation" data-md-component="logo">
45ca63d0
TD
175
176 <img src="../../../assets/logo.png" alt="logo">
177
178 </a>
179 WoltLab Suite Documentation
180 </label>
181
7124f4cb
WG
182 <div class="md-nav__source">
183
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">
186
fb962f09 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>
7124f4cb
WG
188 </div>
189 <div class="md-source__repository">
190 GitHub
191 </div>
192</a>
193 </div>
194
45ca63d0
TD
195 <ul class="md-nav__list" data-md-scrollfix>
196
197
198
199
200
201
202
203
204 <li class="md-nav__item">
205 <a href="../../../getting-started/" class="md-nav__link">
206 Getting Started
207 </a>
208 </li>
209
210
211
212
213
214
215
216
217
218
219
220 <li class="md-nav__item md-nav__item--nested">
221
222
223 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2" type="checkbox" id="__nav_2" >
224
225 <label class="md-nav__link" for="__nav_2">
226 PHP API
227 <span class="md-nav__icon md-icon"></span>
228 </label>
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>
232 PHP API
233 </label>
234 <ul class="md-nav__list" data-md-scrollfix>
235
236
237
238
239
240 <li class="md-nav__item">
241 <a href="../../../php/pages/" class="md-nav__link">
242 Pages
243 </a>
244 </li>
245
246
247
248
249
250
251
252 <li class="md-nav__item">
253 <a href="../../../php/database-objects/" class="md-nav__link">
254 Database Objects
255 </a>
256 </li>
257
258
259
260
261
262
263
264 <li class="md-nav__item">
265 <a href="../../../php/database-access/" class="md-nav__link">
266 Database Access
267 </a>
268 </li>
269
270
271
272
273
274
275
276 <li class="md-nav__item">
277 <a href="../../../php/exceptions/" class="md-nav__link">
278 Exceptions
279 </a>
280 </li>
281
282
283
284
285
286
287
288
289 <li class="md-nav__item md-nav__item--nested">
290
291
292 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5" type="checkbox" id="__nav_2_5" >
293
294 <label class="md-nav__link" for="__nav_2_5">
295 API
296 <span class="md-nav__icon md-icon"></span>
297 </label>
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>
301 API
302 </label>
303 <ul class="md-nav__list" data-md-scrollfix>
304
305
306
307
308
6923e968
WG
309
310 <li class="md-nav__item md-nav__item--nested">
311
312
313 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5_1" type="checkbox" id="__nav_2_5_1" >
314
315 <label class="md-nav__link" for="__nav_2_5_1">
316 Caches
317 <span class="md-nav__icon md-icon"></span>
318 </label>
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>
322 Caches
323 </label>
324 <ul class="md-nav__list" data-md-scrollfix>
325
326
327
328
329
45ca63d0
TD
330 <li class="md-nav__item">
331 <a href="../../../php/api/caches/" class="md-nav__link">
6923e968
WG
332 Overview
333 </a>
334 </li>
335
336
337
338
339
340
341
342 <li class="md-nav__item">
343 <a href="../../../php/api/caches_persistent-caches/" class="md-nav__link">
344 Persistent Caches
345 </a>
346 </li>
347
348
349
350
351
352
353
354 <li class="md-nav__item">
355 <a href="../../../php/api/caches_runtime-caches/" class="md-nav__link">
356 Runtime Caches
45ca63d0
TD
357 </a>
358 </li>
359
360
361
6923e968
WG
362 </ul>
363 </nav>
364 </li>
365
366
367
45ca63d0
TD
368
369
370
371
372 <li class="md-nav__item">
373 <a href="../../../php/api/comments/" class="md-nav__link">
374 Comments
375 </a>
376 </li>
377
378
379
380
381
382
383
384 <li class="md-nav__item">
385 <a href="../../../php/api/cronjobs/" class="md-nav__link">
386 Cronjobs
387 </a>
388 </li>
389
390
391
392
393
394
395
396 <li class="md-nav__item">
397 <a href="../../../php/api/events/" class="md-nav__link">
398 Events
399 </a>
400 </li>
401
402
403
404
405
406
407
408
409 <li class="md-nav__item md-nav__item--nested">
410
411
412 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5_5" type="checkbox" id="__nav_2_5_5" >
413
414 <label class="md-nav__link" for="__nav_2_5_5">
415 Form Builder
416 <span class="md-nav__icon md-icon"></span>
417 </label>
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>
421 Form Builder
422 </label>
423 <ul class="md-nav__list" data-md-scrollfix>
424
425
426
427
428
429 <li class="md-nav__item">
430 <a href="../../../php/api/form_builder/overview/" class="md-nav__link">
431 Overview
432 </a>
433 </li>
434
435
436
437
438
439
440
441 <li class="md-nav__item">
442 <a href="../../../php/api/form_builder/structure/" class="md-nav__link">
443 Structure
444 </a>
445 </li>
446
447
448
449
450
451
452
453 <li class="md-nav__item">
454 <a href="../../../php/api/form_builder/form_fields/" class="md-nav__link">
455 Fields
456 </a>
457 </li>
458
459
460
461
462
463
464
465 <li class="md-nav__item">
466 <a href="../../../php/api/form_builder/validation_data/" class="md-nav__link">
467 Validation and Data
468 </a>
469 </li>
470
471
472
473
474
475
476
477 <li class="md-nav__item">
478 <a href="../../../php/api/form_builder/dependencies/" class="md-nav__link">
479 Dependencies
480 </a>
481 </li>
482
483
484
485 </ul>
486 </nav>
487 </li>
488
489
490
491
492
493
494
495 <li class="md-nav__item">
496 <a href="../../../php/api/package_installation_plugins/" class="md-nav__link">
497 Package Installation Plugins
498 </a>
499 </li>
500
501
502
503
504
505
506
507 <li class="md-nav__item">
508 <a href="../../../php/api/user_activity_points/" class="md-nav__link">
509 User Activity Points
510 </a>
511 </li>
512
513
514
515
516
517
518
519 <li class="md-nav__item">
520 <a href="../../../php/api/user_notifications/" class="md-nav__link">
521 User Notifications
522 </a>
523 </li>
524
525
526
527
528
529
530
531 <li class="md-nav__item">
532 <a href="../../../php/api/sitemaps/" class="md-nav__link">
533 Sitemaps
534 </a>
535 </li>
536
537
538
539 </ul>
540 </nav>
541 </li>
542
543
544
545
546
547
548
549 <li class="md-nav__item">
550 <a href="../../../php/code-style/" class="md-nav__link">
551 Code Style
552 </a>
553 </li>
554
555
556
557
558
559
560
561 <li class="md-nav__item">
562 <a href="../../../php/apps/" class="md-nav__link">
563 Apps
564 </a>
565 </li>
566
567
568
569
570
571
572
573 <li class="md-nav__item">
574 <a href="../../../php/gdpr/" class="md-nav__link">
575 GDPR
576 </a>
577 </li>
578
579
580
581 </ul>
582 </nav>
583 </li>
584
585
586
587
588
589
590
591
592
593
594
595 <li class="md-nav__item md-nav__item--nested">
596
597
598 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" type="checkbox" id="__nav_3" >
599
600 <label class="md-nav__link" for="__nav_3">
601 Languages, Templates & CSS
602 <span class="md-nav__icon md-icon"></span>
603 </label>
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
608 </label>
609 <ul class="md-nav__list" data-md-scrollfix>
610
611
612
613
614
615 <li class="md-nav__item">
616 <a href="../../../view/languages/" class="md-nav__link">
617 Languages
618 </a>
619 </li>
620
621
622
623
624
625
626
627 <li class="md-nav__item">
628 <a href="../../../view/templates/" class="md-nav__link">
629 Templates
630 </a>
631 </li>
632
633
634
635
636
637
638
6923e968
WG
639 <li class="md-nav__item">
640 <a href="../../../view/template-plugins/" class="md-nav__link">
641 Template Plugins
642 </a>
643 </li>
644
645
646
647
648
649
650
45ca63d0
TD
651 <li class="md-nav__item">
652 <a href="../../../view/css/" class="md-nav__link">
653 CSS
654 </a>
655 </li>
656
657
658
659 </ul>
660 </nav>
661 </li>
662
663
664
665
666
667
668
669
670
671
672
673 <li class="md-nav__item md-nav__item--nested">
674
675
676 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" >
677
678 <label class="md-nav__link" for="__nav_4">
77efcd46 679 TypeScript and JavaScript API
45ca63d0
TD
680 <span class="md-nav__icon md-icon"></span>
681 </label>
77efcd46 682 <nav class="md-nav" aria-label="TypeScript and JavaScript API" data-md-level="1">
45ca63d0
TD
683 <label class="md-nav__title" for="__nav_4">
684 <span class="md-nav__icon md-icon"></span>
77efcd46 685 TypeScript and JavaScript API
45ca63d0
TD
686 </label>
687 <ul class="md-nav__list" data-md-scrollfix>
688
689
690
691
692
693 <li class="md-nav__item">
694 <a href="../../../javascript/general-usage/" class="md-nav__link">
695 General Usage
696 </a>
697 </li>
698
699
700
701
702
703
704
77efcd46
WG
705 <li class="md-nav__item">
706 <a href="../../../javascript/typescript/" class="md-nav__link">
707 TypeScript
708 </a>
709 </li>
710
711
712
713
714
715
716
45ca63d0
TD
717
718 <li class="md-nav__item md-nav__item--nested">
719
720
77efcd46 721 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4_3" type="checkbox" id="__nav_4_3" >
45ca63d0 722
77efcd46 723 <label class="md-nav__link" for="__nav_4_3">
45ca63d0
TD
724 New API
725 <span class="md-nav__icon md-icon"></span>
726 </label>
727 <nav class="md-nav" aria-label="New API" data-md-level="2">
77efcd46 728 <label class="md-nav__title" for="__nav_4_3">
45ca63d0
TD
729 <span class="md-nav__icon md-icon"></span>
730 New API
731 </label>
732 <ul class="md-nav__list" data-md-scrollfix>
733
734
735
736
737
738 <li class="md-nav__item">
739 <a href="../../../javascript/new-api_writing-a-module/" class="md-nav__link">
740 Writing a module
741 </a>
742 </li>
743
744
745
746
747
748
749
750 <li class="md-nav__item">
751 <a href="../../../javascript/new-api_data-structures/" class="md-nav__link">
752 Data Structures
753 </a>
754 </li>
755
756
757
758
759
760
761
762 <li class="md-nav__item">
763 <a href="../../../javascript/new-api_core/" class="md-nav__link">
764 Core Functions
765 </a>
766 </li>
767
768
769
770
771
772
773
774 <li class="md-nav__item">
775 <a href="../../../javascript/new-api_dom/" class="md-nav__link">
776 DOM
777 </a>
778 </li>
779
780
781
782
783
784
785
786 <li class="md-nav__item">
787 <a href="../../../javascript/new-api_events/" class="md-nav__link">
788 Event Handling
789 </a>
790 </li>
791
792
793
794
795
796
797
798 <li class="md-nav__item">
799 <a href="../../../javascript/new-api_ajax/" class="md-nav__link">
800 Ajax
801 </a>
802 </li>
803
804
805
806
807
808
809
810 <li class="md-nav__item">
811 <a href="../../../javascript/new-api_dialogs/" class="md-nav__link">
812 Dialogs
813 </a>
814 </li>
815
816
817
818
819
820
821
822 <li class="md-nav__item">
823 <a href="../../../javascript/new-api_browser/" class="md-nav__link">
824 Browser and Screen Sizes
825 </a>
826 </li>
827
828
829
830
831
832
833
834 <li class="md-nav__item">
835 <a href="../../../javascript/new-api_ui/" class="md-nav__link">
836 User Interface
837 </a>
838 </li>
839
840
841
842 </ul>
843 </nav>
844 </li>
845
846
847
848
849
850
851
852 <li class="md-nav__item">
853 <a href="../../../javascript/legacy-api/" class="md-nav__link">
854 Legacy API
855 </a>
856 </li>
857
858
859
860
861
862
863
864 <li class="md-nav__item">
865 <a href="../../../javascript/helper-functions/" class="md-nav__link">
866 Helper Functions
867 </a>
868 </li>
869
870
871
872
873
874
875
876 <li class="md-nav__item">
877 <a href="../../../javascript/code-snippets/" class="md-nav__link">
878 Code Snippets
879 </a>
880 </li>
881
882
883
884 </ul>
885 </nav>
886 </li>
887
888
889
890
891
892
893
894
895
896
897
898 <li class="md-nav__item md-nav__item--nested">
899
900
901 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" >
902
903 <label class="md-nav__link" for="__nav_5">
904 Package Components
905 <span class="md-nav__icon md-icon"></span>
906 </label>
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>
910 Package Components
911 </label>
912 <ul class="md-nav__list" data-md-scrollfix>
913
914
915
916
917
918 <li class="md-nav__item">
919 <a href="../../../package/package-xml/" class="md-nav__link">
920 package.xml
921 </a>
922 </li>
923
924
925
926
927
928
929
930
931 <li class="md-nav__item md-nav__item--nested">
932
933
934 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_2" type="checkbox" id="__nav_5_2" >
935
936 <label class="md-nav__link" for="__nav_5_2">
937 PIPs
938 <span class="md-nav__icon md-icon"></span>
939 </label>
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>
943 PIPs
944 </label>
945 <ul class="md-nav__list" data-md-scrollfix>
946
947
948
949
950
951 <li class="md-nav__item">
952 <a href="../../../package/pip/" class="md-nav__link">
953 Overview
954 </a>
955 </li>
956
957
958
959
960
961
962
963 <li class="md-nav__item">
964 <a href="../../../package/pip/acl-option/" class="md-nav__link">
965 aclOption
966 </a>
967 </li>
968
969
970
971
972
973
974
975 <li class="md-nav__item">
976 <a href="../../../package/pip/acp-menu/" class="md-nav__link">
977 acpMenu
978 </a>
979 </li>
980
981
982
983
984
985
986
987 <li class="md-nav__item">
988 <a href="../../../package/pip/acp-search-provider/" class="md-nav__link">
989 acpSearchProvider
990 </a>
991 </li>
992
993
994
995
996
997
998
999 <li class="md-nav__item">
1000 <a href="../../../package/pip/acp-template/" class="md-nav__link">
1001 acpTemplate
1002 </a>
1003 </li>
1004
1005
1006
1007
1008
1009
1010
1011 <li class="md-nav__item">
1012 <a href="../../../package/pip/bbcode/" class="md-nav__link">
1013 bbcode
1014 </a>
1015 </li>
1016
1017
1018
1019
1020
1021
1022
1023 <li class="md-nav__item">
1024 <a href="../../../package/pip/box/" class="md-nav__link">
1025 box
1026 </a>
1027 </li>
1028
1029
1030
1031
1032
1033
1034
1035 <li class="md-nav__item">
1036 <a href="../../../package/pip/clipboard-action/" class="md-nav__link">
1037 clipboardAction
1038 </a>
1039 </li>
1040
1041
1042
1043
1044
1045
1046
1047 <li class="md-nav__item">
1048 <a href="../../../package/pip/core-object/" class="md-nav__link">
1049 coreObject
1050 </a>
1051 </li>
1052
1053
1054
1055
1056
1057
1058
1059 <li class="md-nav__item">
1060 <a href="../../../package/pip/cronjob/" class="md-nav__link">
1061 cronjob
1062 </a>
1063 </li>
1064
1065
1066
1067
1068
1069
1070
6923e968
WG
1071 <li class="md-nav__item">
1072 <a href="../../../package/pip/database/" class="md-nav__link">
1073 database
1074 </a>
1075 </li>
1076
1077
1078
1079
1080
1081
1082
45ca63d0
TD
1083 <li class="md-nav__item">
1084 <a href="../../../package/pip/event-listener/" class="md-nav__link">
1085 eventListener
1086 </a>
1087 </li>
1088
1089
1090
1091
1092
1093
1094
1095 <li class="md-nav__item">
1096 <a href="../../../package/pip/file/" class="md-nav__link">
1097 file
1098 </a>
1099 </li>
1100
1101
1102
1103
1104
1105
1106
1107 <li class="md-nav__item">
1108 <a href="../../../package/pip/language/" class="md-nav__link">
1109 language
1110 </a>
1111 </li>
1112
1113
1114
1115
1116
1117
1118
1119 <li class="md-nav__item">
1120 <a href="../../../package/pip/media-provider/" class="md-nav__link">
1121 mediaProvider
1122 </a>
1123 </li>
1124
1125
1126
1127
1128
1129
1130
1131 <li class="md-nav__item">
1132 <a href="../../../package/pip/menu/" class="md-nav__link">
1133 menu
1134 </a>
1135 </li>
1136
1137
1138
1139
1140
1141
1142
1143 <li class="md-nav__item">
1144 <a href="../../../package/pip/menu-item/" class="md-nav__link">
1145 menuItem
1146 </a>
1147 </li>
1148
1149
1150
1151
1152
1153
1154
1155 <li class="md-nav__item">
1156 <a href="../../../package/pip/object-type/" class="md-nav__link">
1157 objectType
1158 </a>
1159 </li>
1160
1161
1162
1163
1164
1165
1166
1167 <li class="md-nav__item">
1168 <a href="../../../package/pip/object-type-definition/" class="md-nav__link">
1169 objectTypeDefinition
1170 </a>
1171 </li>
1172
1173
1174
1175
1176
1177
1178
1179 <li class="md-nav__item">
1180 <a href="../../../package/pip/option/" class="md-nav__link">
1181 option
1182 </a>
1183 </li>
1184
1185
1186
1187
1188
1189
1190
1191 <li class="md-nav__item">
1192 <a href="../../../package/pip/page/" class="md-nav__link">
1193 page
1194 </a>
1195 </li>
1196
1197
1198
1199
1200
1201
1202
1203 <li class="md-nav__item">
1204 <a href="../../../package/pip/pip/" class="md-nav__link">
1205 pip
1206 </a>
1207 </li>
1208
1209
1210
1211
1212
1213
1214
1215 <li class="md-nav__item">
1216 <a href="../../../package/pip/script/" class="md-nav__link">
1217 script
1218 </a>
1219 </li>
1220
1221
1222
1223
1224
1225
1226
1227 <li class="md-nav__item">
1228 <a href="../../../package/pip/smiley/" class="md-nav__link">
1229 smiley
1230 </a>
1231 </li>
1232
1233
1234
1235
1236
1237
1238
1239 <li class="md-nav__item">
1240 <a href="../../../package/pip/sql/" class="md-nav__link">
1241 sql
1242 </a>
1243 </li>
1244
1245
1246
1247
1248
1249
1250
1251 <li class="md-nav__item">
1252 <a href="../../../package/pip/style/" class="md-nav__link">
1253 style
1254 </a>
1255 </li>
1256
1257
1258
1259
1260
1261
1262
1263 <li class="md-nav__item">
1264 <a href="../../../package/pip/template/" class="md-nav__link">
1265 template
1266 </a>
1267 </li>
1268
1269
1270
1271
1272
1273
1274
1275 <li class="md-nav__item">
1276 <a href="../../../package/pip/template-listener/" class="md-nav__link">
1277 templateListener
1278 </a>
1279 </li>
1280
1281
1282
1283
1284
1285
1286
1287 <li class="md-nav__item">
1288 <a href="../../../package/pip/user-group-option/" class="md-nav__link">
1289 userGroupOption
1290 </a>
1291 </li>
1292
1293
1294
1295
1296
1297
1298
1299 <li class="md-nav__item">
1300 <a href="../../../package/pip/user-menu/" class="md-nav__link">
1301 userMenu
1302 </a>
1303 </li>
1304
1305
1306
1307
1308
1309
1310
1311 <li class="md-nav__item">
1312 <a href="../../../package/pip/user-notification-event/" class="md-nav__link">
1313 userNotificationEvent
1314 </a>
1315 </li>
1316
1317
1318
1319
1320
1321
1322
1323 <li class="md-nav__item">
1324 <a href="../../../package/pip/user-option/" class="md-nav__link">
1325 userOption
1326 </a>
1327 </li>
1328
1329
1330
1331
1332
1333
1334
1335 <li class="md-nav__item">
1336 <a href="../../../package/pip/user-profile-menu/" class="md-nav__link">
1337 userProfileMenu
1338 </a>
1339 </li>
1340
1341
1342
1343 </ul>
1344 </nav>
1345 </li>
1346
1347
1348
1349
1350
1351
1352
1353 <li class="md-nav__item">
1354 <a href="../../../package/database-php-api/" class="md-nav__link">
1355 Database PHP API
1356 </a>
1357 </li>
1358
1359
1360
1361 </ul>
1362 </nav>
1363 </li>
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377 <li class="md-nav__item md-nav__item--active md-nav__item--nested">
1378
1379
1380 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" checked>
1381
1382 <label class="md-nav__link" for="__nav_6">
1383 Migration
1384 <span class="md-nav__icon md-icon"></span>
1385 </label>
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>
1389 Migration
1390 </label>
1391 <ul class="md-nav__list" data-md-scrollfix>
1392
1393
1394
1395
1396
1397
1398
1399
1400 <li class="md-nav__item md-nav__item--active md-nav__item--nested">
1401
1402
1403 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_1" type="checkbox" id="__nav_6_1" checked>
1404
1405 <label class="md-nav__link" for="__nav_6_1">
1406 Migrating from WSC 5.3
1407 <span class="md-nav__icon md-icon"></span>
1408 </label>
1409 <nav class="md-nav" aria-label="Migrating from WSC 5.3" data-md-level="2">
1410 <label class="md-nav__title" for="__nav_6_1">
1411 <span class="md-nav__icon md-icon"></span>
1412 Migrating from WSC 5.3
1413 </label>
1414 <ul class="md-nav__list" data-md-scrollfix>
1415
1416
1417
1418
1419
1420 <li class="md-nav__item">
1421 <a href="../php/" class="md-nav__link">
1422 PHP API
1423 </a>
1424 </li>
1425
1426
1427
1428
1429
1430
1431
1432 <li class="md-nav__item">
1433 <a href="../session/" class="md-nav__link">
1434 Session Handling and Authentication
1435 </a>
1436 </li>
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446 <li class="md-nav__item md-nav__item--active">
1447
1448 <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
1449
a4835aa6 1450
45ca63d0
TD
1451
1452
1453
1454 <label class="md-nav__link md-nav__link--active" for="__toc">
77efcd46 1455 TypeScript and JavaScript
45ca63d0
TD
1456 <span class="md-nav__icon md-icon"></span>
1457 </label>
1458
1459 <a href="./" class="md-nav__link md-nav__link--active">
77efcd46 1460 TypeScript and JavaScript
45ca63d0
TD
1461 </a>
1462
1463
1464<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
1465
1466
a4835aa6 1467
45ca63d0
TD
1468
1469
1470
1471 <label class="md-nav__title" for="__toc">
1472 <span class="md-nav__icon md-icon"></span>
1473 Table of contents
1474 </label>
1475 <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
1476
77efcd46
WG
1477 <li class="md-nav__item">
1478 <a href="#typescript" class="md-nav__link">
1479 TypeScript
1480 </a>
1481
1482</li>
1483
45ca63d0
TD
1484 <li class="md-nav__item">
1485 <a href="#wcf_click_event" class="md-nav__link">
1486 WCF_CLICK_EVENT
1487 </a>
1488
d7b81aff
WG
1489</li>
1490
1491 <li class="md-nav__item">
1492 <a href="#wcfactiondelete-and-wcfactiontoggle" class="md-nav__link">
1493 WCF.Action.Delete and WCF.Action.Toggle
1494 </a>
1495
cf171f0d
WG
1496</li>
1497
1498 <li class="md-nav__item">
1499 <a href="#wcftableemptytablehandler" class="md-nav__link">
1500 WCF.Table.EmptyTableHandler
1501 </a>
1502
45ca63d0
TD
1503</li>
1504
1505 </ul>
1506
1507</nav>
1508
1509 </li>
1510
1511
1512
1513
1514
1515
1516
1517 <li class="md-nav__item">
1518 <a href="../templates/" class="md-nav__link">
1519 Templates
1520 </a>
1521 </li>
1522
1523
1524
1525
1526
1527
1528
1529 <li class="md-nav__item">
1530 <a href="../libraries/" class="md-nav__link">
1531 Third Party Libraries
1532 </a>
1533 </li>
1534
1535
1536
1537 </ul>
1538 </nav>
1539 </li>
1540
1541
1542
1543
1544
1545
1546
1547
1548 <li class="md-nav__item md-nav__item--nested">
1549
1550
1551 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_2" type="checkbox" id="__nav_6_2" >
1552
1553 <label class="md-nav__link" for="__nav_6_2">
1554 Migrating from WSC 5.2
1555 <span class="md-nav__icon md-icon"></span>
1556 </label>
1557 <nav class="md-nav" aria-label="Migrating from WSC 5.2" data-md-level="2">
1558 <label class="md-nav__title" for="__nav_6_2">
1559 <span class="md-nav__icon md-icon"></span>
1560 Migrating from WSC 5.2
1561 </label>
1562 <ul class="md-nav__list" data-md-scrollfix>
1563
1564
1565
1566
1567
1568 <li class="md-nav__item">
1569 <a href="../../wsc52/php/" class="md-nav__link">
1570 PHP API
1571 </a>
1572 </li>
1573
1574
1575
1576
1577
1578
1579
1580 <li class="md-nav__item">
1581 <a href="../../wsc52/templates/" class="md-nav__link">
1582 Templates and Languages
1583 </a>
1584 </li>
1585
1586
1587
1588
1589
1590
1591
1592 <li class="md-nav__item">
1593 <a href="../../wsc52/libraries/" class="md-nav__link">
1594 Third Party Libraries
1595 </a>
1596 </li>
1597
1598
1599
1600 </ul>
1601 </nav>
1602 </li>
1603
1604
1605
1606
1607
1608
1609
1610
1611 <li class="md-nav__item md-nav__item--nested">
1612
1613
1614 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_3" type="checkbox" id="__nav_6_3" >
1615
1616 <label class="md-nav__link" for="__nav_6_3">
1617 Migrating from WSC 3.1
1618 <span class="md-nav__icon md-icon"></span>
1619 </label>
1620 <nav class="md-nav" aria-label="Migrating from WSC 3.1" data-md-level="2">
1621 <label class="md-nav__title" for="__nav_6_3">
1622 <span class="md-nav__icon md-icon"></span>
1623 Migrating from WSC 3.1
1624 </label>
1625 <ul class="md-nav__list" data-md-scrollfix>
1626
1627
1628
1629
1630
1631 <li class="md-nav__item">
1632 <a href="../../wsc31/php/" class="md-nav__link">
1633 PHP API
1634 </a>
1635 </li>
1636
1637
1638
1639 </ul>
1640 </nav>
1641 </li>
1642
1643
1644
1645
1646
1647
1648
1649
1650 <li class="md-nav__item md-nav__item--nested">
1651
1652
1653 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_4" type="checkbox" id="__nav_6_4" >
1654
1655 <label class="md-nav__link" for="__nav_6_4">
1656 Migrating from WSC 3.0
1657 <span class="md-nav__icon md-icon"></span>
1658 </label>
1659 <nav class="md-nav" aria-label="Migrating from WSC 3.0" data-md-level="2">
1660 <label class="md-nav__title" for="__nav_6_4">
1661 <span class="md-nav__icon md-icon"></span>
1662 Migrating from WSC 3.0
1663 </label>
1664 <ul class="md-nav__list" data-md-scrollfix>
1665
1666
1667
1668
1669
1670 <li class="md-nav__item">
1671 <a href="../../wsc30/php/" class="md-nav__link">
1672 PHP API
1673 </a>
1674 </li>
1675
1676
1677
1678
1679
1680
1681
1682 <li class="md-nav__item">
1683 <a href="../../wsc30/javascript/" class="md-nav__link">
1684 JavaScript API
1685 </a>
1686 </li>
1687
1688
1689
1690
1691
1692
1693
1694 <li class="md-nav__item">
1695 <a href="../../wsc30/templates/" class="md-nav__link">
1696 Templates
1697 </a>
1698 </li>
1699
1700
1701
1702
1703
1704
1705
1706 <li class="md-nav__item">
1707 <a href="../../wsc30/css/" class="md-nav__link">
1708 CSS
1709 </a>
1710 </li>
1711
1712
1713
1714
1715
1716
1717
1718 <li class="md-nav__item">
1719 <a href="../../wsc30/package/" class="md-nav__link">
1720 Package Components
1721 </a>
1722 </li>
1723
1724
1725
1726 </ul>
1727 </nav>
1728 </li>
1729
1730
1731
1732
1733
1734
1735
1736
1737 <li class="md-nav__item md-nav__item--nested">
1738
1739
1740 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_5" type="checkbox" id="__nav_6_5" >
1741
1742 <label class="md-nav__link" for="__nav_6_5">
1743 Migrating from WCF 2.1
1744 <span class="md-nav__icon md-icon"></span>
1745 </label>
1746 <nav class="md-nav" aria-label="Migrating from WCF 2.1" data-md-level="2">
1747 <label class="md-nav__title" for="__nav_6_5">
1748 <span class="md-nav__icon md-icon"></span>
1749 Migrating from WCF 2.1
1750 </label>
1751 <ul class="md-nav__list" data-md-scrollfix>
1752
1753
1754
1755
1756
1757 <li class="md-nav__item">
1758 <a href="../../wcf21/php/" class="md-nav__link">
1759 PHP API
1760 </a>
1761 </li>
1762
1763
1764
1765
1766
1767
1768
1769 <li class="md-nav__item">
1770 <a href="../../wcf21/templates/" class="md-nav__link">
1771 Templates
1772 </a>
1773 </li>
1774
1775
1776
1777
1778
1779
1780
1781 <li class="md-nav__item">
1782 <a href="../../wcf21/css/" class="md-nav__link">
1783 CSS
1784 </a>
1785 </li>
1786
1787
1788
1789
1790
1791
1792
1793 <li class="md-nav__item">
1794 <a href="../../wcf21/package/" class="md-nav__link">
1795 Package Components
1796 </a>
1797 </li>
1798
1799
1800
1801 </ul>
1802 </nav>
1803 </li>
1804
1805
1806
1807 </ul>
1808 </nav>
1809 </li>
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821 <li class="md-nav__item md-nav__item--nested">
1822
1823
1824 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >
1825
1826 <label class="md-nav__link" for="__nav_7">
1827 Tutorials
1828 <span class="md-nav__icon md-icon"></span>
1829 </label>
1830 <nav class="md-nav" aria-label="Tutorials" data-md-level="1">
1831 <label class="md-nav__title" for="__nav_7">
1832 <span class="md-nav__icon md-icon"></span>
1833 Tutorials
1834 </label>
1835 <ul class="md-nav__list" data-md-scrollfix>
1836
1837
1838
1839
1840
1841
1842 <li class="md-nav__item md-nav__item--nested">
1843
1844
1845 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7_1" type="checkbox" id="__nav_7_1" >
1846
1847 <label class="md-nav__link" for="__nav_7_1">
1848 Tutorial Series
1849 <span class="md-nav__icon md-icon"></span>
1850 </label>
1851 <nav class="md-nav" aria-label="Tutorial Series" data-md-level="2">
1852 <label class="md-nav__title" for="__nav_7_1">
1853 <span class="md-nav__icon md-icon"></span>
1854 Tutorial Series
1855 </label>
1856 <ul class="md-nav__list" data-md-scrollfix>
1857
1858
1859
1860
1861
1862 <li class="md-nav__item">
1863 <a href="../../../tutorial/series/overview/" class="md-nav__link">
1864 Overview
1865 </a>
1866 </li>
1867
1868
1869
1870
1871
1872
1873
1874 <li class="md-nav__item">
1875 <a href="../../../tutorial/series/part_1/" class="md-nav__link">
1876 Part 1
1877 </a>
1878 </li>
1879
1880
1881
1882
1883
1884
1885
1886 <li class="md-nav__item">
1887 <a href="../../../tutorial/series/part_2/" class="md-nav__link">
1888 Part 2
1889 </a>
1890 </li>
1891
1892
1893
1894
1895
1896
1897
1898 <li class="md-nav__item">
1899 <a href="../../../tutorial/series/part_3/" class="md-nav__link">
1900 Part 3
1901 </a>
1902 </li>
1903
1904
1905
41eda543
WG
1906
1907
1908
1909
1910 <li class="md-nav__item">
1911 <a href="../../../tutorial/series/part_4/" class="md-nav__link">
1912 Part 4
1913 </a>
1914 </li>
1915
1916
1917
716a4ab6
WG
1918
1919
1920
1921
1922 <li class="md-nav__item">
1923 <a href="../../../tutorial/series/part_5/" class="md-nav__link">
1924 Part 5
1925 </a>
1926 </li>
1927
1928
1929
45ca63d0
TD
1930 </ul>
1931 </nav>
1932 </li>
1933
1934
1935
1936 </ul>
1937 </nav>
1938 </li>
1939
1940
1941
1942 </ul>
1943</nav>
1944 </div>
1945 </div>
1946 </div>
1947
1948
1949
1950 <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
1951 <div class="md-sidebar__scrollwrap">
1952 <div class="md-sidebar__inner">
1953
1954<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
1955
1956
a4835aa6 1957
45ca63d0
TD
1958
1959
1960
1961 <label class="md-nav__title" for="__toc">
1962 <span class="md-nav__icon md-icon"></span>
1963 Table of contents
1964 </label>
1965 <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
1966
77efcd46
WG
1967 <li class="md-nav__item">
1968 <a href="#typescript" class="md-nav__link">
1969 TypeScript
1970 </a>
1971
1972</li>
1973
45ca63d0
TD
1974 <li class="md-nav__item">
1975 <a href="#wcf_click_event" class="md-nav__link">
1976 WCF_CLICK_EVENT
1977 </a>
1978
d7b81aff
WG
1979</li>
1980
1981 <li class="md-nav__item">
1982 <a href="#wcfactiondelete-and-wcfactiontoggle" class="md-nav__link">
1983 WCF.Action.Delete and WCF.Action.Toggle
1984 </a>
1985
cf171f0d
WG
1986</li>
1987
1988 <li class="md-nav__item">
1989 <a href="#wcftableemptytablehandler" class="md-nav__link">
1990 WCF.Table.EmptyTableHandler
1991 </a>
1992
45ca63d0
TD
1993</li>
1994
1995 </ul>
1996
1997</nav>
1998 </div>
1999 </div>
2000 </div>
2001
2002
2003 <div class="md-content" data-md-component="content">
2004 <article class="md-content__inner md-typeset">
2005
2006
9b8bddda 2007 <a href="https://github.com/WoltLab/docs.woltlab.com/edit/5.4/docs/migration/wsc53/javascript.md" title="Edit this page" class="md-content__button md-icon">
7124f4cb
WG
2008 <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>
2009 </a>
2010
45ca63d0 2011
77efcd46
WG
2012 <h1 id="migrating-from-wsc-53-typescript-and-javascript">Migrating from WSC 5.3 - TypeScript and JavaScript<a class="headerlink" href="#migrating-from-wsc-53-typescript-and-javascript" title="Permanent link">#</a></h1>
2013<h2 id="typescript">TypeScript<a class="headerlink" href="#typescript" title="Permanent link">#</a></h2>
2014<p>WoltLab Suite 5.4 introduces TypeScript support.
2015Learn about consuming WoltLab Suite’s types in <a href="../../../javascript/typescript/">the TypeScript section</a> of the JavaScript API documentation.</p>
2016<p>The JavaScript API documentation will be updated to properly take into account the changes that came with the new TypeScript support in the future.
2017Existing AMD based modules have been migrated to TypeScript, but will expose the existing and known API.</p>
2018<p>It is recommended that you migrate your custom packages to make use of TypeScript.
2019It will make consuming newly written modules that properly leverage TypeScript’s features much more pleasant and will also ease using existing modules due to proper autocompletion and type checking.</p>
45ca63d0
TD
2020<h2 id="wcf_click_event"><code>WCF_CLICK_EVENT</code><a class="headerlink" href="#wcf_click_event" title="Permanent link">#</a></h2>
2021<p>For event listeners on click events, <code>WCF_CLICK_EVENT</code> is deprecated and should no longer be used.
2022Instead, use <code>click</code> directly:</p>
704cbc4a
WG
2023<table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span>
2024<span class="normal">2</span>
2025<span class="normal">3</span>
2026<span class="normal">4</span>
2027<span class="normal">5</span></pre></div></td><td class="code"><div class="highlight"><pre><span></span><code><span class="c1">// before</span>
45ca63d0
TD
2028<span class="nx">element</span><span class="p">.</span><span class="nx">addEventListener</span><span class="p">(</span><span class="nx">WCF_CLICK_EVENT</span><span class="p">,</span> <span class="k">this</span><span class="p">.</span><span class="nx">_click</span><span class="p">.</span><span class="nx">bind</span><span class="p">(</span><span class="k">this</span><span class="p">));</span>
2029
2030<span class="c1">// after</span>
2031<span class="nx">element</span><span class="p">.</span><span class="nx">addEventListener</span><span class="p">(</span><span class="s1">&#39;click&#39;</span><span class="p">,</span> <span class="p">(</span><span class="nx">ev</span><span class="p">)</span> <span class="p">=&gt;</span> <span class="k">this</span><span class="p">.</span><span class="nx">_click</span><span class="p">(</span><span class="nx">ev</span><span class="p">));</span>
2032</code></pre></div>
704cbc4a 2033</td></tr></table>
d7b81aff
WG
2034<h2 id="wcfactiondelete-and-wcfactiontoggle"><code>WCF.Action.Delete</code> and <code>WCF.Action.Toggle</code><a class="headerlink" href="#wcfactiondelete-and-wcfactiontoggle" title="Permanent link">#</a></h2>
2035<p><code>WCF.Action.Delete</code> and <code>WCF.Action.Toggle</code> were used for buttons to delete or enable/disable objects via JavaScript.
2036In each template, <code>WCF.Action.Delete</code> or <code>WCF.Action.Toggle</code> instances had to be manually created for each object listing.</p>
2037<p>With version 5.4 of WoltLab Suite, we have added a CSS selector-based global TypeScript module that only requires specific CSS classes to be added to the HTML structure for these buttons to work.
2038Additionally, we have added a new <code>{objectAction}</code> template plugin, which generates these buttons reducing the amount of boilerplate template code.</p>
2039<p>The required base HTML structure is as follows:</p>
2040<ol>
2041<li>A <code>.jsObjectActionContainer</code> element with a <code>data-object-action-class-name</code> attribute that contains the name of PHP class that executes the actions.</li>
2042<li><code>.jsObjectActionObject</code> elements within <code>.jsObjectActionContainer</code> that represent the objects for which actions can be executed.
2043 Each <code>.jsObjectActionObject</code> element must have a <code>data-object-id</code> attribute with the id of the object.</li>
2044<li><code>.jsObjectAction</code> elements within <code>.jsObjectActionObject</code> for each action with a <code>data-object-action</code> attribute with the name of the action.
2045 These elements can be generated with the <code>{objectAction}</code> template plugin for the <code>delete</code> and <code>toggle</code> action.</li>
2046</ol>
2047<p>Example:</p>
704cbc4a
WG
2048<table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"> 1</span>
2049<span class="normal"> 2</span>
2050<span class="normal"> 3</span>
2051<span class="normal"> 4</span>
2052<span class="normal"> 5</span>
2053<span class="normal"> 6</span>
2054<span class="normal"> 7</span>
2055<span class="normal"> 8</span>
2056<span class="normal"> 9</span>
2057<span class="normal">10</span>
2058<span class="normal">11</span>
2059<span class="normal">12</span>
2060<span class="normal">13</span>
2061<span class="normal">14</span>
2062<span class="normal">15</span>
2063<span class="normal">16</span>
2064<span class="normal">17</span>
2065<span class="normal">18</span>
2066<span class="normal">19</span>
2067<span class="normal">20</span>
2068<span class="normal">21</span></pre></div></td><td class="code"><div class="highlight"><pre><span></span><code><span class="x">&lt;table class=&quot;table jsObjectActionContainer&quot; </span><span class="cp">{</span><span class="c">*</span>
fb962f09
WG
2069<span class="c"> *</span><span class="cp">}</span><span class="x">data-object-action-class-name=&quot;wcf\data\foo\FooAction&quot;&gt;</span>
2070<span class="x"> &lt;thead&gt;</span>
2071<span class="x"> &lt;tr&gt;</span>
2072<span class="x"> </span><span class="cp">{</span><span class="c">* … *</span><span class="cp">}</span><span class="x"></span>
2073<span class="x"> &lt;/tr&gt;</span>
2074<span class="x"> &lt;/thead&gt;</span>
2075
2076<span class="x"> &lt;tbody&gt;</span>
2077<span class="x"> </span><span class="cp">{</span><span class="nf">foreach</span> <span class="na">from</span><span class="o">=</span><span class="nv">$objects</span> <span class="na">item</span><span class="o">=</span><span class="na">foo</span><span class="cp">}</span><span class="x"></span>
2078<span class="x"> &lt;tr class=&quot;jsObjectActionObject&quot; data-object-id=&quot;</span><span class="cp">{</span><span class="o">@</span><span class="nv">$foo</span><span class="o">-&gt;</span><span class="na">getObjectID</span><span class="o">()</span><span class="cp">}</span><span class="x">&quot;&gt;</span>
2079<span class="x"> &lt;td class=&quot;columnIcon&quot;&gt;</span>
2080<span class="x"> </span><span class="cp">{</span><span class="nf">objectAction</span> <span class="na">action</span><span class="o">=</span><span class="s2">&quot;toggle&quot;</span> <span class="na">isDisabled</span><span class="o">=</span><span class="nv">$foo</span><span class="o">-&gt;</span><span class="na">isDisabled</span><span class="cp">}</span><span class="x"></span>
2081<span class="x"> </span><span class="cp">{</span><span class="nf">objectAction</span> <span class="na">action</span><span class="o">=</span><span class="s2">&quot;delete&quot;</span> <span class="na">objectTitle</span><span class="o">=</span><span class="nv">$foo</span><span class="o">-&gt;</span><span class="na">getTitle</span><span class="o">()</span><span class="cp">}</span><span class="x"></span>
2082<span class="x"> </span><span class="cp">{</span><span class="c">* … *</span><span class="cp">}</span><span class="x"></span>
2083<span class="x"> &lt;/td&gt;</span>
2084<span class="x"> </span><span class="cp">{</span><span class="c">* … *</span><span class="cp">}</span><span class="x"></span>
2085<span class="x"> &lt;/tr&gt;</span>
2086<span class="x"> </span><span class="cp">{</span><span class="nf">/foreach</span><span class="cp">}</span><span class="x"></span>
2087<span class="x"> &lt;/tbody&gt;</span>
2088<span class="x">&lt;/table&gt;</span>
d7b81aff 2089</code></pre></div>
704cbc4a 2090</td></tr></table>
d7b81aff
WG
2091<p>Please refer to the documentation in <a href="https://github.com/WoltLab/WCF/blob/master/wcfsetup/install/files/lib/system/template/plugin/ObjectActionFunctionTemplatePlugin.class.php"><code>ObjectActionFunctionTemplatePlugin</code></a> for details and examples on how to use this template plugin.</p>
2092<p>The relevant TypeScript module registering the event listeners on the object action buttons is <a href="https://github.com/WoltLab/WCF/blob/master/ts/WoltLabSuite/Core/Ui/Object/Action.ts"><code>Ui/Object/Action</code></a>.
2093When an action button is clicked, an AJAX request is sent using the PHP class name and action name.
2094After the successful execution of the action, the page is either reloaded if the action button has a <code>data-object-action-success="reload"</code> attribute or an event using the <code>EventHandler</code> module is fired using <code>WoltLabSuite/Core/Ui/Object/Action</code> as the identifier and the object action name.
2095<a href="https://github.com/WoltLab/WCF/blob/master/ts/WoltLabSuite/Core/Ui/Object/Action/Delete.ts"><code>Ui/Object/Action/Delete</code></a> and <a href="https://github.com/WoltLab/WCF/blob/master/ts/WoltLabSuite/Core/Ui/Object/Action/Toggle.ts"><code>Ui/Object/Action/Toggle</code></a> listen to these events and update the user interface depending on the execute action by removing the object or updating the toggle button, respectively.</p>
2096<p>Converting from <code>WCF.Action.*</code> to the new approach requires minimal changes per template, as shown in the relevant pull request <a href="https://github.com/WoltLab/WCF/pull/4080">#4080</a>.</p>
cf171f0d
WG
2097<h2 id="wcftableemptytablehandler"><code>WCF.Table.EmptyTableHandler</code><a class="headerlink" href="#wcftableemptytablehandler" title="Permanent link">#</a></h2>
2098<p>When all objects in a table or list are deleted via their delete button or clipboard actions, an empty table or list can remain.
2099Previously, <code>WCF.Table.EmptyTableHandler</code> had to be explicitly used in each template for these tables and lists to reload the page.
2100As a TypeScript-based replacement for <code>WCF.Table.EmptyTableHandler</code> that is only initialized once globally, <code>WoltLabSuite/Core/Ui/Empty</code> was added.
2101To use this new module, you only have to add the CSS class <code>jsReloadPageWhenEmpty</code> to the relevant HTML element.
2102Once this HTML element no longer has child elements, the page is reloaded.
2103To also cover scenarios in which there are fixed child elements that should not be considered when determining if there are no child elements, the <code>data-reload-page-when-empty="ignore"</code> can be set for these elements.</p>
2104<p>Examples:</p>
704cbc4a
WG
2105<table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"> 1</span>
2106<span class="normal"> 2</span>
2107<span class="normal"> 3</span>
2108<span class="normal"> 4</span>
2109<span class="normal"> 5</span>
2110<span class="normal"> 6</span>
2111<span class="normal"> 7</span>
2112<span class="normal"> 8</span>
2113<span class="normal"> 9</span>
2114<span class="normal">10</span>
2115<span class="normal">11</span>
2116<span class="normal">12</span>
2117<span class="normal">13</span>
2118<span class="normal">14</span>
2119<span class="normal">15</span></pre></div></td><td class="code"><div class="highlight"><pre><span></span><code><span class="x">&lt;table class=&quot;table&quot;&gt;</span>
cf171f0d
WG
2120<span class="x"> &lt;thead&gt;</span>
2121<span class="x"> &lt;tr&gt;</span>
2122<span class="x"> </span><span class="cp">{</span><span class="c">* … *</span><span class="cp">}</span><span class="x"></span>
2123<span class="x"> &lt;/tr&gt;</span>
2124<span class="x"> &lt;/thead&gt;</span>
2125
2126<span class="x"> &lt;tbody class=&quot;jsReloadPageWhenEmpty&quot;&gt;</span>
2127<span class="x"> </span><span class="cp">{</span><span class="nf">foreach</span> <span class="na">from</span><span class="o">=</span><span class="nv">$objects</span> <span class="na">item</span><span class="o">=</span><span class="na">object</span><span class="cp">}</span><span class="x"></span>
2128<span class="x"> &lt;tr&gt;</span>
2129<span class="x"> </span><span class="cp">{</span><span class="c">* … *</span><span class="cp">}</span><span class="x"></span>
2130<span class="x"> &lt;/tr&gt;</span>
2131<span class="x"> </span><span class="cp">{</span><span class="nf">/foreach</span><span class="cp">}</span><span class="x"></span>
2132<span class="x"> &lt;/tbody&gt;</span>
2133<span class="x">&lt;/table&gt;</span>
2134</code></pre></div>
704cbc4a
WG
2135</td></tr></table>
2136<table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"> 1</span>
2137<span class="normal"> 2</span>
2138<span class="normal"> 3</span>
2139<span class="normal"> 4</span>
2140<span class="normal"> 5</span>
2141<span class="normal"> 6</span>
2142<span class="normal"> 7</span>
2143<span class="normal"> 8</span>
2144<span class="normal"> 9</span>
2145<span class="normal">10</span>
2146<span class="normal">11</span>
2147<span class="normal">12</span>
2148<span class="normal">13</span></pre></div></td><td class="code"><div class="highlight"><pre><span></span><code><span class="x">&lt;div class=&quot;section tabularBox messageGroupList&quot;&gt;</span>
cf171f0d
WG
2149<span class="x"> &lt;ol class=&quot;tabularList jsReloadPageWhenEmpty&quot;&gt;</span>
2150<span class="x"> &lt;li class=&quot;tabularListRow tabularListRowHead&quot; data-reload-page-when-empty=&quot;ignore&quot;&gt;</span>
2151<span class="x"> </span><span class="cp">{</span><span class="c">* … *</span><span class="cp">}</span><span class="x"></span>
2152<span class="x"> &lt;/li&gt;</span>
2153
2154<span class="x"> </span><span class="cp">{</span><span class="nf">foreach</span> <span class="na">from</span><span class="o">=</span><span class="nv">$objects</span> <span class="na">item</span><span class="o">=</span><span class="na">object</span><span class="cp">}</span><span class="x"></span>
2155<span class="x"> &lt;li&gt;</span>
2156<span class="x"> </span><span class="cp">{</span><span class="c">* … *</span><span class="cp">}</span><span class="x"></span>
2157<span class="x"> &lt;/li&gt;</span>
2158<span class="x"> </span><span class="cp">{</span><span class="nf">/foreach</span><span class="cp">}</span><span class="x"></span>
2159<span class="x"> &lt;/ol&gt;</span>
2160<span class="x">&lt;/div&gt;</span>
2161</code></pre></div>
704cbc4a 2162</td></tr></table>
45ca63d0 2163
4a5c32e1
WG
2164
2165
2166
2167<hr>
2168<div class="md-source-date">
2169 <small>
2170
77efcd46 2171 Last update: 2021-04-13
4a5c32e1
WG
2172
2173 </small>
2174</div>
2175
2176
45ca63d0
TD
2177
2178
2179
2180
2181
2182
2183 </article>
2184 </div>
2185 </div>
fb962f09 2186
45ca63d0
TD
2187 </main>
2188
2189
2190<footer class="md-footer">
2191
2192 <nav class="md-footer__inner md-grid" aria-label="Footer">
2193
2194 <a href="../session/" class="md-footer__link md-footer__link--prev" rel="prev">
2195 <div class="md-footer__button md-icon">
2196 <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>
2197 </div>
2198 <div class="md-footer__title">
2199 <div class="md-ellipsis">
2200 <span class="md-footer__direction">
2201 Previous
2202 </span>
2203 Session Handling and Authentication
2204 </div>
2205 </div>
2206 </a>
2207
2208
2209 <a href="../templates/" class="md-footer__link md-footer__link--next" rel="next">
2210 <div class="md-footer__title">
2211 <div class="md-ellipsis">
2212 <span class="md-footer__direction">
2213 Next
2214 </span>
2215 Templates
2216 </div>
2217 </div>
2218 <div class="md-footer__button md-icon">
2219 <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>
2220 </div>
2221 </a>
2222
2223 </nav>
2224
2225 <div class="md-footer-meta md-typeset">
2226 <div class="md-footer-meta__inner md-grid">
2227 <div class="md-footer-copyright">
2228
2229 <div class="md-footer-copyright__highlight">
2230 Copyright © 2020 WoltLab GmbH
2231 </div>
2232
2233 Made with
2234 <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
2235 Material for MkDocs
2236 </a>
fb88dc6e 2237
45ca63d0
TD
2238 </div>
2239 <div class="md-footer-copyright">
2240 <a href="https://www.woltlab.com/legal-notice/">Legal Notice</a>
2241 <a href="https://www.woltlab.com/privacy-policy/">Privacy Policy</a>
2242</div>
2243 </div>
2244 </div>
2245</footer>
2246
2247 </div>
2248 <div class="md-dialog" data-md-component="dialog">
2249 <div class="md-dialog__inner md-typeset"></div>
2250 </div>
fb962f09 2251 <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>
45ca63d0
TD
2252
2253
a4835aa6 2254 <script src="../../../assets/javascripts/bundle.4ea5477f.min.js"></script>
45ca63d0
TD
2255
2256
2257 </body>
2258</html>