projects / GitHub / WoltLab / woltlab.github.io.git / blob
? search:


add61fb4b3b27969401a8d846f8c540ddfd48c52
[GitHub/WoltLab/woltlab.github.io.git] / 6.0 / javascript / new-api_dialogs / index.html
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 <link rel="canonical" href="https://docs.woltlab.com/6.0/javascript/new-api_dialogs/">
12
13
14 <link rel="prev" href="../new-api_ajax/">
15
16
17 <link rel="next" href="../new-api_browser/">
18
19 <link rel="icon" href="../../assets/default.favicon.ico">
20 <meta name="generator" content="mkdocs-1.4.2, mkdocs-material-9.0.13">
21
22
23
24 <title>Dialogs - WoltLab Suite Documentation</title>
25
26
27
28 <link rel="stylesheet" href="../../assets/stylesheets/main.ffa9267a.min.css">
29
30
31 <link rel="stylesheet" href="../../assets/stylesheets/palette.a0c5b2b5.min.css">
32
33
34
35
36
37
38
39
40
41 <link rel="stylesheet" href="../../stylesheets/extra.css">
42
43 <script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
44
45
46
47
48
49
50 </head>
51
52
53
54
55
56
57
58 <body dir="ltr" data-md-color-scheme="default" data-md-color-primary="teal" data-md-color-accent="">
59
60
61
62 <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
63 <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
64 <label class="md-overlay" for="__drawer"></label>
65 <div data-md-component="skip">
66
67
68 <a href="#dialogs-javascript-api" class="md-skip">
69 Skip to content
70 </a>
71
72 </div>
73 <div data-md-component="announce">
74
75 <aside class="md-banner">
76 <div class="md-banner__inner md-grid md-typeset">
77
78
79 <a href="https://www.woltlab.com">Back to <strong>woltlab.com</strong></a>
80
81 </div>
82
83 </aside>
84
85 </div>
86
87 <div data-md-color-scheme="default" data-md-component="outdated" hidden>
88
89 </div>
90
91
92
93
94 <header class="md-header" data-md-component="header">
95 <nav class="md-header__inner md-grid" aria-label="Header">
96 <a href="../.." title="WoltLab Suite Documentation" class="md-header__button md-logo" aria-label="WoltLab Suite Documentation" data-md-component="logo">
97
98 <img src="../../assets/logo.png" alt="logo">
99
100 </a>
101 <label class="md-header__button md-icon" for="__drawer">
102 <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg>
103 </label>
104 <div class="md-header__title" data-md-component="header-title">
105 <div class="md-header__ellipsis">
106 <div class="md-header__topic">
107 <span class="md-ellipsis">
108 WoltLab Suite Documentation
109 </span>
110 </div>
111 <div class="md-header__topic" data-md-component="header-topic">
112 <span class="md-ellipsis">
113
114 Dialogs
115
116 </span>
117 </div>
118 </div>
119 </div>
120
121
122
123 <label class="md-header__button md-icon" for="__search">
124 <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg>
125 </label>
126 <div class="md-search" data-md-component="search" role="dialog">
127 <label class="md-search__overlay" for="__search"></label>
128 <div class="md-search__inner" role="search">
129 <form class="md-search__form" name="search">
130 <input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
131 <label class="md-search__icon md-icon" for="__search">
132 <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg>
133 <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z"/></svg>
134 </label>
135 <nav class="md-search__options" aria-label="Search">
136
137 <button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
138 <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41Z"/></svg>
139 </button>
140 </nav>
141
142 </form>
143 <div class="md-search__output">
144 <div class="md-search__scrollwrap" data-md-scrollfix>
145 <div class="md-search-result" data-md-component="search-result">
146 <div class="md-search-result__meta">
147 Initializing search
148 </div>
149 <ol class="md-search-result__list" role="presentation"></ol>
150 </div>
151 </div>
152 </div>
153 </div>
154 </div>
155
156
157 <div class="md-header__source">
158 <a href="https://github.com/WoltLab/docs.woltlab.com/" title="Go to repository" class="md-source" data-md-component="source">
159 <div class="md-source__icon md-icon">
160
161 <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.3.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
162 </div>
163 <div class="md-source__repository">
164 GitHub
165 </div>
166 </a>
167 </div>
168
169 </nav>
170
171 </header>
172
173 <div class="md-container" data-md-component="container">
174
175
176
177
178
179
180 <main class="md-main" data-md-component="main">
181 <div class="md-main__inner md-grid">
182
183
184
185 <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
186 <div class="md-sidebar__scrollwrap">
187 <div class="md-sidebar__inner">
188
189
190
191 <nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
192 <label class="md-nav__title" for="__drawer">
193 <a href="../.." title="WoltLab Suite Documentation" class="md-nav__button md-logo" aria-label="WoltLab Suite Documentation" data-md-component="logo">
194
195 <img src="../../assets/logo.png" alt="logo">
196
197 </a>
198 WoltLab Suite Documentation
199 </label>
200
201 <div class="md-nav__source">
202 <a href="https://github.com/WoltLab/docs.woltlab.com/" title="Go to repository" class="md-source" data-md-component="source">
203 <div class="md-source__icon md-icon">
204
205 <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.3.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
206 </div>
207 <div class="md-source__repository">
208 GitHub
209 </div>
210 </a>
211 </div>
212
213 <ul class="md-nav__list" data-md-scrollfix>
214
215
216
217
218
219
220
221
222 <li class="md-nav__item">
223 <a href="../../getting-started/" class="md-nav__link">
224 Getting Started
225 </a>
226 </li>
227
228
229
230
231
232
233
234
235
236
237
238 <li class="md-nav__item md-nav__item--nested">
239
240
241
242
243 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2" >
244
245
246
247 <label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
248 PHP API
249 <span class="md-nav__icon md-icon"></span>
250 </label>
251
252 <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
253 <label class="md-nav__title" for="__nav_2">
254 <span class="md-nav__icon md-icon"></span>
255 PHP API
256 </label>
257 <ul class="md-nav__list" data-md-scrollfix>
258
259
260
261
262
263
264 <li class="md-nav__item">
265 <a href="../../php/pages/" class="md-nav__link">
266 Pages
267 </a>
268 </li>
269
270
271
272
273
274
275
276
277
278 <li class="md-nav__item">
279 <a href="../../php/database-objects/" class="md-nav__link">
280 Database Objects
281 </a>
282 </li>
283
284
285
286
287
288
289
290
291
292 <li class="md-nav__item">
293 <a href="../../php/database-access/" class="md-nav__link">
294 Database Access
295 </a>
296 </li>
297
298
299
300
301
302
303
304
305
306 <li class="md-nav__item">
307 <a href="../../php/exceptions/" class="md-nav__link">
308 Exceptions
309 </a>
310 </li>
311
312
313
314
315
316
317
318
319
320
321 <li class="md-nav__item md-nav__item--nested">
322
323
324
325
326 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_5" >
327
328
329
330 <label class="md-nav__link" for="__nav_2_5" id="__nav_2_5_label" tabindex="0">
331 API
332 <span class="md-nav__icon md-icon"></span>
333 </label>
334
335 <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_5_label" aria-expanded="false">
336 <label class="md-nav__title" for="__nav_2_5">
337 <span class="md-nav__icon md-icon"></span>
338 API
339 </label>
340 <ul class="md-nav__list" data-md-scrollfix>
341
342
343
344
345
346
347
348 <li class="md-nav__item md-nav__item--nested">
349
350
351
352
353 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_5_1" >
354
355
356
357 <label class="md-nav__link" for="__nav_2_5_1" id="__nav_2_5_1_label" tabindex="0">
358 Caches
359 <span class="md-nav__icon md-icon"></span>
360 </label>
361
362 <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_5_1_label" aria-expanded="false">
363 <label class="md-nav__title" for="__nav_2_5_1">
364 <span class="md-nav__icon md-icon"></span>
365 Caches
366 </label>
367 <ul class="md-nav__list" data-md-scrollfix>
368
369
370
371
372
373
374 <li class="md-nav__item">
375 <a href="../../php/api/caches/" class="md-nav__link">
376 Overview
377 </a>
378 </li>
379
380
381
382
383
384
385
386
387
388 <li class="md-nav__item">
389 <a href="../../php/api/caches_persistent-caches/" class="md-nav__link">
390 Persistent Caches
391 </a>
392 </li>
393
394
395
396
397
398
399
400
401
402 <li class="md-nav__item">
403 <a href="../../php/api/caches_runtime-caches/" class="md-nav__link">
404 Runtime Caches
405 </a>
406 </li>
407
408
409
410
411 </ul>
412 </nav>
413 </li>
414
415
416
417
418
419
420
421
422
423 <li class="md-nav__item">
424 <a href="../../php/api/comments/" class="md-nav__link">
425 Comments
426 </a>
427 </li>
428
429
430
431
432
433
434
435
436
437 <li class="md-nav__item">
438 <a href="../../php/api/cronjobs/" class="md-nav__link">
439 Cronjobs
440 </a>
441 </li>
442
443
444
445
446
447
448
449
450
451 <li class="md-nav__item">
452 <a href="../../php/api/events/" class="md-nav__link">
453 Events
454 </a>
455 </li>
456
457
458
459
460
461
462
463
464
465
466 <li class="md-nav__item md-nav__item--nested">
467
468
469
470
471 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_5_5" >
472
473
474
475 <label class="md-nav__link" for="__nav_2_5_5" id="__nav_2_5_5_label" tabindex="0">
476 Form Builder
477 <span class="md-nav__icon md-icon"></span>
478 </label>
479
480 <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_5_5_label" aria-expanded="false">
481 <label class="md-nav__title" for="__nav_2_5_5">
482 <span class="md-nav__icon md-icon"></span>
483 Form Builder
484 </label>
485 <ul class="md-nav__list" data-md-scrollfix>
486
487
488
489
490
491
492 <li class="md-nav__item">
493 <a href="../../php/api/form_builder/overview/" class="md-nav__link">
494 Overview
495 </a>
496 </li>
497
498
499
500
501
502
503
504
505
506 <li class="md-nav__item">
507 <a href="../../php/api/form_builder/structure/" class="md-nav__link">
508 Structure
509 </a>
510 </li>
511
512
513
514
515
516
517
518
519
520 <li class="md-nav__item">
521 <a href="../../php/api/form_builder/form_fields/" class="md-nav__link">
522 Fields
523 </a>
524 </li>
525
526
527
528
529
530
531
532
533
534 <li class="md-nav__item">
535 <a href="../../php/api/form_builder/validation_data/" class="md-nav__link">
536 Validation and Data
537 </a>
538 </li>
539
540
541
542
543
544
545
546
547
548 <li class="md-nav__item">
549 <a href="../../php/api/form_builder/dependencies/" class="md-nav__link">
550 Dependencies
551 </a>
552 </li>
553
554
555
556
557 </ul>
558 </nav>
559 </li>
560
561
562
563
564
565
566
567
568
569 <li class="md-nav__item">
570 <a href="../../php/api/package_installation_plugins/" class="md-nav__link">
571 Package Installation Plugins
572 </a>
573 </li>
574
575
576
577
578
579
580
581
582
583 <li class="md-nav__item">
584 <a href="../../php/api/user_activity_points/" class="md-nav__link">
585 User Activity Points
586 </a>
587 </li>
588
589
590
591
592
593
594
595
596
597 <li class="md-nav__item">
598 <a href="../../php/api/user_notifications/" class="md-nav__link">
599 User Notifications
600 </a>
601 </li>
602
603
604
605
606
607
608
609
610
611 <li class="md-nav__item">
612 <a href="../../php/api/sitemaps/" class="md-nav__link">
613 Sitemaps
614 </a>
615 </li>
616
617
618
619
620 </ul>
621 </nav>
622 </li>
623
624
625
626
627
628
629
630
631
632 <li class="md-nav__item">
633 <a href="../../php/code-style/" class="md-nav__link">
634 Code Style
635 </a>
636 </li>
637
638
639
640
641
642
643
644
645
646 <li class="md-nav__item">
647 <a href="../../php/apps/" class="md-nav__link">
648 Apps
649 </a>
650 </li>
651
652
653
654
655
656
657
658
659
660 <li class="md-nav__item">
661 <a href="../../php/gdpr/" class="md-nav__link">
662 GDPR
663 </a>
664 </li>
665
666
667
668
669 </ul>
670 </nav>
671 </li>
672
673
674
675
676
677
678
679
680
681
682
683 <li class="md-nav__item md-nav__item--nested">
684
685
686
687
688 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" >
689
690
691
692 <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
693 Languages, Templates & CSS
694 <span class="md-nav__icon md-icon"></span>
695 </label>
696
697 <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
698 <label class="md-nav__title" for="__nav_3">
699 <span class="md-nav__icon md-icon"></span>
700 Languages, Templates & CSS
701 </label>
702 <ul class="md-nav__list" data-md-scrollfix>
703
704
705
706
707
708
709 <li class="md-nav__item">
710 <a href="../../view/languages/" class="md-nav__link">
711 Languages
712 </a>
713 </li>
714
715
716
717
718
719
720
721
722
723 <li class="md-nav__item">
724 <a href="../../view/templates/" class="md-nav__link">
725 Templates
726 </a>
727 </li>
728
729
730
731
732
733
734
735
736
737 <li class="md-nav__item">
738 <a href="../../view/template-plugins/" class="md-nav__link">
739 Template Plugins
740 </a>
741 </li>
742
743
744
745
746
747
748
749
750
751 <li class="md-nav__item">
752 <a href="../../view/css/" class="md-nav__link">
753 CSS
754 </a>
755 </li>
756
757
758
759
760 </ul>
761 </nav>
762 </li>
763
764
765
766
767
768
769
770
771
772
773
774
775
776 <li class="md-nav__item md-nav__item--active md-nav__item--nested">
777
778
779
780
781 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" checked>
782
783
784
785 <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
786 TypeScript and JavaScript API
787 <span class="md-nav__icon md-icon"></span>
788 </label>
789
790 <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
791 <label class="md-nav__title" for="__nav_4">
792 <span class="md-nav__icon md-icon"></span>
793 TypeScript and JavaScript API
794 </label>
795 <ul class="md-nav__list" data-md-scrollfix>
796
797
798
799
800
801
802 <li class="md-nav__item">
803 <a href="../general-usage/" class="md-nav__link">
804 General Usage
805 </a>
806 </li>
807
808
809
810
811
812
813
814
815
816 <li class="md-nav__item">
817 <a href="../typescript/" class="md-nav__link">
818 TypeScript
819 </a>
820 </li>
821
822
823
824
825
826
827
828
829
830
831 <li class="md-nav__item md-nav__item--nested">
832
833
834
835
836 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_3" >
837
838
839
840 <label class="md-nav__link" for="__nav_4_3" id="__nav_4_3_label" tabindex="0">
841 Components
842 <span class="md-nav__icon md-icon"></span>
843 </label>
844
845 <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_3_label" aria-expanded="false">
846 <label class="md-nav__title" for="__nav_4_3">
847 <span class="md-nav__icon md-icon"></span>
848 Components
849 </label>
850 <ul class="md-nav__list" data-md-scrollfix>
851
852
853
854
855
856
857 <li class="md-nav__item">
858 <a href="../components_confirmation/" class="md-nav__link">
859 Confirmation
860 </a>
861 </li>
862
863
864
865
866
867
868
869
870
871 <li class="md-nav__item">
872 <a href="../components_dialog/" class="md-nav__link">
873 Dialog
874 </a>
875 </li>
876
877
878
879
880
881
882
883
884
885 <li class="md-nav__item">
886 <a href="../components_google_maps/" class="md-nav__link">
887 Google Maps
888 </a>
889 </li>
890
891
892
893
894
895
896
897
898
899 <li class="md-nav__item">
900 <a href="../components_pagination/" class="md-nav__link">
901 Pagination
902 </a>
903 </li>
904
905
906
907
908 </ul>
909 </nav>
910 </li>
911
912
913
914
915
916
917
918
919
920
921
922
923 <li class="md-nav__item md-nav__item--active md-nav__item--nested">
924
925
926
927
928 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_4" checked>
929
930
931
932 <label class="md-nav__link" for="__nav_4_4" id="__nav_4_4_label" tabindex="0">
933 New API
934 <span class="md-nav__icon md-icon"></span>
935 </label>
936
937 <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_4_label" aria-expanded="true">
938 <label class="md-nav__title" for="__nav_4_4">
939 <span class="md-nav__icon md-icon"></span>
940 New API
941 </label>
942 <ul class="md-nav__list" data-md-scrollfix>
943
944
945
946
947
948
949 <li class="md-nav__item">
950 <a href="../new-api_writing-a-module/" class="md-nav__link">
951 Writing a module
952 </a>
953 </li>
954
955
956
957
958
959
960
961
962
963 <li class="md-nav__item">
964 <a href="../new-api_core/" class="md-nav__link">
965 Core Functions
966 </a>
967 </li>
968
969
970
971
972
973
974
975
976
977 <li class="md-nav__item">
978 <a href="../new-api_dom/" class="md-nav__link">
979 DOM
980 </a>
981 </li>
982
983
984
985
986
987
988
989
990
991 <li class="md-nav__item">
992 <a href="../new-api_events/" class="md-nav__link">
993 Event Handling
994 </a>
995 </li>
996
997
998
999
1000
1001
1002
1003
1004
1005 <li class="md-nav__item">
1006 <a href="../new-api_ajax/" class="md-nav__link">
1007 Ajax
1008 </a>
1009 </li>
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021 <li class="md-nav__item md-nav__item--active">
1022
1023 <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
1024
1025
1026
1027
1028
1029 <label class="md-nav__link md-nav__link--active" for="__toc">
1030 Dialogs
1031 <span class="md-nav__icon md-icon"></span>
1032 </label>
1033
1034 <a href="./" class="md-nav__link md-nav__link--active">
1035 Dialogs
1036 </a>
1037
1038
1039
1040 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
1041
1042
1043
1044
1045
1046
1047 <label class="md-nav__title" for="__toc">
1048 <span class="md-nav__icon md-icon"></span>
1049 Table of contents
1050 </label>
1051 <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
1052
1053 <li class="md-nav__item">
1054 <a href="#introduction" class="md-nav__link">
1055 Introduction
1056 </a>
1057
1058 </li>
1059
1060 <li class="md-nav__item">
1061 <a href="#_dialogsetup" class="md-nav__link">
1062 _dialogSetup()
1063 </a>
1064
1065 <nav class="md-nav" aria-label="_dialogSetup()">
1066 <ul class="md-nav__list">
1067
1068 <li class="md-nav__item">
1069 <a href="#id-string" class="md-nav__link">
1070 id: string
1071 </a>
1072
1073 </li>
1074
1075 <li class="md-nav__item">
1076 <a href="#source-any" class="md-nav__link">
1077 source: any
1078 </a>
1079
1080 </li>
1081
1082 <li class="md-nav__item">
1083 <a href="#options-object" class="md-nav__link">
1084 options: Object
1085 </a>
1086
1087 <nav class="md-nav" aria-label="options: Object">
1088 <ul class="md-nav__list">
1089
1090 <li class="md-nav__item">
1091 <a href="#optionsbackdropcloseonclick-boolean" class="md-nav__link">
1092 options.backdropCloseOnClick: boolean
1093 </a>
1094
1095 </li>
1096
1097 <li class="md-nav__item">
1098 <a href="#optionsclosable-boolean" class="md-nav__link">
1099 options.closable: boolean
1100 </a>
1101
1102 </li>
1103
1104 <li class="md-nav__item">
1105 <a href="#optionsclosebuttonlabel-string" class="md-nav__link">
1106 options.closeButtonLabel: string
1107 </a>
1108
1109 </li>
1110
1111 <li class="md-nav__item">
1112 <a href="#optionscloseconfirmmessage-string" class="md-nav__link">
1113 options.closeConfirmMessage: string
1114 </a>
1115
1116 </li>
1117
1118 <li class="md-nav__item">
1119 <a href="#optionstitle-string" class="md-nav__link">
1120 options.title: string
1121 </a>
1122
1123 </li>
1124
1125 <li class="md-nav__item">
1126 <a href="#optionsonbeforeclose-id-string-void" class="md-nav__link">
1127 options.onBeforeClose: (id: string) =&gt; void
1128 </a>
1129
1130 </li>
1131
1132 <li class="md-nav__item">
1133 <a href="#optionsonclose-id-string-void" class="md-nav__link">
1134 options.onClose: (id: string) =&gt; void
1135 </a>
1136
1137 </li>
1138
1139 <li class="md-nav__item">
1140 <a href="#optionsonshow-content-element-void" class="md-nav__link">
1141 options.onShow: (content: Element) =&gt; void
1142 </a>
1143
1144 </li>
1145
1146 </ul>
1147 </nav>
1148
1149 </li>
1150
1151 </ul>
1152 </nav>
1153
1154 </li>
1155
1156 <li class="md-nav__item">
1157 <a href="#settitleid-string-object-title-string" class="md-nav__link">
1158 setTitle(id: string | Object, title: string)
1159 </a>
1160
1161 </li>
1162
1163 <li class="md-nav__item">
1164 <a href="#setcallbackid-string-object-key-string-value-data-any-void-null" class="md-nav__link">
1165 setCallback(id: string | Object, key: string, value: (data: any) =&gt; void | null)
1166 </a>
1167
1168 </li>
1169
1170 <li class="md-nav__item">
1171 <a href="#rebuildid-string-object" class="md-nav__link">
1172 rebuild(id: string | Object)
1173 </a>
1174
1175 </li>
1176
1177 <li class="md-nav__item">
1178 <a href="#closeid-string-object" class="md-nav__link">
1179 close(id: string | Object)
1180 </a>
1181
1182 </li>
1183
1184 <li class="md-nav__item">
1185 <a href="#getdialogid-string-object-object" class="md-nav__link">
1186 getDialog(id: string | Object): Object
1187 </a>
1188
1189 </li>
1190
1191 <li class="md-nav__item">
1192 <a href="#isopenid-string-object-boolean" class="md-nav__link">
1193 isOpen(id: string | Object): boolean
1194 </a>
1195
1196 </li>
1197
1198 </ul>
1199
1200 </nav>
1201
1202 </li>
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212 <li class="md-nav__item">
1213 <a href="../new-api_browser/" class="md-nav__link">
1214 Browser and Screen Sizes
1215 </a>
1216 </li>
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226 <li class="md-nav__item">
1227 <a href="../new-api_ui/" class="md-nav__link">
1228 User Interface
1229 </a>
1230 </li>
1231
1232
1233
1234
1235 </ul>
1236 </nav>
1237 </li>
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247 <li class="md-nav__item">
1248 <a href="../legacy-api/" class="md-nav__link">
1249 Legacy API
1250 </a>
1251 </li>
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261 <li class="md-nav__item">
1262 <a href="../code-snippets/" class="md-nav__link">
1263 Code Snippets
1264 </a>
1265 </li>
1266
1267
1268
1269
1270 </ul>
1271 </nav>
1272 </li>
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284 <li class="md-nav__item md-nav__item--nested">
1285
1286
1287
1288
1289 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" >
1290
1291
1292
1293 <label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
1294 Package Components
1295 <span class="md-nav__icon md-icon"></span>
1296 </label>
1297
1298 <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
1299 <label class="md-nav__title" for="__nav_5">
1300 <span class="md-nav__icon md-icon"></span>
1301 Package Components
1302 </label>
1303 <ul class="md-nav__list" data-md-scrollfix>
1304
1305
1306
1307
1308
1309
1310 <li class="md-nav__item">
1311 <a href="../../package/package-xml/" class="md-nav__link">
1312 package.xml
1313 </a>
1314 </li>
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325 <li class="md-nav__item md-nav__item--nested">
1326
1327
1328
1329
1330 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5_2" >
1331
1332
1333
1334 <label class="md-nav__link" for="__nav_5_2" id="__nav_5_2_label" tabindex="0">
1335 PIPs
1336 <span class="md-nav__icon md-icon"></span>
1337 </label>
1338
1339 <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_2_label" aria-expanded="false">
1340 <label class="md-nav__title" for="__nav_5_2">
1341 <span class="md-nav__icon md-icon"></span>
1342 PIPs
1343 </label>
1344 <ul class="md-nav__list" data-md-scrollfix>
1345
1346
1347
1348
1349
1350
1351 <li class="md-nav__item">
1352 <a href="../../package/pip/" class="md-nav__link">
1353 Overview
1354 </a>
1355 </li>
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365 <li class="md-nav__item">
1366 <a href="../../package/pip/acl-option/" class="md-nav__link">
1367 aclOption
1368 </a>
1369 </li>
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379 <li class="md-nav__item">
1380 <a href="../../package/pip/acp-menu/" class="md-nav__link">
1381 acpMenu
1382 </a>
1383 </li>
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393 <li class="md-nav__item">
1394 <a href="../../package/pip/acp-search-provider/" class="md-nav__link">
1395 acpSearchProvider
1396 </a>
1397 </li>
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407 <li class="md-nav__item">
1408 <a href="../../package/pip/acp-template/" class="md-nav__link">
1409 acpTemplate
1410 </a>
1411 </li>
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421 <li class="md-nav__item">
1422 <a href="../../package/pip/acp-template-delete/" class="md-nav__link">
1423 acpTemplateDelete
1424 </a>
1425 </li>
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435 <li class="md-nav__item">
1436 <a href="../../package/pip/bbcode/" class="md-nav__link">
1437 bbcode
1438 </a>
1439 </li>
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449 <li class="md-nav__item">
1450 <a href="../../package/pip/box/" class="md-nav__link">
1451 box
1452 </a>
1453 </li>
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463 <li class="md-nav__item">
1464 <a href="../../package/pip/clipboard-action/" class="md-nav__link">
1465 clipboardAction
1466 </a>
1467 </li>
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477 <li class="md-nav__item">
1478 <a href="../../package/pip/core-object/" class="md-nav__link">
1479 coreObject
1480 </a>
1481 </li>
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491 <li class="md-nav__item">
1492 <a href="../../package/pip/cronjob/" class="md-nav__link">
1493 cronjob
1494 </a>
1495 </li>
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505 <li class="md-nav__item">
1506 <a href="../../package/pip/database/" class="md-nav__link">
1507 database
1508 </a>
1509 </li>
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519 <li class="md-nav__item">
1520 <a href="../../package/pip/event-listener/" class="md-nav__link">
1521 eventListener
1522 </a>
1523 </li>
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533 <li class="md-nav__item">
1534 <a href="../../package/pip/file/" class="md-nav__link">
1535 file
1536 </a>
1537 </li>
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547 <li class="md-nav__item">
1548 <a href="../../package/pip/file-delete/" class="md-nav__link">
1549 fileDelete
1550 </a>
1551 </li>
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561 <li class="md-nav__item">
1562 <a href="../../package/pip/language/" class="md-nav__link">
1563 language
1564 </a>
1565 </li>
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575 <li class="md-nav__item">
1576 <a href="../../package/pip/media-provider/" class="md-nav__link">
1577 mediaProvider
1578 </a>
1579 </li>
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589 <li class="md-nav__item">
1590 <a href="../../package/pip/menu/" class="md-nav__link">
1591 menu
1592 </a>
1593 </li>
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603 <li class="md-nav__item">
1604 <a href="../../package/pip/menu-item/" class="md-nav__link">
1605 menuItem
1606 </a>
1607 </li>
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617 <li class="md-nav__item">
1618 <a href="../../package/pip/object-type/" class="md-nav__link">
1619 objectType
1620 </a>
1621 </li>
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631 <li class="md-nav__item">
1632 <a href="../../package/pip/object-type-definition/" class="md-nav__link">
1633 objectTypeDefinition
1634 </a>
1635 </li>
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645 <li class="md-nav__item">
1646 <a href="../../package/pip/option/" class="md-nav__link">
1647 option
1648 </a>
1649 </li>
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659 <li class="md-nav__item">
1660 <a href="../../package/pip/page/" class="md-nav__link">
1661 page
1662 </a>
1663 </li>
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673 <li class="md-nav__item">
1674 <a href="../../package/pip/pip/" class="md-nav__link">
1675 pip
1676 </a>
1677 </li>
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687 <li class="md-nav__item">
1688 <a href="../../package/pip/script/" class="md-nav__link">
1689 script
1690 </a>
1691 </li>
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701 <li class="md-nav__item">
1702 <a href="../../package/pip/smiley/" class="md-nav__link">
1703 smiley
1704 </a>
1705 </li>
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715 <li class="md-nav__item">
1716 <a href="../../package/pip/sql/" class="md-nav__link">
1717 sql
1718 </a>
1719 </li>
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729 <li class="md-nav__item">
1730 <a href="../../package/pip/style/" class="md-nav__link">
1731 style
1732 </a>
1733 </li>
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743 <li class="md-nav__item">
1744 <a href="../../package/pip/template/" class="md-nav__link">
1745 template
1746 </a>
1747 </li>
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757 <li class="md-nav__item">
1758 <a href="../../package/pip/template-delete/" class="md-nav__link">
1759 templateDelete
1760 </a>
1761 </li>
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771 <li class="md-nav__item">
1772 <a href="../../package/pip/template-listener/" class="md-nav__link">
1773 templateListener
1774 </a>
1775 </li>
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785 <li class="md-nav__item">
1786 <a href="../../package/pip/user-group-option/" class="md-nav__link">
1787 userGroupOption
1788 </a>
1789 </li>
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799 <li class="md-nav__item">
1800 <a href="../../package/pip/user-menu/" class="md-nav__link">
1801 userMenu
1802 </a>
1803 </li>
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813 <li class="md-nav__item">
1814 <a href="../../package/pip/user-notification-event/" class="md-nav__link">
1815 userNotificationEvent
1816 </a>
1817 </li>
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827 <li class="md-nav__item">
1828 <a href="../../package/pip/user-option/" class="md-nav__link">
1829 userOption
1830 </a>
1831 </li>
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841 <li class="md-nav__item">
1842 <a href="../../package/pip/user-profile-menu/" class="md-nav__link">
1843 userProfileMenu
1844 </a>
1845 </li>
1846
1847
1848
1849
1850 </ul>
1851 </nav>
1852 </li>
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862 <li class="md-nav__item">
1863 <a href="../../package/database-php-api/" class="md-nav__link">
1864 Database PHP API
1865 </a>
1866 </li>
1867
1868
1869
1870
1871 </ul>
1872 </nav>
1873 </li>
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885 <li class="md-nav__item md-nav__item--nested">
1886
1887
1888
1889
1890 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6" >
1891
1892
1893
1894 <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
1895 Migration
1896 <span class="md-nav__icon md-icon"></span>
1897 </label>
1898
1899 <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
1900 <label class="md-nav__title" for="__nav_6">
1901 <span class="md-nav__icon md-icon"></span>
1902 Migration
1903 </label>
1904 <ul class="md-nav__list" data-md-scrollfix>
1905
1906
1907
1908
1909
1910
1911
1912 <li class="md-nav__item md-nav__item--nested">
1913
1914
1915
1916
1917 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_1" >
1918
1919
1920
1921 <label class="md-nav__link" for="__nav_6_1" id="__nav_6_1_label" tabindex="0">
1922 From WoltLab Suite 5.5
1923 <span class="md-nav__icon md-icon"></span>
1924 </label>
1925
1926 <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_1_label" aria-expanded="false">
1927 <label class="md-nav__title" for="__nav_6_1">
1928 <span class="md-nav__icon md-icon"></span>
1929 From WoltLab Suite 5.5
1930 </label>
1931 <ul class="md-nav__list" data-md-scrollfix>
1932
1933
1934
1935
1936
1937
1938 <li class="md-nav__item">
1939 <a href="../../migration/wsc55/php/" class="md-nav__link">
1940 PHP API
1941 </a>
1942 </li>
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952 <li class="md-nav__item">
1953 <a href="../../migration/wsc55/javascript/" class="md-nav__link">
1954 TypeScript and JavaScript
1955 </a>
1956 </li>
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966 <li class="md-nav__item">
1967 <a href="../../migration/wsc55/templates/" class="md-nav__link">
1968 Templates
1969 </a>
1970 </li>
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980 <li class="md-nav__item">
1981 <a href="../../migration/wsc55/icons/" class="md-nav__link">
1982 Icons
1983 </a>
1984 </li>
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994 <li class="md-nav__item">
1995 <a href="../../migration/wsc55/dialogs/" class="md-nav__link">
1996 Dialogs
1997 </a>
1998 </li>
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008 <li class="md-nav__item">
2009 <a href="../../migration/wsc55/libraries/" class="md-nav__link">
2010 Third Party Libraries
2011 </a>
2012 </li>
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022 <li class="md-nav__item">
2023 <a href="../../migration/wsc55/deprecations_removals/" class="md-nav__link">
2024 Deprecations and Removals
2025 </a>
2026 </li>
2027
2028
2029
2030
2031 </ul>
2032 </nav>
2033 </li>
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044 <li class="md-nav__item md-nav__item--nested">
2045
2046
2047
2048
2049 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_2" >
2050
2051
2052
2053 <label class="md-nav__link" for="__nav_6_2" id="__nav_6_2_label" tabindex="0">
2054 From WoltLab Suite 5.4
2055 <span class="md-nav__icon md-icon"></span>
2056 </label>
2057
2058 <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_2_label" aria-expanded="false">
2059 <label class="md-nav__title" for="__nav_6_2">
2060 <span class="md-nav__icon md-icon"></span>
2061 From WoltLab Suite 5.4
2062 </label>
2063 <ul class="md-nav__list" data-md-scrollfix>
2064
2065
2066
2067
2068
2069
2070 <li class="md-nav__item">
2071 <a href="../../migration/wsc54/php/" class="md-nav__link">
2072 PHP API
2073 </a>
2074 </li>
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084 <li class="md-nav__item">
2085 <a href="../../migration/wsc54/javascript/" class="md-nav__link">
2086 TypeScript and JavaScript
2087 </a>
2088 </li>
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098 <li class="md-nav__item">
2099 <a href="../../migration/wsc54/templates/" class="md-nav__link">
2100 Templates
2101 </a>
2102 </li>
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112 <li class="md-nav__item">
2113 <a href="../../migration/wsc54/libraries/" class="md-nav__link">
2114 Third Party Libraries
2115 </a>
2116 </li>
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126 <li class="md-nav__item">
2127 <a href="../../migration/wsc54/deprecations_removals/" class="md-nav__link">
2128 Deprecations and Removals
2129 </a>
2130 </li>
2131
2132
2133
2134
2135 </ul>
2136 </nav>
2137 </li>
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148 <li class="md-nav__item md-nav__item--nested">
2149
2150
2151
2152
2153 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_3" >
2154
2155
2156
2157 <label class="md-nav__link" for="__nav_6_3" id="__nav_6_3_label" tabindex="0">
2158 From WoltLab Suite 5.3
2159 <span class="md-nav__icon md-icon"></span>
2160 </label>
2161
2162 <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_3_label" aria-expanded="false">
2163 <label class="md-nav__title" for="__nav_6_3">
2164 <span class="md-nav__icon md-icon"></span>
2165 From WoltLab Suite 5.3
2166 </label>
2167 <ul class="md-nav__list" data-md-scrollfix>
2168
2169
2170
2171
2172
2173
2174 <li class="md-nav__item">
2175 <a href="../../migration/wsc53/php/" class="md-nav__link">
2176 PHP API
2177 </a>
2178 </li>
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188 <li class="md-nav__item">
2189 <a href="../../migration/wsc53/session/" class="md-nav__link">
2190 Session Handling and Authentication
2191 </a>
2192 </li>
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202 <li class="md-nav__item">
2203 <a href="../../migration/wsc53/javascript/" class="md-nav__link">
2204 TypeScript and JavaScript
2205 </a>
2206 </li>
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216 <li class="md-nav__item">
2217 <a href="../../migration/wsc53/templates/" class="md-nav__link">
2218 Templates
2219 </a>
2220 </li>
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230 <li class="md-nav__item">
2231 <a href="../../migration/wsc53/libraries/" class="md-nav__link">
2232 Third Party Libraries
2233 </a>
2234 </li>
2235
2236
2237
2238
2239 </ul>
2240 </nav>
2241 </li>
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252 <li class="md-nav__item md-nav__item--nested">
2253
2254
2255
2256
2257 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_4" >
2258
2259
2260
2261 <label class="md-nav__link" for="__nav_6_4" id="__nav_6_4_label" tabindex="0">
2262 From WoltLab Suite 5.2
2263 <span class="md-nav__icon md-icon"></span>
2264 </label>
2265
2266 <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_4_label" aria-expanded="false">
2267 <label class="md-nav__title" for="__nav_6_4">
2268 <span class="md-nav__icon md-icon"></span>
2269 From WoltLab Suite 5.2
2270 </label>
2271 <ul class="md-nav__list" data-md-scrollfix>
2272
2273
2274
2275
2276
2277
2278 <li class="md-nav__item">
2279 <a href="../../migration/wsc52/php/" class="md-nav__link">
2280 PHP API
2281 </a>
2282 </li>
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292 <li class="md-nav__item">
2293 <a href="../../migration/wsc52/templates/" class="md-nav__link">
2294 Templates and Languages
2295 </a>
2296 </li>
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306 <li class="md-nav__item">
2307 <a href="../../migration/wsc52/libraries/" class="md-nav__link">
2308 Third Party Libraries
2309 </a>
2310 </li>
2311
2312
2313
2314
2315 </ul>
2316 </nav>
2317 </li>
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328 <li class="md-nav__item md-nav__item--nested">
2329
2330
2331
2332
2333 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_5" >
2334
2335
2336
2337 <label class="md-nav__link" for="__nav_6_5" id="__nav_6_5_label" tabindex="0">
2338 From WoltLab Suite 3.1
2339 <span class="md-nav__icon md-icon"></span>
2340 </label>
2341
2342 <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_5_label" aria-expanded="false">
2343 <label class="md-nav__title" for="__nav_6_5">
2344 <span class="md-nav__icon md-icon"></span>
2345 From WoltLab Suite 3.1
2346 </label>
2347 <ul class="md-nav__list" data-md-scrollfix>
2348
2349
2350
2351
2352
2353
2354 <li class="md-nav__item">
2355 <a href="../../migration/wsc31/php/" class="md-nav__link">
2356 PHP API
2357 </a>
2358 </li>
2359
2360
2361
2362
2363 </ul>
2364 </nav>
2365 </li>
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376 <li class="md-nav__item md-nav__item--nested">
2377
2378
2379
2380
2381 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_6" >
2382
2383
2384
2385 <label class="md-nav__link" for="__nav_6_6" id="__nav_6_6_label" tabindex="0">
2386 From WoltLab Suite 3.0
2387 <span class="md-nav__icon md-icon"></span>
2388 </label>
2389
2390 <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_6_label" aria-expanded="false">
2391 <label class="md-nav__title" for="__nav_6_6">
2392 <span class="md-nav__icon md-icon"></span>
2393 From WoltLab Suite 3.0
2394 </label>
2395 <ul class="md-nav__list" data-md-scrollfix>
2396
2397
2398
2399
2400
2401
2402 <li class="md-nav__item">
2403 <a href="../../migration/wsc30/php/" class="md-nav__link">
2404 PHP API
2405 </a>
2406 </li>
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416 <li class="md-nav__item">
2417 <a href="../../migration/wsc30/javascript/" class="md-nav__link">
2418 JavaScript API
2419 </a>
2420 </li>
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430 <li class="md-nav__item">
2431 <a href="../../migration/wsc30/templates/" class="md-nav__link">
2432 Templates
2433 </a>
2434 </li>
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444 <li class="md-nav__item">
2445 <a href="../../migration/wsc30/css/" class="md-nav__link">
2446 CSS
2447 </a>
2448 </li>
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458 <li class="md-nav__item">
2459 <a href="../../migration/wsc30/package/" class="md-nav__link">
2460 Package Components
2461 </a>
2462 </li>
2463
2464
2465
2466
2467 </ul>
2468 </nav>
2469 </li>
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480 <li class="md-nav__item md-nav__item--nested">
2481
2482
2483
2484
2485 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_7" >
2486
2487
2488
2489 <label class="md-nav__link" for="__nav_6_7" id="__nav_6_7_label" tabindex="0">
2490 From WCF 2.1
2491 <span class="md-nav__icon md-icon"></span>
2492 </label>
2493
2494 <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_7_label" aria-expanded="false">
2495 <label class="md-nav__title" for="__nav_6_7">
2496 <span class="md-nav__icon md-icon"></span>
2497 From WCF 2.1
2498 </label>
2499 <ul class="md-nav__list" data-md-scrollfix>
2500
2501
2502
2503
2504
2505
2506 <li class="md-nav__item">
2507 <a href="../../migration/wcf21/php/" class="md-nav__link">
2508 PHP API
2509 </a>
2510 </li>
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520 <li class="md-nav__item">
2521 <a href="../../migration/wcf21/templates/" class="md-nav__link">
2522 Templates
2523 </a>
2524 </li>
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534 <li class="md-nav__item">
2535 <a href="../../migration/wcf21/css/" class="md-nav__link">
2536 CSS
2537 </a>
2538 </li>
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548 <li class="md-nav__item">
2549 <a href="../../migration/wcf21/package/" class="md-nav__link">
2550 Package Components
2551 </a>
2552 </li>
2553
2554
2555
2556
2557 </ul>
2558 </nav>
2559 </li>
2560
2561
2562
2563
2564 </ul>
2565 </nav>
2566 </li>
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578 <li class="md-nav__item md-nav__item--nested">
2579
2580
2581
2582
2583 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7" >
2584
2585
2586
2587 <label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="0">
2588 Tutorials
2589 <span class="md-nav__icon md-icon"></span>
2590 </label>
2591
2592 <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
2593 <label class="md-nav__title" for="__nav_7">
2594 <span class="md-nav__icon md-icon"></span>
2595 Tutorials
2596 </label>
2597 <ul class="md-nav__list" data-md-scrollfix>
2598
2599
2600
2601
2602
2603
2604
2605 <li class="md-nav__item md-nav__item--nested">
2606
2607
2608
2609
2610 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7_1" >
2611
2612
2613
2614 <label class="md-nav__link" for="__nav_7_1" id="__nav_7_1_label" tabindex="0">
2615 Tutorial Series
2616 <span class="md-nav__icon md-icon"></span>
2617 </label>
2618
2619 <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_7_1_label" aria-expanded="false">
2620 <label class="md-nav__title" for="__nav_7_1">
2621 <span class="md-nav__icon md-icon"></span>
2622 Tutorial Series
2623 </label>
2624 <ul class="md-nav__list" data-md-scrollfix>
2625
2626
2627
2628
2629
2630
2631 <li class="md-nav__item">
2632 <a href="../../tutorial/series/overview/" class="md-nav__link">
2633 Overview
2634 </a>
2635 </li>
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645 <li class="md-nav__item">
2646 <a href="../../tutorial/series/part_1/" class="md-nav__link">
2647 Part 1
2648 </a>
2649 </li>
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659 <li class="md-nav__item">
2660 <a href="../../tutorial/series/part_2/" class="md-nav__link">
2661 Part 2
2662 </a>
2663 </li>
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673 <li class="md-nav__item">
2674 <a href="../../tutorial/series/part_3/" class="md-nav__link">
2675 Part 3
2676 </a>
2677 </li>
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687 <li class="md-nav__item">
2688 <a href="../../tutorial/series/part_4/" class="md-nav__link">
2689 Part 4
2690 </a>
2691 </li>
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701 <li class="md-nav__item">
2702 <a href="../../tutorial/series/part_5/" class="md-nav__link">
2703 Part 5
2704 </a>
2705 </li>
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715 <li class="md-nav__item">
2716 <a href="../../tutorial/series/part_6/" class="md-nav__link">
2717 Part 6
2718 </a>
2719 </li>
2720
2721
2722
2723
2724 </ul>
2725 </nav>
2726 </li>
2727
2728
2729
2730
2731 </ul>
2732 </nav>
2733 </li>
2734
2735
2736
2737 </ul>
2738 </nav>
2739 </div>
2740 </div>
2741 </div>
2742
2743
2744
2745 <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
2746 <div class="md-sidebar__scrollwrap">
2747 <div class="md-sidebar__inner">
2748
2749
2750 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
2751
2752
2753
2754
2755
2756
2757 <label class="md-nav__title" for="__toc">
2758 <span class="md-nav__icon md-icon"></span>
2759 Table of contents
2760 </label>
2761 <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
2762
2763 <li class="md-nav__item">
2764 <a href="#introduction" class="md-nav__link">
2765 Introduction
2766 </a>
2767
2768 </li>
2769
2770 <li class="md-nav__item">
2771 <a href="#_dialogsetup" class="md-nav__link">
2772 _dialogSetup()
2773 </a>
2774
2775 <nav class="md-nav" aria-label="_dialogSetup()">
2776 <ul class="md-nav__list">
2777
2778 <li class="md-nav__item">
2779 <a href="#id-string" class="md-nav__link">
2780 id: string
2781 </a>
2782
2783 </li>
2784
2785 <li class="md-nav__item">
2786 <a href="#source-any" class="md-nav__link">
2787 source: any
2788 </a>
2789
2790 </li>
2791
2792 <li class="md-nav__item">
2793 <a href="#options-object" class="md-nav__link">
2794 options: Object
2795 </a>
2796
2797 <nav class="md-nav" aria-label="options: Object">
2798 <ul class="md-nav__list">
2799
2800 <li class="md-nav__item">
2801 <a href="#optionsbackdropcloseonclick-boolean" class="md-nav__link">
2802 options.backdropCloseOnClick: boolean
2803 </a>
2804
2805 </li>
2806
2807 <li class="md-nav__item">
2808 <a href="#optionsclosable-boolean" class="md-nav__link">
2809 options.closable: boolean
2810 </a>
2811
2812 </li>
2813
2814 <li class="md-nav__item">
2815 <a href="#optionsclosebuttonlabel-string" class="md-nav__link">
2816 options.closeButtonLabel: string
2817 </a>
2818
2819 </li>
2820
2821 <li class="md-nav__item">
2822 <a href="#optionscloseconfirmmessage-string" class="md-nav__link">
2823 options.closeConfirmMessage: string
2824 </a>
2825
2826 </li>
2827
2828 <li class="md-nav__item">
2829 <a href="#optionstitle-string" class="md-nav__link">
2830 options.title: string
2831 </a>
2832
2833 </li>
2834
2835 <li class="md-nav__item">
2836 <a href="#optionsonbeforeclose-id-string-void" class="md-nav__link">
2837 options.onBeforeClose: (id: string) =&gt; void
2838 </a>
2839
2840 </li>
2841
2842 <li class="md-nav__item">
2843 <a href="#optionsonclose-id-string-void" class="md-nav__link">
2844 options.onClose: (id: string) =&gt; void
2845 </a>
2846
2847 </li>
2848
2849 <li class="md-nav__item">
2850 <a href="#optionsonshow-content-element-void" class="md-nav__link">
2851 options.onShow: (content: Element) =&gt; void
2852 </a>
2853
2854 </li>
2855
2856 </ul>
2857 </nav>
2858
2859 </li>
2860
2861 </ul>
2862 </nav>
2863
2864 </li>
2865
2866 <li class="md-nav__item">
2867 <a href="#settitleid-string-object-title-string" class="md-nav__link">
2868 setTitle(id: string | Object, title: string)
2869 </a>
2870
2871 </li>
2872
2873 <li class="md-nav__item">
2874 <a href="#setcallbackid-string-object-key-string-value-data-any-void-null" class="md-nav__link">
2875 setCallback(id: string | Object, key: string, value: (data: any) =&gt; void | null)
2876 </a>
2877
2878 </li>
2879
2880 <li class="md-nav__item">
2881 <a href="#rebuildid-string-object" class="md-nav__link">
2882 rebuild(id: string | Object)
2883 </a>
2884
2885 </li>
2886
2887 <li class="md-nav__item">
2888 <a href="#closeid-string-object" class="md-nav__link">
2889 close(id: string | Object)
2890 </a>
2891
2892 </li>
2893
2894 <li class="md-nav__item">
2895 <a href="#getdialogid-string-object-object" class="md-nav__link">
2896 getDialog(id: string | Object): Object
2897 </a>
2898
2899 </li>
2900
2901 <li class="md-nav__item">
2902 <a href="#isopenid-string-object-boolean" class="md-nav__link">
2903 isOpen(id: string | Object): boolean
2904 </a>
2905
2906 </li>
2907
2908 </ul>
2909
2910 </nav>
2911 </div>
2912 </div>
2913 </div>
2914
2915
2916
2917 <div class="md-content" data-md-component="content">
2918 <article class="md-content__inner md-typeset">
2919
2920
2921
2922
2923
2924
2925
2926 <h1 id="dialogs-javascript-api">Dialogs - JavaScript API<a class="headerlink" href="#dialogs-javascript-api" title="Permanent link">#</a></h1>
2927 <div class="admonition info">
2928 <p class="admonition-title">This API has been deprecated in WoltLab Suite 6.0, please refer to the new <a href="../components_dialog/">dialog implementation</a>.</p>
2929 </div>
2930 <h2 id="introduction">Introduction<a class="headerlink" href="#introduction" title="Permanent link">#</a></h2>
2931 <p>Dialogs are full screen overlays that cover the currently visible window area
2932 using a semi-opague backdrop and a prominently placed dialog window in the
2933 foreground. They shift the attention away from the original content towards the
2934 dialog and usually contain additional details and/or dedicated form inputs.</p>
2935 <h2 id="_dialogsetup"><code>_dialogSetup()</code><a class="headerlink" href="#_dialogsetup" title="Permanent link">#</a></h2>
2936 <p>The lazy initialization is performed upon the first invocation from the callee,
2937 using the magic <code>_dialogSetup()</code> method to retrieve the basic configuration for
2938 the dialog construction and any event callbacks.</p>
2939 <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"> 1</span>
2940 <span class="normal"> 2</span>
2941 <span class="normal"> 3</span>
2942 <span class="normal"> 4</span>
2943 <span class="normal"> 5</span>
2944 <span class="normal"> 6</span>
2945 <span class="normal"> 7</span>
2946 <span class="normal"> 8</span>
2947 <span class="normal"> 9</span>
2948 <span class="normal">10</span>
2949 <span class="normal">11</span>
2950 <span class="normal">12</span>
2951 <span class="normal">13</span>
2952 <span class="normal">14</span>
2953 <span class="normal">15</span>
2954 <span class="normal">16</span>
2955 <span class="normal">17</span>
2956 <span class="normal">18</span>
2957 <span class="normal">19</span>
2958 <span class="normal">20</span>
2959 <span class="normal">21</span>
2960 <span class="normal">22</span>
2961 <span class="normal">23</span>
2962 <span class="normal">24</span>
2963 <span class="normal">25</span>
2964 <span class="normal">26</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="c1">// App/Foo.js</span>
2965 <span class="nx">define</span><span class="p">([</span><span class="s2">&quot;Ui/Dialog&quot;</span><span class="p">],</span><span class="w"> </span><span class="kd">function</span><span class="p">(</span><span class="nx">UiDialog</span><span class="p">)</span><span class="w"> </span><span class="p">{</span>
2966 <span class="w"> </span><span class="s2">&quot;use strict&quot;</span><span class="p">;</span>
2967
2968 <span class="w"> </span><span class="kd">function</span><span class="w"> </span><span class="nx">Foo</span><span class="p">()</span><span class="w"> </span><span class="p">{};</span>
2969 <span class="w"> </span><span class="nx">Foo</span><span class="p">.</span><span class="nx">prototype</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">{</span>
2970 <span class="w"> </span><span class="nx">bar</span><span class="o">:</span><span class="w"> </span><span class="kd">function</span><span class="p">()</span><span class="w"> </span><span class="p">{</span>
2971 <span class="w"> </span><span class="c1">// this will open the dialog constructed by _dialogSetup</span>
2972 <span class="w"> </span><span class="nx">UiDialog</span><span class="p">.</span><span class="nx">open</span><span class="p">(</span><span class="k">this</span><span class="p">);</span>
2973 <span class="w"> </span><span class="p">},</span>
2974
2975 <span class="w"> </span><span class="nx">_dialogSetup</span><span class="o">:</span><span class="w"> </span><span class="kd">function</span><span class="p">()</span><span class="w"> </span><span class="p">{</span>
2976 <span class="w"> </span><span class="k">return</span><span class="w"> </span><span class="p">{</span>
2977 <span class="w"> </span><span class="nx">id</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;myDialog&quot;</span><span class="p">,</span>
2978 <span class="w"> </span><span class="nx">source</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;&lt;p&gt;Hello World!&lt;/p&gt;&quot;</span><span class="p">,</span>
2979 <span class="w"> </span><span class="nx">options</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
2980 <span class="w"> </span><span class="nx">onClose</span><span class="o">:</span><span class="w"> </span><span class="kd">function</span><span class="p">()</span><span class="w"> </span><span class="p">{</span>
2981 <span class="w"> </span><span class="c1">// the fancy dialog was closed!</span>
2982 <span class="w"> </span><span class="p">}</span>
2983 <span class="w"> </span><span class="p">}</span>
2984 <span class="w"> </span><span class="p">}</span>
2985 <span class="w"> </span><span class="p">}</span>
2986 <span class="w"> </span><span class="p">};</span>
2987
2988 <span class="w"> </span><span class="k">return</span><span class="w"> </span><span class="nx">Foo</span><span class="p">;</span>
2989 <span class="p">});</span>
2990 </code></pre></div></td></tr></table></div>
2991 <h3 id="id-string"><code>id: string</code><a class="headerlink" href="#id-string" title="Permanent link">#</a></h3>
2992 <p>The <code>id</code> is used to identify a dialog on runtime, but is also part of the first-
2993 time setup when the dialog has not been opened before. If <code>source</code> is <code>undefined</code>,
2994 the module attempts to construct the dialog using an element with the same id.</p>
2995 <h3 id="source-any"><code>source: any</code><a class="headerlink" href="#source-any" title="Permanent link">#</a></h3>
2996 <p>There are six different types of value that <code>source</code> does allow and each of them
2997 changes how the initial dialog is constructed:</p>
2998 <ol>
2999 <li><code>undefined</code><br />
3000 The dialog exists already and the value of <code>id</code> should be used to identify the
3001 element.</li>
3002 <li><code>null</code><br />
3003 The HTML is provided using the second argument of <code>.open()</code>.</li>
3004 <li><code>() =&gt; void</code><br />
3005 If the <code>source</code> is a function, it is executed and is expected to start the
3006 dialog initialization itself.</li>
3007 <li><code>Object</code><br />
3008 Plain objects are interpreted as parameters for an Ajax request, in particular
3009 <code>source.data</code> will be used to issue the request. It is possible to specify the
3010 key <code>source.after</code> as a callback <code>(content: Element, responseData: Object) =&gt; void</code>
3011 that is executed after the dialog was opened.</li>
3012 <li><code>string</code><br />
3013 The string is expected to be plain HTML that should be used to construct the
3014 dialog.</li>
3015 <li><code>DocumentFragment</code><br />
3016 A new container <code>&lt;div&gt;</code> with the provided <code>id</code> is created and the contents of
3017 the <code>DocumentFragment</code> is appended to it. This container is then used for the
3018 dialog.</li>
3019 </ol>
3020 <h3 id="options-object"><code>options: Object</code><a class="headerlink" href="#options-object" title="Permanent link">#</a></h3>
3021 <p>All configuration options and callbacks are handled through this object.</p>
3022 <h4 id="optionsbackdropcloseonclick-boolean"><code>options.backdropCloseOnClick: boolean</code><a class="headerlink" href="#optionsbackdropcloseonclick-boolean" title="Permanent link">#</a></h4>
3023 <p><em>Defaults to <code>true</code>.</em></p>
3024 <p>Clicks on the dialog backdrop will close the top-most dialog. This option will
3025 be force-disabled if the option <code>closeable</code> is set to <code>false</code>.</p>
3026 <h4 id="optionsclosable-boolean"><code>options.closable: boolean</code><a class="headerlink" href="#optionsclosable-boolean" title="Permanent link">#</a></h4>
3027 <p><em>Defaults to <code>true</code>.</em></p>
3028 <p>Enables the close button in the dialog title, when disabled the dialog can be
3029 closed through the <code>.close()</code> API call only.</p>
3030 <h4 id="optionsclosebuttonlabel-string"><code>options.closeButtonLabel: string</code><a class="headerlink" href="#optionsclosebuttonlabel-string" title="Permanent link">#</a></h4>
3031 <p><em>Defaults to <code>Language.get("wcf.global.button.close")</code>.</em></p>
3032 <p>The phrase that is displayed in the tooltip for the close button.</p>
3033 <h4 id="optionscloseconfirmmessage-string"><code>options.closeConfirmMessage: string</code><a class="headerlink" href="#optionscloseconfirmmessage-string" title="Permanent link">#</a></h4>
3034 <p><em>Defaults to <code>""</code>.</em></p>
3035 <p>Shows a <a href="../new-api_ui/">confirmation dialog</a> using the configured message
3036 before closing the dialog. The dialog will not be closed if the dialog is
3037 rejected by the user.</p>
3038 <h4 id="optionstitle-string"><code>options.title: string</code><a class="headerlink" href="#optionstitle-string" title="Permanent link">#</a></h4>
3039 <p><em>Defaults to <code>""</code>.</em></p>
3040 <p>The phrase that is displayed in the dialog title.</p>
3041 <h4 id="optionsonbeforeclose-id-string-void"><code>options.onBeforeClose: (id: string) =&gt; void</code><a class="headerlink" href="#optionsonbeforeclose-id-string-void" title="Permanent link">#</a></h4>
3042 <p><em>Defaults to <code>null</code>.</em></p>
3043 <p>The callback is executed when the user clicks on the close button or, if enabled,
3044 on the backdrop. The callback is responsible to close the dialog by itself, the
3045 default close behavior is automatically prevented.</p>
3046 <h4 id="optionsonclose-id-string-void"><code>options.onClose: (id: string) =&gt; void</code><a class="headerlink" href="#optionsonclose-id-string-void" title="Permanent link">#</a></h4>
3047 <p><em>Defaults to <code>null</code>.</em></p>
3048 <p>The callback is notified once the dialog is about to be closed, but is still
3049 visible at this point. It is not possible to abort the close operation at this
3050 point.</p>
3051 <h4 id="optionsonshow-content-element-void"><code>options.onShow: (content: Element) =&gt; void</code><a class="headerlink" href="#optionsonshow-content-element-void" title="Permanent link">#</a></h4>
3052 <p><em>Defaults to <code>null</code>.</em></p>
3053 <p>Receives the dialog content element as its only argument, allowing the callback
3054 to modify the DOM or to register event listeners before the dialog is presented
3055 to the user. The dialog is already visible at call time, but the dialog has not
3056 been finalized yet.</p>
3057 <h2 id="settitleid-string-object-title-string"><code>setTitle(id: string | Object, title: string)</code><a class="headerlink" href="#settitleid-string-object-title-string" title="Permanent link">#</a></h2>
3058 <p>Sets the title of a dialog.</p>
3059 <h2 id="setcallbackid-string-object-key-string-value-data-any-void-null"><code>setCallback(id: string | Object, key: string, value: (data: any) =&gt; void | null)</code><a class="headerlink" href="#setcallbackid-string-object-key-string-value-data-any-void-null" title="Permanent link">#</a></h2>
3060 <p>Sets a callback function after the dialog initialization, the special value
3061 <code>null</code> will remove a previously set callback. Valid values for <code>key</code> are
3062 <code>onBeforeClose</code>, <code>onClose</code> and <code>onShow</code>.</p>
3063 <h2 id="rebuildid-string-object"><code>rebuild(id: string | Object)</code><a class="headerlink" href="#rebuildid-string-object" title="Permanent link">#</a></h2>
3064 <p>Rebuilds a dialog by performing various calculations on the maximum dialog
3065 height in regards to the overflow handling and adjustments for embedded forms.
3066 This method is automatically invoked whenever a dialog is shown, after invoking
3067 the <code>options.onShow</code> callback.</p>
3068 <h2 id="closeid-string-object"><code>close(id: string | Object)</code><a class="headerlink" href="#closeid-string-object" title="Permanent link">#</a></h2>
3069 <p>Closes an open dialog, this will neither trigger a confirmation dialog, nor does
3070 it invoke the <code>options.onBeforeClose</code> callback. The <code>options.onClose</code> callback
3071 will always be invoked, but it cannot abort the close operation.</p>
3072 <h2 id="getdialogid-string-object-object"><code>getDialog(id: string | Object): Object</code><a class="headerlink" href="#getdialogid-string-object-object" title="Permanent link">#</a></h2>
3073 <div class="admonition warning">
3074 <p class="admonition-title">This method returns an internal data object by reference, any modifications made do have an effect on the dialogs behavior and in particular no validation is performed on the modification. It is strongly recommended to use the <code>.set*()</code> methods only.</p>
3075 </div>
3076 <p>Returns the internal dialog data that is attached to a dialog. The most important
3077 key is <code>.content</code> which holds a reference to the dialog's inner content element.</p>
3078 <h2 id="isopenid-string-object-boolean"><code>isOpen(id: string | Object): boolean</code><a class="headerlink" href="#isopenid-string-object-boolean" title="Permanent link">#</a></h2>
3079 <p>Returns true if the dialog exists and is open.</p>
3080
3081 <hr>
3082 <div class="md-source-file">
3083 <small>
3084
3085 Last update:
3086 2022-10-13
3087
3088 </small>
3089 </div>
3090
3091
3092
3093
3094
3095
3096 </article>
3097 </div>
3098
3099
3100 </div>
3101
3102 </main>
3103
3104 <footer class="md-footer">
3105
3106 <div class="md-footer-meta md-typeset">
3107 <div class="md-footer-meta__inner md-grid">
3108 <div class="md-copyright">
3109
3110 <div class="md-copyright__highlight">
3111 Copyright © 2020 WoltLab GmbH
3112 </div>
3113
3114
3115 Made with
3116 <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
3117 Material for MkDocs
3118 </a>
3119
3120 </div>
3121
3122 <div class="md-copyright">
3123 <a href="https://www.woltlab.com/legal-notice/">Legal Notice</a>
3124 <a href="https://www.woltlab.com/privacy-policy/">Privacy Policy</a>
3125 </div>
3126
3127 </div>
3128 </div>
3129 </footer>
3130
3131 </div>
3132 <div class="md-dialog" data-md-component="dialog">
3133 <div class="md-dialog__inner md-typeset"></div>
3134 </div>
3135
3136 <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tracking"], "search": "../../assets/javascripts/workers/search.208ed371.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"provider": "mike"}}</script>
3137
3138
3139 <script src="../../assets/javascripts/bundle.2a6f1dda.min.js"></script>
3140
3141
3142 </body>
3143 </html>