Deployed 541d1ec to 5.4 with MkDocs 1.1.2 and mike 0.5.5
[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
WG
12 <link rel="icon" href="../../../assets/default.favicon.ico">
13 <meta name="generator" content="mkdocs-1.1.2, mkdocs-material-7.1.0">
45ca63d0
TD
14
15
16
17 <title>JavaScript - WoltLab Suite Documentation</title>
18
19
20
fb962f09 21 <link rel="stylesheet" href="../../../assets/stylesheets/main.33e2939f.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
63 <a href="#migrating-from-wsc-53-javascript" class="md-skip">
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
100 JavaScript
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
309 <li class="md-nav__item">
310 <a href="../../../php/api/caches/" class="md-nav__link">
311 Caches
312 </a>
313 </li>
314
315
316
317
318
319
320
321 <li class="md-nav__item">
322 <a href="../../../php/api/comments/" class="md-nav__link">
323 Comments
324 </a>
325 </li>
326
327
328
329
330
331
332
333 <li class="md-nav__item">
334 <a href="../../../php/api/cronjobs/" class="md-nav__link">
335 Cronjobs
336 </a>
337 </li>
338
339
340
341
342
343
344
345 <li class="md-nav__item">
346 <a href="../../../php/api/events/" class="md-nav__link">
347 Events
348 </a>
349 </li>
350
351
352
353
354
355
356
357
358 <li class="md-nav__item md-nav__item--nested">
359
360
361 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5_5" type="checkbox" id="__nav_2_5_5" >
362
363 <label class="md-nav__link" for="__nav_2_5_5">
364 Form Builder
365 <span class="md-nav__icon md-icon"></span>
366 </label>
367 <nav class="md-nav" aria-label="Form Builder" data-md-level="3">
368 <label class="md-nav__title" for="__nav_2_5_5">
369 <span class="md-nav__icon md-icon"></span>
370 Form Builder
371 </label>
372 <ul class="md-nav__list" data-md-scrollfix>
373
374
375
376
377
378 <li class="md-nav__item">
379 <a href="../../../php/api/form_builder/overview/" class="md-nav__link">
380 Overview
381 </a>
382 </li>
383
384
385
386
387
388
389
390 <li class="md-nav__item">
391 <a href="../../../php/api/form_builder/structure/" class="md-nav__link">
392 Structure
393 </a>
394 </li>
395
396
397
398
399
400
401
402 <li class="md-nav__item">
403 <a href="../../../php/api/form_builder/form_fields/" class="md-nav__link">
404 Fields
405 </a>
406 </li>
407
408
409
410
411
412
413
414 <li class="md-nav__item">
415 <a href="../../../php/api/form_builder/validation_data/" class="md-nav__link">
416 Validation and Data
417 </a>
418 </li>
419
420
421
422
423
424
425
426 <li class="md-nav__item">
427 <a href="../../../php/api/form_builder/dependencies/" class="md-nav__link">
428 Dependencies
429 </a>
430 </li>
431
432
433
434 </ul>
435 </nav>
436 </li>
437
438
439
440
441
442
443
444 <li class="md-nav__item">
445 <a href="../../../php/api/package_installation_plugins/" class="md-nav__link">
446 Package Installation Plugins
447 </a>
448 </li>
449
450
451
452
453
454
455
456 <li class="md-nav__item">
457 <a href="../../../php/api/user_activity_points/" class="md-nav__link">
458 User Activity Points
459 </a>
460 </li>
461
462
463
464
465
466
467
468 <li class="md-nav__item">
469 <a href="../../../php/api/user_notifications/" class="md-nav__link">
470 User Notifications
471 </a>
472 </li>
473
474
475
476
477
478
479
480 <li class="md-nav__item">
481 <a href="../../../php/api/sitemaps/" class="md-nav__link">
482 Sitemaps
483 </a>
484 </li>
485
486
487
488 </ul>
489 </nav>
490 </li>
491
492
493
494
495
496
497
498 <li class="md-nav__item">
499 <a href="../../../php/code-style/" class="md-nav__link">
500 Code Style
501 </a>
502 </li>
503
504
505
506
507
508
509
510 <li class="md-nav__item">
511 <a href="../../../php/apps/" class="md-nav__link">
512 Apps
513 </a>
514 </li>
515
516
517
518
519
520
521
522 <li class="md-nav__item">
523 <a href="../../../php/gdpr/" class="md-nav__link">
524 GDPR
525 </a>
526 </li>
527
528
529
530 </ul>
531 </nav>
532 </li>
533
534
535
536
537
538
539
540
541
542
543
544 <li class="md-nav__item md-nav__item--nested">
545
546
547 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" type="checkbox" id="__nav_3" >
548
549 <label class="md-nav__link" for="__nav_3">
550 Languages, Templates & CSS
551 <span class="md-nav__icon md-icon"></span>
552 </label>
553 <nav class="md-nav" aria-label="Languages, Templates & CSS" data-md-level="1">
554 <label class="md-nav__title" for="__nav_3">
555 <span class="md-nav__icon md-icon"></span>
556 Languages, Templates & CSS
557 </label>
558 <ul class="md-nav__list" data-md-scrollfix>
559
560
561
562
563
564 <li class="md-nav__item">
565 <a href="../../../view/languages/" class="md-nav__link">
566 Languages
567 </a>
568 </li>
569
570
571
572
573
574
575
576 <li class="md-nav__item">
577 <a href="../../../view/templates/" class="md-nav__link">
578 Templates
579 </a>
580 </li>
581
582
583
584
585
586
587
588 <li class="md-nav__item">
589 <a href="../../../view/css/" class="md-nav__link">
590 CSS
591 </a>
592 </li>
593
594
595
596 </ul>
597 </nav>
598 </li>
599
600
601
602
603
604
605
606
607
608
609
610 <li class="md-nav__item md-nav__item--nested">
611
612
613 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" >
614
615 <label class="md-nav__link" for="__nav_4">
616 JavaScript API
617 <span class="md-nav__icon md-icon"></span>
618 </label>
619 <nav class="md-nav" aria-label="JavaScript API" data-md-level="1">
620 <label class="md-nav__title" for="__nav_4">
621 <span class="md-nav__icon md-icon"></span>
622 JavaScript API
623 </label>
624 <ul class="md-nav__list" data-md-scrollfix>
625
626
627
628
629
630 <li class="md-nav__item">
631 <a href="../../../javascript/general-usage/" class="md-nav__link">
632 General Usage
633 </a>
634 </li>
635
636
637
638
639
640
641
642
643 <li class="md-nav__item md-nav__item--nested">
644
645
646 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4_2" type="checkbox" id="__nav_4_2" >
647
648 <label class="md-nav__link" for="__nav_4_2">
649 New API
650 <span class="md-nav__icon md-icon"></span>
651 </label>
652 <nav class="md-nav" aria-label="New API" data-md-level="2">
653 <label class="md-nav__title" for="__nav_4_2">
654 <span class="md-nav__icon md-icon"></span>
655 New API
656 </label>
657 <ul class="md-nav__list" data-md-scrollfix>
658
659
660
661
662
663 <li class="md-nav__item">
664 <a href="../../../javascript/new-api_writing-a-module/" class="md-nav__link">
665 Writing a module
666 </a>
667 </li>
668
669
670
671
672
673
674
675 <li class="md-nav__item">
676 <a href="../../../javascript/new-api_data-structures/" class="md-nav__link">
677 Data Structures
678 </a>
679 </li>
680
681
682
683
684
685
686
687 <li class="md-nav__item">
688 <a href="../../../javascript/new-api_core/" class="md-nav__link">
689 Core Functions
690 </a>
691 </li>
692
693
694
695
696
697
698
699 <li class="md-nav__item">
700 <a href="../../../javascript/new-api_dom/" class="md-nav__link">
701 DOM
702 </a>
703 </li>
704
705
706
707
708
709
710
711 <li class="md-nav__item">
712 <a href="../../../javascript/new-api_events/" class="md-nav__link">
713 Event Handling
714 </a>
715 </li>
716
717
718
719
720
721
722
723 <li class="md-nav__item">
724 <a href="../../../javascript/new-api_ajax/" class="md-nav__link">
725 Ajax
726 </a>
727 </li>
728
729
730
731
732
733
734
735 <li class="md-nav__item">
736 <a href="../../../javascript/new-api_dialogs/" class="md-nav__link">
737 Dialogs
738 </a>
739 </li>
740
741
742
743
744
745
746
747 <li class="md-nav__item">
748 <a href="../../../javascript/new-api_browser/" class="md-nav__link">
749 Browser and Screen Sizes
750 </a>
751 </li>
752
753
754
755
756
757
758
759 <li class="md-nav__item">
760 <a href="../../../javascript/new-api_ui/" class="md-nav__link">
761 User Interface
762 </a>
763 </li>
764
765
766
767 </ul>
768 </nav>
769 </li>
770
771
772
773
774
775
776
777 <li class="md-nav__item">
778 <a href="../../../javascript/legacy-api/" class="md-nav__link">
779 Legacy API
780 </a>
781 </li>
782
783
784
785
786
787
788
789 <li class="md-nav__item">
790 <a href="../../../javascript/helper-functions/" class="md-nav__link">
791 Helper Functions
792 </a>
793 </li>
794
795
796
797
798
799
800
801 <li class="md-nav__item">
802 <a href="../../../javascript/code-snippets/" class="md-nav__link">
803 Code Snippets
804 </a>
805 </li>
806
807
808
809 </ul>
810 </nav>
811 </li>
812
813
814
815
816
817
818
819
820
821
822
823 <li class="md-nav__item md-nav__item--nested">
824
825
826 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" >
827
828 <label class="md-nav__link" for="__nav_5">
829 Package Components
830 <span class="md-nav__icon md-icon"></span>
831 </label>
832 <nav class="md-nav" aria-label="Package Components" data-md-level="1">
833 <label class="md-nav__title" for="__nav_5">
834 <span class="md-nav__icon md-icon"></span>
835 Package Components
836 </label>
837 <ul class="md-nav__list" data-md-scrollfix>
838
839
840
841
842
843 <li class="md-nav__item">
844 <a href="../../../package/package-xml/" class="md-nav__link">
845 package.xml
846 </a>
847 </li>
848
849
850
851
852
853
854
855
856 <li class="md-nav__item md-nav__item--nested">
857
858
859 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_2" type="checkbox" id="__nav_5_2" >
860
861 <label class="md-nav__link" for="__nav_5_2">
862 PIPs
863 <span class="md-nav__icon md-icon"></span>
864 </label>
865 <nav class="md-nav" aria-label="PIPs" data-md-level="2">
866 <label class="md-nav__title" for="__nav_5_2">
867 <span class="md-nav__icon md-icon"></span>
868 PIPs
869 </label>
870 <ul class="md-nav__list" data-md-scrollfix>
871
872
873
874
875
876 <li class="md-nav__item">
877 <a href="../../../package/pip/" class="md-nav__link">
878 Overview
879 </a>
880 </li>
881
882
883
884
885
886
887
888 <li class="md-nav__item">
889 <a href="../../../package/pip/acl-option/" class="md-nav__link">
890 aclOption
891 </a>
892 </li>
893
894
895
896
897
898
899
900 <li class="md-nav__item">
901 <a href="../../../package/pip/acp-menu/" class="md-nav__link">
902 acpMenu
903 </a>
904 </li>
905
906
907
908
909
910
911
912 <li class="md-nav__item">
913 <a href="../../../package/pip/acp-search-provider/" class="md-nav__link">
914 acpSearchProvider
915 </a>
916 </li>
917
918
919
920
921
922
923
924 <li class="md-nav__item">
925 <a href="../../../package/pip/acp-template/" class="md-nav__link">
926 acpTemplate
927 </a>
928 </li>
929
930
931
932
933
934
935
936 <li class="md-nav__item">
937 <a href="../../../package/pip/bbcode/" class="md-nav__link">
938 bbcode
939 </a>
940 </li>
941
942
943
944
945
946
947
948 <li class="md-nav__item">
949 <a href="../../../package/pip/box/" class="md-nav__link">
950 box
951 </a>
952 </li>
953
954
955
956
957
958
959
960 <li class="md-nav__item">
961 <a href="../../../package/pip/clipboard-action/" class="md-nav__link">
962 clipboardAction
963 </a>
964 </li>
965
966
967
968
969
970
971
972 <li class="md-nav__item">
973 <a href="../../../package/pip/core-object/" class="md-nav__link">
974 coreObject
975 </a>
976 </li>
977
978
979
980
981
982
983
984 <li class="md-nav__item">
985 <a href="../../../package/pip/cronjob/" class="md-nav__link">
986 cronjob
987 </a>
988 </li>
989
990
991
992
993
994
995
996 <li class="md-nav__item">
997 <a href="../../../package/pip/event-listener/" class="md-nav__link">
998 eventListener
999 </a>
1000 </li>
1001
1002
1003
1004
1005
1006
1007
1008 <li class="md-nav__item">
1009 <a href="../../../package/pip/file/" class="md-nav__link">
1010 file
1011 </a>
1012 </li>
1013
1014
1015
1016
1017
1018
1019
1020 <li class="md-nav__item">
1021 <a href="../../../package/pip/language/" class="md-nav__link">
1022 language
1023 </a>
1024 </li>
1025
1026
1027
1028
1029
1030
1031
1032 <li class="md-nav__item">
1033 <a href="../../../package/pip/media-provider/" class="md-nav__link">
1034 mediaProvider
1035 </a>
1036 </li>
1037
1038
1039
1040
1041
1042
1043
1044 <li class="md-nav__item">
1045 <a href="../../../package/pip/menu/" class="md-nav__link">
1046 menu
1047 </a>
1048 </li>
1049
1050
1051
1052
1053
1054
1055
1056 <li class="md-nav__item">
1057 <a href="../../../package/pip/menu-item/" class="md-nav__link">
1058 menuItem
1059 </a>
1060 </li>
1061
1062
1063
1064
1065
1066
1067
1068 <li class="md-nav__item">
1069 <a href="../../../package/pip/object-type/" class="md-nav__link">
1070 objectType
1071 </a>
1072 </li>
1073
1074
1075
1076
1077
1078
1079
1080 <li class="md-nav__item">
1081 <a href="../../../package/pip/object-type-definition/" class="md-nav__link">
1082 objectTypeDefinition
1083 </a>
1084 </li>
1085
1086
1087
1088
1089
1090
1091
1092 <li class="md-nav__item">
1093 <a href="../../../package/pip/option/" class="md-nav__link">
1094 option
1095 </a>
1096 </li>
1097
1098
1099
1100
1101
1102
1103
1104 <li class="md-nav__item">
1105 <a href="../../../package/pip/page/" class="md-nav__link">
1106 page
1107 </a>
1108 </li>
1109
1110
1111
1112
1113
1114
1115
1116 <li class="md-nav__item">
1117 <a href="../../../package/pip/pip/" class="md-nav__link">
1118 pip
1119 </a>
1120 </li>
1121
1122
1123
1124
1125
1126
1127
1128 <li class="md-nav__item">
1129 <a href="../../../package/pip/script/" class="md-nav__link">
1130 script
1131 </a>
1132 </li>
1133
1134
1135
1136
1137
1138
1139
1140 <li class="md-nav__item">
1141 <a href="../../../package/pip/smiley/" class="md-nav__link">
1142 smiley
1143 </a>
1144 </li>
1145
1146
1147
1148
1149
1150
1151
1152 <li class="md-nav__item">
1153 <a href="../../../package/pip/sql/" class="md-nav__link">
1154 sql
1155 </a>
1156 </li>
1157
1158
1159
1160
1161
1162
1163
1164 <li class="md-nav__item">
1165 <a href="../../../package/pip/style/" class="md-nav__link">
1166 style
1167 </a>
1168 </li>
1169
1170
1171
1172
1173
1174
1175
1176 <li class="md-nav__item">
1177 <a href="../../../package/pip/template/" class="md-nav__link">
1178 template
1179 </a>
1180 </li>
1181
1182
1183
1184
1185
1186
1187
1188 <li class="md-nav__item">
1189 <a href="../../../package/pip/template-listener/" class="md-nav__link">
1190 templateListener
1191 </a>
1192 </li>
1193
1194
1195
1196
1197
1198
1199
1200 <li class="md-nav__item">
1201 <a href="../../../package/pip/user-group-option/" class="md-nav__link">
1202 userGroupOption
1203 </a>
1204 </li>
1205
1206
1207
1208
1209
1210
1211
1212 <li class="md-nav__item">
1213 <a href="../../../package/pip/user-menu/" class="md-nav__link">
1214 userMenu
1215 </a>
1216 </li>
1217
1218
1219
1220
1221
1222
1223
1224 <li class="md-nav__item">
1225 <a href="../../../package/pip/user-notification-event/" class="md-nav__link">
1226 userNotificationEvent
1227 </a>
1228 </li>
1229
1230
1231
1232
1233
1234
1235
1236 <li class="md-nav__item">
1237 <a href="../../../package/pip/user-option/" class="md-nav__link">
1238 userOption
1239 </a>
1240 </li>
1241
1242
1243
1244
1245
1246
1247
1248 <li class="md-nav__item">
1249 <a href="../../../package/pip/user-profile-menu/" class="md-nav__link">
1250 userProfileMenu
1251 </a>
1252 </li>
1253
1254
1255
1256 </ul>
1257 </nav>
1258 </li>
1259
1260
1261
1262
1263
1264
1265
1266 <li class="md-nav__item">
1267 <a href="../../../package/database-php-api/" class="md-nav__link">
1268 Database PHP API
1269 </a>
1270 </li>
1271
1272
1273
1274 </ul>
1275 </nav>
1276 </li>
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290 <li class="md-nav__item md-nav__item--active md-nav__item--nested">
1291
1292
1293 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" checked>
1294
1295 <label class="md-nav__link" for="__nav_6">
1296 Migration
1297 <span class="md-nav__icon md-icon"></span>
1298 </label>
1299 <nav class="md-nav" aria-label="Migration" data-md-level="1">
1300 <label class="md-nav__title" for="__nav_6">
1301 <span class="md-nav__icon md-icon"></span>
1302 Migration
1303 </label>
1304 <ul class="md-nav__list" data-md-scrollfix>
1305
1306
1307
1308
1309
1310
1311
1312
1313 <li class="md-nav__item md-nav__item--active md-nav__item--nested">
1314
1315
1316 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_1" type="checkbox" id="__nav_6_1" checked>
1317
1318 <label class="md-nav__link" for="__nav_6_1">
1319 Migrating from WSC 5.3
1320 <span class="md-nav__icon md-icon"></span>
1321 </label>
1322 <nav class="md-nav" aria-label="Migrating from WSC 5.3" data-md-level="2">
1323 <label class="md-nav__title" for="__nav_6_1">
1324 <span class="md-nav__icon md-icon"></span>
1325 Migrating from WSC 5.3
1326 </label>
1327 <ul class="md-nav__list" data-md-scrollfix>
1328
1329
1330
1331
1332
1333 <li class="md-nav__item">
1334 <a href="../php/" class="md-nav__link">
1335 PHP API
1336 </a>
1337 </li>
1338
1339
1340
1341
1342
1343
1344
1345 <li class="md-nav__item">
1346 <a href="../session/" class="md-nav__link">
1347 Session Handling and Authentication
1348 </a>
1349 </li>
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359 <li class="md-nav__item md-nav__item--active">
1360
1361 <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
1362
1363
1364
1365
1366 <label class="md-nav__link md-nav__link--active" for="__toc">
1367 JavaScript
1368 <span class="md-nav__icon md-icon"></span>
1369 </label>
1370
1371 <a href="./" class="md-nav__link md-nav__link--active">
1372 JavaScript
1373 </a>
1374
1375
1376<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
1377
1378
1379
1380
1381
1382 <label class="md-nav__title" for="__toc">
1383 <span class="md-nav__icon md-icon"></span>
1384 Table of contents
1385 </label>
1386 <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
1387
1388 <li class="md-nav__item">
1389 <a href="#wcf_click_event" class="md-nav__link">
1390 WCF_CLICK_EVENT
1391 </a>
1392
d7b81aff
WG
1393</li>
1394
1395 <li class="md-nav__item">
1396 <a href="#wcfactiondelete-and-wcfactiontoggle" class="md-nav__link">
1397 WCF.Action.Delete and WCF.Action.Toggle
1398 </a>
1399
cf171f0d
WG
1400</li>
1401
1402 <li class="md-nav__item">
1403 <a href="#wcftableemptytablehandler" class="md-nav__link">
1404 WCF.Table.EmptyTableHandler
1405 </a>
1406
45ca63d0
TD
1407</li>
1408
1409 </ul>
1410
1411</nav>
1412
1413 </li>
1414
1415
1416
1417
1418
1419
1420
1421 <li class="md-nav__item">
1422 <a href="../templates/" class="md-nav__link">
1423 Templates
1424 </a>
1425 </li>
1426
1427
1428
1429
1430
1431
1432
1433 <li class="md-nav__item">
1434 <a href="../libraries/" class="md-nav__link">
1435 Third Party Libraries
1436 </a>
1437 </li>
1438
1439
1440
1441 </ul>
1442 </nav>
1443 </li>
1444
1445
1446
1447
1448
1449
1450
1451
1452 <li class="md-nav__item md-nav__item--nested">
1453
1454
1455 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_2" type="checkbox" id="__nav_6_2" >
1456
1457 <label class="md-nav__link" for="__nav_6_2">
1458 Migrating from WSC 5.2
1459 <span class="md-nav__icon md-icon"></span>
1460 </label>
1461 <nav class="md-nav" aria-label="Migrating from WSC 5.2" data-md-level="2">
1462 <label class="md-nav__title" for="__nav_6_2">
1463 <span class="md-nav__icon md-icon"></span>
1464 Migrating from WSC 5.2
1465 </label>
1466 <ul class="md-nav__list" data-md-scrollfix>
1467
1468
1469
1470
1471
1472 <li class="md-nav__item">
1473 <a href="../../wsc52/php/" class="md-nav__link">
1474 PHP API
1475 </a>
1476 </li>
1477
1478
1479
1480
1481
1482
1483
1484 <li class="md-nav__item">
1485 <a href="../../wsc52/templates/" class="md-nav__link">
1486 Templates and Languages
1487 </a>
1488 </li>
1489
1490
1491
1492
1493
1494
1495
1496 <li class="md-nav__item">
1497 <a href="../../wsc52/libraries/" class="md-nav__link">
1498 Third Party Libraries
1499 </a>
1500 </li>
1501
1502
1503
1504 </ul>
1505 </nav>
1506 </li>
1507
1508
1509
1510
1511
1512
1513
1514
1515 <li class="md-nav__item md-nav__item--nested">
1516
1517
1518 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_3" type="checkbox" id="__nav_6_3" >
1519
1520 <label class="md-nav__link" for="__nav_6_3">
1521 Migrating from WSC 3.1
1522 <span class="md-nav__icon md-icon"></span>
1523 </label>
1524 <nav class="md-nav" aria-label="Migrating from WSC 3.1" data-md-level="2">
1525 <label class="md-nav__title" for="__nav_6_3">
1526 <span class="md-nav__icon md-icon"></span>
1527 Migrating from WSC 3.1
1528 </label>
1529 <ul class="md-nav__list" data-md-scrollfix>
1530
1531
1532
1533
1534
1535 <li class="md-nav__item">
1536 <a href="../../wsc31/php/" class="md-nav__link">
1537 PHP API
1538 </a>
1539 </li>
1540
1541
1542
1543 </ul>
1544 </nav>
1545 </li>
1546
1547
1548
1549
1550
1551
1552
1553
1554 <li class="md-nav__item md-nav__item--nested">
1555
1556
1557 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_4" type="checkbox" id="__nav_6_4" >
1558
1559 <label class="md-nav__link" for="__nav_6_4">
1560 Migrating from WSC 3.0
1561 <span class="md-nav__icon md-icon"></span>
1562 </label>
1563 <nav class="md-nav" aria-label="Migrating from WSC 3.0" data-md-level="2">
1564 <label class="md-nav__title" for="__nav_6_4">
1565 <span class="md-nav__icon md-icon"></span>
1566 Migrating from WSC 3.0
1567 </label>
1568 <ul class="md-nav__list" data-md-scrollfix>
1569
1570
1571
1572
1573
1574 <li class="md-nav__item">
1575 <a href="../../wsc30/php/" class="md-nav__link">
1576 PHP API
1577 </a>
1578 </li>
1579
1580
1581
1582
1583
1584
1585
1586 <li class="md-nav__item">
1587 <a href="../../wsc30/javascript/" class="md-nav__link">
1588 JavaScript API
1589 </a>
1590 </li>
1591
1592
1593
1594
1595
1596
1597
1598 <li class="md-nav__item">
1599 <a href="../../wsc30/templates/" class="md-nav__link">
1600 Templates
1601 </a>
1602 </li>
1603
1604
1605
1606
1607
1608
1609
1610 <li class="md-nav__item">
1611 <a href="../../wsc30/css/" class="md-nav__link">
1612 CSS
1613 </a>
1614 </li>
1615
1616
1617
1618
1619
1620
1621
1622 <li class="md-nav__item">
1623 <a href="../../wsc30/package/" class="md-nav__link">
1624 Package Components
1625 </a>
1626 </li>
1627
1628
1629
1630 </ul>
1631 </nav>
1632 </li>
1633
1634
1635
1636
1637
1638
1639
1640
1641 <li class="md-nav__item md-nav__item--nested">
1642
1643
1644 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_5" type="checkbox" id="__nav_6_5" >
1645
1646 <label class="md-nav__link" for="__nav_6_5">
1647 Migrating from WCF 2.1
1648 <span class="md-nav__icon md-icon"></span>
1649 </label>
1650 <nav class="md-nav" aria-label="Migrating from WCF 2.1" data-md-level="2">
1651 <label class="md-nav__title" for="__nav_6_5">
1652 <span class="md-nav__icon md-icon"></span>
1653 Migrating from WCF 2.1
1654 </label>
1655 <ul class="md-nav__list" data-md-scrollfix>
1656
1657
1658
1659
1660
1661 <li class="md-nav__item">
1662 <a href="../../wcf21/php/" class="md-nav__link">
1663 PHP API
1664 </a>
1665 </li>
1666
1667
1668
1669
1670
1671
1672
1673 <li class="md-nav__item">
1674 <a href="../../wcf21/templates/" class="md-nav__link">
1675 Templates
1676 </a>
1677 </li>
1678
1679
1680
1681
1682
1683
1684
1685 <li class="md-nav__item">
1686 <a href="../../wcf21/css/" class="md-nav__link">
1687 CSS
1688 </a>
1689 </li>
1690
1691
1692
1693
1694
1695
1696
1697 <li class="md-nav__item">
1698 <a href="../../wcf21/package/" class="md-nav__link">
1699 Package Components
1700 </a>
1701 </li>
1702
1703
1704
1705 </ul>
1706 </nav>
1707 </li>
1708
1709
1710
1711 </ul>
1712 </nav>
1713 </li>
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725 <li class="md-nav__item md-nav__item--nested">
1726
1727
1728 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >
1729
1730 <label class="md-nav__link" for="__nav_7">
1731 Tutorials
1732 <span class="md-nav__icon md-icon"></span>
1733 </label>
1734 <nav class="md-nav" aria-label="Tutorials" data-md-level="1">
1735 <label class="md-nav__title" for="__nav_7">
1736 <span class="md-nav__icon md-icon"></span>
1737 Tutorials
1738 </label>
1739 <ul class="md-nav__list" data-md-scrollfix>
1740
1741
1742
1743
1744
1745
1746 <li class="md-nav__item md-nav__item--nested">
1747
1748
1749 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7_1" type="checkbox" id="__nav_7_1" >
1750
1751 <label class="md-nav__link" for="__nav_7_1">
1752 Tutorial Series
1753 <span class="md-nav__icon md-icon"></span>
1754 </label>
1755 <nav class="md-nav" aria-label="Tutorial Series" data-md-level="2">
1756 <label class="md-nav__title" for="__nav_7_1">
1757 <span class="md-nav__icon md-icon"></span>
1758 Tutorial Series
1759 </label>
1760 <ul class="md-nav__list" data-md-scrollfix>
1761
1762
1763
1764
1765
1766 <li class="md-nav__item">
1767 <a href="../../../tutorial/series/overview/" class="md-nav__link">
1768 Overview
1769 </a>
1770 </li>
1771
1772
1773
1774
1775
1776
1777
1778 <li class="md-nav__item">
1779 <a href="../../../tutorial/series/part_1/" class="md-nav__link">
1780 Part 1
1781 </a>
1782 </li>
1783
1784
1785
1786
1787
1788
1789
1790 <li class="md-nav__item">
1791 <a href="../../../tutorial/series/part_2/" class="md-nav__link">
1792 Part 2
1793 </a>
1794 </li>
1795
1796
1797
1798
1799
1800
1801
1802 <li class="md-nav__item">
1803 <a href="../../../tutorial/series/part_3/" class="md-nav__link">
1804 Part 3
1805 </a>
1806 </li>
1807
1808
1809
1810 </ul>
1811 </nav>
1812 </li>
1813
1814
1815
1816 </ul>
1817 </nav>
1818 </li>
1819
1820
1821
1822 </ul>
1823</nav>
1824 </div>
1825 </div>
1826 </div>
1827
1828
1829
1830 <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
1831 <div class="md-sidebar__scrollwrap">
1832 <div class="md-sidebar__inner">
1833
1834<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
1835
1836
1837
1838
1839
1840 <label class="md-nav__title" for="__toc">
1841 <span class="md-nav__icon md-icon"></span>
1842 Table of contents
1843 </label>
1844 <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
1845
1846 <li class="md-nav__item">
1847 <a href="#wcf_click_event" class="md-nav__link">
1848 WCF_CLICK_EVENT
1849 </a>
1850
d7b81aff
WG
1851</li>
1852
1853 <li class="md-nav__item">
1854 <a href="#wcfactiondelete-and-wcfactiontoggle" class="md-nav__link">
1855 WCF.Action.Delete and WCF.Action.Toggle
1856 </a>
1857
cf171f0d
WG
1858</li>
1859
1860 <li class="md-nav__item">
1861 <a href="#wcftableemptytablehandler" class="md-nav__link">
1862 WCF.Table.EmptyTableHandler
1863 </a>
1864
45ca63d0
TD
1865</li>
1866
1867 </ul>
1868
1869</nav>
1870 </div>
1871 </div>
1872 </div>
1873
1874
1875 <div class="md-content" data-md-component="content">
1876 <article class="md-content__inner md-typeset">
1877
1878
9b8bddda 1879 <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
1880 <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>
1881 </a>
1882
45ca63d0
TD
1883
1884 <h1 id="migrating-from-wsc-53-javascript">Migrating from WSC 5.3 - JavaScript<a class="headerlink" href="#migrating-from-wsc-53-javascript" title="Permanent link">#</a></h1>
1885<h2 id="wcf_click_event"><code>WCF_CLICK_EVENT</code><a class="headerlink" href="#wcf_click_event" title="Permanent link">#</a></h2>
1886<p>For event listeners on click events, <code>WCF_CLICK_EVENT</code> is deprecated and should no longer be used.
1887Instead, use <code>click</code> directly:</p>
1888<div class="highlight"><pre><span></span><code><span class="c1">// before</span>
1889<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>
1890
1891<span class="c1">// after</span>
1892<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>
1893</code></pre></div>
d7b81aff
WG
1894<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>
1895<p><code>WCF.Action.Delete</code> and <code>WCF.Action.Toggle</code> were used for buttons to delete or enable/disable objects via JavaScript.
1896In each template, <code>WCF.Action.Delete</code> or <code>WCF.Action.Toggle</code> instances had to be manually created for each object listing.</p>
1897<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.
1898Additionally, we have added a new <code>{objectAction}</code> template plugin, which generates these buttons reducing the amount of boilerplate template code.</p>
1899<p>The required base HTML structure is as follows:</p>
1900<ol>
1901<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>
1902<li><code>.jsObjectActionObject</code> elements within <code>.jsObjectActionContainer</code> that represent the objects for which actions can be executed.
1903 Each <code>.jsObjectActionObject</code> element must have a <code>data-object-id</code> attribute with the id of the object.</li>
1904<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.
1905 These elements can be generated with the <code>{objectAction}</code> template plugin for the <code>delete</code> and <code>toggle</code> action.</li>
1906</ol>
1907<p>Example:</p>
fb962f09
WG
1908<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>
1909<span class="c"> *</span><span class="cp">}</span><span class="x">data-object-action-class-name=&quot;wcf\data\foo\FooAction&quot;&gt;</span>
1910<span class="x"> &lt;thead&gt;</span>
1911<span class="x"> &lt;tr&gt;</span>
1912<span class="x"> </span><span class="cp">{</span><span class="c">* … *</span><span class="cp">}</span><span class="x"></span>
1913<span class="x"> &lt;/tr&gt;</span>
1914<span class="x"> &lt;/thead&gt;</span>
1915
1916<span class="x"> &lt;tbody&gt;</span>
1917<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>
1918<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>
1919<span class="x"> &lt;td class=&quot;columnIcon&quot;&gt;</span>
1920<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>
1921<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>
1922<span class="x"> </span><span class="cp">{</span><span class="c">* … *</span><span class="cp">}</span><span class="x"></span>
1923<span class="x"> &lt;/td&gt;</span>
1924<span class="x"> </span><span class="cp">{</span><span class="c">* … *</span><span class="cp">}</span><span class="x"></span>
1925<span class="x"> &lt;/tr&gt;</span>
1926<span class="x"> </span><span class="cp">{</span><span class="nf">/foreach</span><span class="cp">}</span><span class="x"></span>
1927<span class="x"> &lt;/tbody&gt;</span>
1928<span class="x">&lt;/table&gt;</span>
d7b81aff
WG
1929</code></pre></div>
1930<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>
1931<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>.
1932When an action button is clicked, an AJAX request is sent using the PHP class name and action name.
1933After 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.
1934<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>
1935<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
1936<h2 id="wcftableemptytablehandler"><code>WCF.Table.EmptyTableHandler</code><a class="headerlink" href="#wcftableemptytablehandler" title="Permanent link">#</a></h2>
1937<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.
1938Previously, <code>WCF.Table.EmptyTableHandler</code> had to be explicitly used in each template for these tables and lists to reload the page.
1939As a TypeScript-based replacement for <code>WCF.Table.EmptyTableHandler</code> that is only initialized once globally, <code>WoltLabSuite/Core/Ui/Empty</code> was added.
1940To use this new module, you only have to add the CSS class <code>jsReloadPageWhenEmpty</code> to the relevant HTML element.
1941Once this HTML element no longer has child elements, the page is reloaded.
1942To 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>
1943<p>Examples:</p>
1944<div class="highlight"><pre><span></span><code><span class="x">&lt;table class=&quot;table&quot;&gt;</span>
1945<span class="x"> &lt;thead&gt;</span>
1946<span class="x"> &lt;tr&gt;</span>
1947<span class="x"> </span><span class="cp">{</span><span class="c">* … *</span><span class="cp">}</span><span class="x"></span>
1948<span class="x"> &lt;/tr&gt;</span>
1949<span class="x"> &lt;/thead&gt;</span>
1950
1951<span class="x"> &lt;tbody class=&quot;jsReloadPageWhenEmpty&quot;&gt;</span>
1952<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>
1953<span class="x"> &lt;tr&gt;</span>
1954<span class="x"> </span><span class="cp">{</span><span class="c">* … *</span><span class="cp">}</span><span class="x"></span>
1955<span class="x"> &lt;/tr&gt;</span>
1956<span class="x"> </span><span class="cp">{</span><span class="nf">/foreach</span><span class="cp">}</span><span class="x"></span>
1957<span class="x"> &lt;/tbody&gt;</span>
1958<span class="x">&lt;/table&gt;</span>
1959</code></pre></div>
1960<div class="highlight"><pre><span></span><code><span class="x">&lt;div class=&quot;section tabularBox messageGroupList&quot;&gt;</span>
1961<span class="x"> &lt;ol class=&quot;tabularList jsReloadPageWhenEmpty&quot;&gt;</span>
1962<span class="x"> &lt;li class=&quot;tabularListRow tabularListRowHead&quot; data-reload-page-when-empty=&quot;ignore&quot;&gt;</span>
1963<span class="x"> </span><span class="cp">{</span><span class="c">* … *</span><span class="cp">}</span><span class="x"></span>
1964<span class="x"> &lt;/li&gt;</span>
1965
1966<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>
1967<span class="x"> &lt;li&gt;</span>
1968<span class="x"> </span><span class="cp">{</span><span class="c">* … *</span><span class="cp">}</span><span class="x"></span>
1969<span class="x"> &lt;/li&gt;</span>
1970<span class="x"> </span><span class="cp">{</span><span class="nf">/foreach</span><span class="cp">}</span><span class="x"></span>
1971<span class="x"> &lt;/ol&gt;</span>
1972<span class="x">&lt;/div&gt;</span>
1973</code></pre></div>
45ca63d0 1974
4a5c32e1
WG
1975
1976
1977
1978<hr>
1979<div class="md-source-date">
1980 <small>
1981
fb962f09 1982 Last update: 2021-04-06
4a5c32e1
WG
1983
1984 </small>
1985</div>
1986
1987
45ca63d0
TD
1988
1989
1990
1991
1992
1993
1994 </article>
1995 </div>
1996 </div>
fb962f09 1997
45ca63d0
TD
1998 </main>
1999
2000
2001<footer class="md-footer">
2002
2003 <nav class="md-footer__inner md-grid" aria-label="Footer">
2004
2005 <a href="../session/" class="md-footer__link md-footer__link--prev" rel="prev">
2006 <div class="md-footer__button md-icon">
2007 <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>
2008 </div>
2009 <div class="md-footer__title">
2010 <div class="md-ellipsis">
2011 <span class="md-footer__direction">
2012 Previous
2013 </span>
2014 Session Handling and Authentication
2015 </div>
2016 </div>
2017 </a>
2018
2019
2020 <a href="../templates/" class="md-footer__link md-footer__link--next" rel="next">
2021 <div class="md-footer__title">
2022 <div class="md-ellipsis">
2023 <span class="md-footer__direction">
2024 Next
2025 </span>
2026 Templates
2027 </div>
2028 </div>
2029 <div class="md-footer__button md-icon">
2030 <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>
2031 </div>
2032 </a>
2033
2034 </nav>
2035
2036 <div class="md-footer-meta md-typeset">
2037 <div class="md-footer-meta__inner md-grid">
2038 <div class="md-footer-copyright">
2039
2040 <div class="md-footer-copyright__highlight">
2041 Copyright © 2020 WoltLab GmbH
2042 </div>
2043
2044 Made with
2045 <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
2046 Material for MkDocs
2047 </a>
fb88dc6e 2048
45ca63d0
TD
2049 </div>
2050 <div class="md-footer-copyright">
2051 <a href="https://www.woltlab.com/legal-notice/">Legal Notice</a>
2052 <a href="https://www.woltlab.com/privacy-policy/">Privacy Policy</a>
2053</div>
2054 </div>
2055 </div>
2056</footer>
2057
2058 </div>
2059 <div class="md-dialog" data-md-component="dialog">
2060 <div class="md-dialog__inner md-typeset"></div>
2061 </div>
fb962f09 2062 <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
2063
2064
fb962f09 2065 <script src="../../../assets/javascripts/bundle.d892486b.min.js"></script>
45ca63d0
TD
2066
2067
2068 </body>
2069</html>