projects / GitHub / WoltLab / woltlab.github.io.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
Deployed 506b5bb to 5.4 with MkDocs 1.1.2 and mike 0.5.5
[GitHub/WoltLab/woltlab.github.io.git] / 5.4 / javascript / new-api_ui / 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
12 <link rel="shortcut icon" href="../../assets/default.favicon.ico">
fb88dc6e 13 <meta name="generator" content="mkdocs-1.1.2, mkdocs-material-7.0.5">
45ca63d0
TD		 14
15
16
17 <title>User Interface - WoltLab Suite Documentation</title>
18
19
20
fb88dc6e 21 <link rel="stylesheet" href="../../assets/stylesheets/main.77f3fd56.min.css">
45ca63d0
TD		 22
23
24 <link rel="stylesheet" href="../../assets/stylesheets/palette.7fa14f5b.min.css">
25
26
27
28 <meta name="theme-color" content="#009485">
29
30
31
32
33
34
35
36
37 <link rel="stylesheet" href="../../stylesheets/extra.css">
38
39
40
41
42
43 </head>
44
45
46
47
48
49
50
51 <body dir="ltr" data-md-color-scheme="" data-md-color-primary="teal" data-md-color-accent="">
52
53
54
55 <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
56 <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
57 <label class="md-overlay" for="__drawer"></label>
58 <div data-md-component="skip">
59
60
61 <a href="#user-interface-javascript-api" class="md-skip">
62 Skip to content
63 </a>
64
65 </div>
66 <div data-md-component="announce">
67
68 <aside class="md-announce">
69 <div class="md-announce__inner md-grid md-typeset">
70
71 <a href="https://www.woltlab.com">Back to <strong>woltlab.com</strong></a>
72
73 </div>
74 </aside>
75
76 </div>
77
78
79
80<header class="md-header" data-md-component="header">
81 <nav class="md-header__inner md-grid" aria-label="Header">
82 <a href="../.." title="WoltLab Suite Documentation" class="md-header__button md-logo" aria-label="WoltLab Suite Documentation">
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 User Interface
101
102 </span>
103 </div>
104 </div>
105 </div>
106 <div class="md-header__options">
107
108 </div>
109
110 <label class="md-header__button md-icon" for="__search">
111 <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>
112 </label>
113
114<div class="md-search" data-md-component="search" role="dialog">
115 <label class="md-search__overlay" for="__search"></label>
116 <div class="md-search__inner" role="search">
117 <form class="md-search__form" name="search">
118 <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>
119 <label class="md-search__icon md-icon" for="__search">
120 <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>
121 <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
122 </label>
123 <button type="reset" class="md-search__icon md-icon" aria-label="Clear" tabindex="-1">
124 <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41L17.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>
125 </button>
126 </form>
127 <div class="md-search__output">
128 <div class="md-search__scrollwrap" data-md-scrollfix>
129 <div class="md-search-result" data-md-component="search-result">
130 <div class="md-search-result__meta">
131 Initializing search
132 </div>
133 <ol class="md-search-result__list"></ol>
134 </div>
135 </div>
136 </div>
137 </div>
138</div>
139
140
141 </nav>
142</header>
143
144 <div class="md-container" data-md-component="container">
145
146
147
148
149 <main class="md-main" data-md-component="main">
150 <div class="md-main__inner md-grid">
151
152
153
154 <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
155 <div class="md-sidebar__scrollwrap">
156 <div class="md-sidebar__inner">
157
158
159
160
161
162<nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
163 <label class="md-nav__title" for="__drawer">
164 <a href="../.." title="WoltLab Suite Documentation" class="md-nav__button md-logo" aria-label="WoltLab Suite Documentation">
165
166 <img src="../../assets/logo.png" alt="logo">
167
168 </a>
169 WoltLab Suite Documentation
170 </label>
171
172 <ul class="md-nav__list" data-md-scrollfix>
173
174
175
176
177
178
179
180
181 <li class="md-nav__item">
182 <a href="../../getting-started/" class="md-nav__link">
183 Getting Started
184 </a>
185 </li>
186
187
188
189
190
191
192
193
194
195
196
197 <li class="md-nav__item md-nav__item--nested">
198
199
200 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2" type="checkbox" id="__nav_2" >
201
202 <label class="md-nav__link" for="__nav_2">
203 PHP API
204 <span class="md-nav__icon md-icon"></span>
205 </label>
206 <nav class="md-nav" aria-label="PHP API" data-md-level="1">
207 <label class="md-nav__title" for="__nav_2">
208 <span class="md-nav__icon md-icon"></span>
209 PHP API
210 </label>
211 <ul class="md-nav__list" data-md-scrollfix>
212
213
214
215
216
217 <li class="md-nav__item">
218 <a href="../../php/pages/" class="md-nav__link">
219 Pages
220 </a>
221 </li>
222
223
224
225
226
227
228
229 <li class="md-nav__item">
230 <a href="../../php/database-objects/" class="md-nav__link">
231 Database Objects
232 </a>
233 </li>
234
235
236
237
238
239
240
241 <li class="md-nav__item">
242 <a href="../../php/database-access/" class="md-nav__link">
243 Database Access
244 </a>
245 </li>
246
247
248
249
250
251
252
253 <li class="md-nav__item">
254 <a href="../../php/exceptions/" class="md-nav__link">
255 Exceptions
256 </a>
257 </li>
258
259
260
261
262
263
264
265
266 <li class="md-nav__item md-nav__item--nested">
267
268
269 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5" type="checkbox" id="__nav_2_5" >
270
271 <label class="md-nav__link" for="__nav_2_5">
272 API
273 <span class="md-nav__icon md-icon"></span>
274 </label>
275 <nav class="md-nav" aria-label="API" data-md-level="2">
276 <label class="md-nav__title" for="__nav_2_5">
277 <span class="md-nav__icon md-icon"></span>
278 API
279 </label>
280 <ul class="md-nav__list" data-md-scrollfix>
281
282
283
284
285
286 <li class="md-nav__item">
287 <a href="../../php/api/caches/" class="md-nav__link">
288 Caches
289 </a>
290 </li>
291
292
293
294
295
296
297
298 <li class="md-nav__item">
299 <a href="../../php/api/comments/" class="md-nav__link">
300 Comments
301 </a>
302 </li>
303
304
305
306
307
308
309
310 <li class="md-nav__item">
311 <a href="../../php/api/cronjobs/" class="md-nav__link">
312 Cronjobs
313 </a>
314 </li>
315
316
317
318
319
320
321
322 <li class="md-nav__item">
323 <a href="../../php/api/events/" class="md-nav__link">
324 Events
325 </a>
326 </li>
327
328
329
330
331
332
333
334
335 <li class="md-nav__item md-nav__item--nested">
336
337
338 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5_5" type="checkbox" id="__nav_2_5_5" >
339
340 <label class="md-nav__link" for="__nav_2_5_5">
341 Form Builder
342 <span class="md-nav__icon md-icon"></span>
343 </label>
344 <nav class="md-nav" aria-label="Form Builder" data-md-level="3">
345 <label class="md-nav__title" for="__nav_2_5_5">
346 <span class="md-nav__icon md-icon"></span>
347 Form Builder
348 </label>
349 <ul class="md-nav__list" data-md-scrollfix>
350
351
352
353
354
355 <li class="md-nav__item">
356 <a href="../../php/api/form_builder/overview/" class="md-nav__link">
357 Overview
358 </a>
359 </li>
360
361
362
363
364
365
366
367 <li class="md-nav__item">
368 <a href="../../php/api/form_builder/structure/" class="md-nav__link">
369 Structure
370 </a>
371 </li>
372
373
374
375
376
377
378
379 <li class="md-nav__item">
380 <a href="../../php/api/form_builder/form_fields/" class="md-nav__link">
381 Fields
382 </a>
383 </li>
384
385
386
387
388
389
390
391 <li class="md-nav__item">
392 <a href="../../php/api/form_builder/validation_data/" class="md-nav__link">
393 Validation and Data
394 </a>
395 </li>
396
397
398
399
400
401
402
403 <li class="md-nav__item">
404 <a href="../../php/api/form_builder/dependencies/" class="md-nav__link">
405 Dependencies
406 </a>
407 </li>
408
409
410
411 </ul>
412 </nav>
413 </li>
414
415
416
417
418
419
420
421 <li class="md-nav__item">
422 <a href="../../php/api/package_installation_plugins/" class="md-nav__link">
423 Package Installation Plugins
424 </a>
425 </li>
426
427
428
429
430
431
432
433 <li class="md-nav__item">
434 <a href="../../php/api/user_activity_points/" class="md-nav__link">
435 User Activity Points
436 </a>
437 </li>
438
439
440
441
442
443
444
445 <li class="md-nav__item">
446 <a href="../../php/api/user_notifications/" class="md-nav__link">
447 User Notifications
448 </a>
449 </li>
450
451
452
453
454
455
456
457 <li class="md-nav__item">
458 <a href="../../php/api/sitemaps/" class="md-nav__link">
459 Sitemaps
460 </a>
461 </li>
462
463
464
465 </ul>
466 </nav>
467 </li>
468
469
470
471
472
473
474
475 <li class="md-nav__item">
476 <a href="../../php/code-style/" class="md-nav__link">
477 Code Style
478 </a>
479 </li>
480
481
482
483
484
485
486
487 <li class="md-nav__item">
488 <a href="../../php/apps/" class="md-nav__link">
489 Apps
490 </a>
491 </li>
492
493
494
495
496
497
498
499 <li class="md-nav__item">
500 <a href="../../php/gdpr/" class="md-nav__link">
501 GDPR
502 </a>
503 </li>
504
505
506
507 </ul>
508 </nav>
509 </li>
510
511
512
513
514
515
516
517
518
519
520
521 <li class="md-nav__item md-nav__item--nested">
522
523
524 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" type="checkbox" id="__nav_3" >
525
526 <label class="md-nav__link" for="__nav_3">
527 Languages, Templates & CSS
528 <span class="md-nav__icon md-icon"></span>
529 </label>
530 <nav class="md-nav" aria-label="Languages, Templates & CSS" data-md-level="1">
531 <label class="md-nav__title" for="__nav_3">
532 <span class="md-nav__icon md-icon"></span>
533 Languages, Templates & CSS
534 </label>
535 <ul class="md-nav__list" data-md-scrollfix>
536
537
538
539
540
541 <li class="md-nav__item">
542 <a href="../../view/languages/" class="md-nav__link">
543 Languages
544 </a>
545 </li>
546
547
548
549
550
551
552
553 <li class="md-nav__item">
554 <a href="../../view/templates/" class="md-nav__link">
555 Templates
556 </a>
557 </li>
558
559
560
561
562
563
564
565 <li class="md-nav__item">
566 <a href="../../view/css/" class="md-nav__link">
567 CSS
568 </a>
569 </li>
570
571
572
573 </ul>
574 </nav>
575 </li>
576
577
578
579
580
581
582
583
584
585
586
587
588
589 <li class="md-nav__item md-nav__item--active md-nav__item--nested">
590
591
592 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" checked>
593
594 <label class="md-nav__link" for="__nav_4">
595 JavaScript API
596 <span class="md-nav__icon md-icon"></span>
597 </label>
598 <nav class="md-nav" aria-label="JavaScript API" data-md-level="1">
599 <label class="md-nav__title" for="__nav_4">
600 <span class="md-nav__icon md-icon"></span>
601 JavaScript API
602 </label>
603 <ul class="md-nav__list" data-md-scrollfix>
604
605
606
607
608
609 <li class="md-nav__item">
610 <a href="../general-usage/" class="md-nav__link">
611 General Usage
612 </a>
613 </li>
614
615
616
617
618
619
620
621
622
623
624 <li class="md-nav__item md-nav__item--active md-nav__item--nested">
625
626
627 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4_2" type="checkbox" id="__nav_4_2" checked>
628
629 <label class="md-nav__link" for="__nav_4_2">
630 New API
631 <span class="md-nav__icon md-icon"></span>
632 </label>
633 <nav class="md-nav" aria-label="New API" data-md-level="2">
634 <label class="md-nav__title" for="__nav_4_2">
635 <span class="md-nav__icon md-icon"></span>
636 New API
637 </label>
638 <ul class="md-nav__list" data-md-scrollfix>
639
640
641
642
643
644 <li class="md-nav__item">
645 <a href="../new-api_writing-a-module/" class="md-nav__link">
646 Writing a module
647 </a>
648 </li>
649
650
651
652
653
654
655
656 <li class="md-nav__item">
657 <a href="../new-api_data-structures/" class="md-nav__link">
658 Data Structures
659 </a>
660 </li>
661
662
663
664
665
666
667
668 <li class="md-nav__item">
669 <a href="../new-api_core/" class="md-nav__link">
670 Core Functions
671 </a>
672 </li>
673
674
675
676
677
678
679
680 <li class="md-nav__item">
681 <a href="../new-api_dom/" class="md-nav__link">
682 DOM
683 </a>
684 </li>
685
686
687
688
689
690
691
692 <li class="md-nav__item">
693 <a href="../new-api_events/" class="md-nav__link">
694 Event Handling
695 </a>
696 </li>
697
698
699
700
701
702
703
704 <li class="md-nav__item">
705 <a href="../new-api_ajax/" class="md-nav__link">
706 Ajax
707 </a>
708 </li>
709
710
711
712
713
714
715
716 <li class="md-nav__item">
717 <a href="../new-api_dialogs/" class="md-nav__link">
718 Dialogs
719 </a>
720 </li>
721
722
723
724
725
726
727
728 <li class="md-nav__item">
729 <a href="../new-api_browser/" class="md-nav__link">
730 Browser and Screen Sizes
731 </a>
732 </li>
733
734
735
736
737
738
739
740
741
742 <li class="md-nav__item md-nav__item--active">
743
744 <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
745
746
747
748
749 <label class="md-nav__link md-nav__link--active" for="__toc">
750 User Interface
751 <span class="md-nav__icon md-icon"></span>
752 </label>
753
754 <a href="./" class="md-nav__link md-nav__link--active">
755 User Interface
756 </a>
757
758
759<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
760
761
762
763
764
765 <label class="md-nav__title" for="__toc">
766 <span class="md-nav__icon md-icon"></span>
767 Table of contents
768 </label>
769 <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
770
771 <li class="md-nav__item">
772 <a href="#uialignment" class="md-nav__link">
773 Ui/Alignment
774 </a>
775
776 <nav class="md-nav" aria-label="Ui/Alignment">
777 <ul class="md-nav__list">
778
779 <li class="md-nav__item">
780 <a href="#setelement-element-referenceelement-element-options-object" class="md-nav__link">
781 set(element: Element, referenceElement: Element, options: Object)
782 </a>
783
784 <nav class="md-nav" aria-label="set(element: Element, referenceElement: Element, options: Object)">
785 <ul class="md-nav__list">
786
787 <li class="md-nav__item">
788 <a href="#verticaloffset-number" class="md-nav__link">
789 verticalOffset: number
790 </a>
791
792</li>
793
794 <li class="md-nav__item">
795 <a href="#pointer-boolean" class="md-nav__link">
796 pointer: boolean
797 </a>
798
799</li>
800
801 <li class="md-nav__item">
802 <a href="#pointeroffset-number" class="md-nav__link">
803 pointerOffset: number
804 </a>
805
806</li>
807
808 <li class="md-nav__item">
809 <a href="#pointerclassnames-string" class="md-nav__link">
810 pointerClassNames: string[]
811 </a>
812
813</li>
814
815 <li class="md-nav__item">
816 <a href="#refdimensionselement-element" class="md-nav__link">
817 refDimensionsElement: Element
818 </a>
819
820</li>
821
822 <li class="md-nav__item">
823 <a href="#horizontal-string" class="md-nav__link">
824 horizontal: string
825 </a>
826
827</li>
828
829 <li class="md-nav__item">
830 <a href="#vertical-string" class="md-nav__link">
831 vertical: string
832 </a>
833
834</li>
835
836 <li class="md-nav__item">
837 <a href="#allowflip-string" class="md-nav__link">
838 allowFlip: string
839 </a>
840
841</li>
842
843 </ul>
844 </nav>
845
846</li>
847
848 </ul>
849 </nav>
850
851</li>
852
853 <li class="md-nav__item">
854 <a href="#uicloseoverlay" class="md-nav__link">
855 Ui/CloseOverlay
856 </a>
857
858 <nav class="md-nav" aria-label="Ui/CloseOverlay">
859 <ul class="md-nav__list">
860
861 <li class="md-nav__item">
862 <a href="#addidentifier-string-callback-void" class="md-nav__link">
863 add(identifier: string, callback: () =&gt; void)
864 </a>
865
866</li>
867
868 </ul>
869 </nav>
870
871</li>
872
873 <li class="md-nav__item">
874 <a href="#uiconfirmation" class="md-nav__link">
875 Ui/Confirmation
876 </a>
877
878 <nav class="md-nav" aria-label="Ui/Confirmation">
879 <ul class="md-nav__list">
880
881 <li class="md-nav__item">
882 <a href="#showoptions-object" class="md-nav__link">
883 show(options: Object)
884 </a>
885
886 <nav class="md-nav" aria-label="show(options: Object)">
887 <ul class="md-nav__list">
888
889 <li class="md-nav__item">
890 <a href="#cancel-parameters-object-void" class="md-nav__link">
891 cancel: (parameters: Object) =&gt; void
892 </a>
893
894</li>
895
896 <li class="md-nav__item">
897 <a href="#confirm-parameters-object-void" class="md-nav__link">
898 confirm: (parameters: Object) =&gt; void
899 </a>
900
901</li>
902
903 <li class="md-nav__item">
904 <a href="#message-string" class="md-nav__link">
905 message: string
906 </a>
907
908</li>
909
910 <li class="md-nav__item">
911 <a href="#messageishtml" class="md-nav__link">
912 messageIsHtml
913 </a>
914
915</li>
916
917 <li class="md-nav__item">
918 <a href="#parameters-object" class="md-nav__link">
919 parameters: Object
920 </a>
921
922</li>
923
924 <li class="md-nav__item">
925 <a href="#template-string" class="md-nav__link">
926 template: string
927 </a>
928
929</li>
930
931 </ul>
932 </nav>
933
934</li>
935
936 </ul>
937 </nav>
938
939</li>
940
941 <li class="md-nav__item">
942 <a href="#uinotification" class="md-nav__link">
943 Ui/Notification
944 </a>
945
946 <nav class="md-nav" aria-label="Ui/Notification">
947 <ul class="md-nav__list">
948
949 <li class="md-nav__item">
950 <a href="#showmessage-string-callback-void-cssclassname-string" class="md-nav__link">
951 show(message: string, callback?: () =&gt; void, cssClassName?: string)
952 </a>
953
954</li>
955
956 </ul>
957 </nav>
958
959</li>
960
961 </ul>
962
963</nav>
964
965 </li>
966
967
968
969 </ul>
970 </nav>
971 </li>
972
973
974
975
976
977
978
979 <li class="md-nav__item">
980 <a href="../legacy-api/" class="md-nav__link">
981 Legacy API
982 </a>
983 </li>
984
985
986
987
988
989
990
991 <li class="md-nav__item">
992 <a href="../helper-functions/" class="md-nav__link">
993 Helper Functions
994 </a>
995 </li>
996
997
998
999
1000
1001
1002
1003 <li class="md-nav__item">
1004 <a href="../code-snippets/" class="md-nav__link">
1005 Code Snippets
1006 </a>
1007 </li>
1008
1009
1010
1011 </ul>
1012 </nav>
1013 </li>
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025 <li class="md-nav__item md-nav__item--nested">
1026
1027
1028 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" >
1029
1030 <label class="md-nav__link" for="__nav_5">
1031 Package Components
1032 <span class="md-nav__icon md-icon"></span>
1033 </label>
1034 <nav class="md-nav" aria-label="Package Components" data-md-level="1">
1035 <label class="md-nav__title" for="__nav_5">
1036 <span class="md-nav__icon md-icon"></span>
1037 Package Components
1038 </label>
1039 <ul class="md-nav__list" data-md-scrollfix>
1040
1041
1042
1043
1044
1045 <li class="md-nav__item">
1046 <a href="../../package/package-xml/" class="md-nav__link">
1047 package.xml
1048 </a>
1049 </li>
1050
1051
1052
1053
1054
1055
1056
1057
1058 <li class="md-nav__item md-nav__item--nested">
1059
1060
1061 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_2" type="checkbox" id="__nav_5_2" >
1062
1063 <label class="md-nav__link" for="__nav_5_2">
1064 PIPs
1065 <span class="md-nav__icon md-icon"></span>
1066 </label>
1067 <nav class="md-nav" aria-label="PIPs" data-md-level="2">
1068 <label class="md-nav__title" for="__nav_5_2">
1069 <span class="md-nav__icon md-icon"></span>
1070 PIPs
1071 </label>
1072 <ul class="md-nav__list" data-md-scrollfix>
1073
1074
1075
1076
1077
1078 <li class="md-nav__item">
1079 <a href="../../package/pip/" class="md-nav__link">
1080 Overview
1081 </a>
1082 </li>
1083
1084
1085
1086
1087
1088
1089
1090 <li class="md-nav__item">
1091 <a href="../../package/pip/acl-option/" class="md-nav__link">
1092 aclOption
1093 </a>
1094 </li>
1095
1096
1097
1098
1099
1100
1101
1102 <li class="md-nav__item">
1103 <a href="../../package/pip/acp-menu/" class="md-nav__link">
1104 acpMenu
1105 </a>
1106 </li>
1107
1108
1109
1110
1111
1112
1113
1114 <li class="md-nav__item">
1115 <a href="../../package/pip/acp-search-provider/" class="md-nav__link">
1116 acpSearchProvider
1117 </a>
1118 </li>
1119
1120
1121
1122
1123
1124
1125
1126 <li class="md-nav__item">
1127 <a href="../../package/pip/acp-template/" class="md-nav__link">
1128 acpTemplate
1129 </a>
1130 </li>
1131
1132
1133
1134
1135
1136
1137
1138 <li class="md-nav__item">
1139 <a href="../../package/pip/bbcode/" class="md-nav__link">
1140 bbcode
1141 </a>
1142 </li>
1143
1144
1145
1146
1147
1148
1149
1150 <li class="md-nav__item">
1151 <a href="../../package/pip/box/" class="md-nav__link">
1152 box
1153 </a>
1154 </li>
1155
1156
1157
1158
1159
1160
1161
1162 <li class="md-nav__item">
1163 <a href="../../package/pip/clipboard-action/" class="md-nav__link">
1164 clipboardAction
1165 </a>
1166 </li>
1167
1168
1169
1170
1171
1172
1173
1174 <li class="md-nav__item">
1175 <a href="../../package/pip/core-object/" class="md-nav__link">
1176 coreObject
1177 </a>
1178 </li>
1179
1180
1181
1182
1183
1184
1185
1186 <li class="md-nav__item">
1187 <a href="../../package/pip/cronjob/" class="md-nav__link">
1188 cronjob
1189 </a>
1190 </li>
1191
1192
1193
1194
1195
1196
1197
1198 <li class="md-nav__item">
1199 <a href="../../package/pip/event-listener/" class="md-nav__link">
1200 eventListener
1201 </a>
1202 </li>
1203
1204
1205
1206
1207
1208
1209
1210 <li class="md-nav__item">
1211 <a href="../../package/pip/file/" class="md-nav__link">
1212 file
1213 </a>
1214 </li>
1215
1216
1217
1218
1219
1220
1221
1222 <li class="md-nav__item">
1223 <a href="../../package/pip/language/" class="md-nav__link">
1224 language
1225 </a>
1226 </li>
1227
1228
1229
1230
1231
1232
1233
1234 <li class="md-nav__item">
1235 <a href="../../package/pip/media-provider/" class="md-nav__link">
1236 mediaProvider
1237 </a>
1238 </li>
1239
1240
1241
1242
1243
1244
1245
1246 <li class="md-nav__item">
1247 <a href="../../package/pip/menu/" class="md-nav__link">
1248 menu
1249 </a>
1250 </li>
1251
1252
1253
1254
1255
1256
1257
1258 <li class="md-nav__item">
1259 <a href="../../package/pip/menu-item/" class="md-nav__link">
1260 menuItem
1261 </a>
1262 </li>
1263
1264
1265
1266
1267
1268
1269
1270 <li class="md-nav__item">
1271 <a href="../../package/pip/object-type/" class="md-nav__link">
1272 objectType
1273 </a>
1274 </li>
1275
1276
1277
1278
1279
1280
1281
1282 <li class="md-nav__item">
1283 <a href="../../package/pip/object-type-definition/" class="md-nav__link">
1284 objectTypeDefinition
1285 </a>
1286 </li>
1287
1288
1289
1290
1291
1292
1293
1294 <li class="md-nav__item">
1295 <a href="../../package/pip/option/" class="md-nav__link">
1296 option
1297 </a>
1298 </li>
1299
1300
1301
1302
1303
1304
1305
1306 <li class="md-nav__item">
1307 <a href="../../package/pip/page/" class="md-nav__link">
1308 page
1309 </a>
1310 </li>
1311
1312
1313
1314
1315
1316
1317
1318 <li class="md-nav__item">
1319 <a href="../../package/pip/pip/" class="md-nav__link">
1320 pip
1321 </a>
1322 </li>
1323
1324
1325
1326
1327
1328
1329
1330 <li class="md-nav__item">
1331 <a href="../../package/pip/script/" class="md-nav__link">
1332 script
1333 </a>
1334 </li>
1335
1336
1337
1338
1339
1340
1341
1342 <li class="md-nav__item">
1343 <a href="../../package/pip/smiley/" class="md-nav__link">
1344 smiley
1345 </a>
1346 </li>
1347
1348
1349
1350
1351
1352
1353
1354 <li class="md-nav__item">
1355 <a href="../../package/pip/sql/" class="md-nav__link">
1356 sql
1357 </a>
1358 </li>
1359
1360
1361
1362
1363
1364
1365
1366 <li class="md-nav__item">
1367 <a href="../../package/pip/style/" class="md-nav__link">
1368 style
1369 </a>
1370 </li>
1371
1372
1373
1374
1375
1376
1377
1378 <li class="md-nav__item">
1379 <a href="../../package/pip/template/" class="md-nav__link">
1380 template
1381 </a>
1382 </li>
1383
1384
1385
1386
1387
1388
1389
1390 <li class="md-nav__item">
1391 <a href="../../package/pip/template-listener/" class="md-nav__link">
1392 templateListener
1393 </a>
1394 </li>
1395
1396
1397
1398
1399
1400
1401
1402 <li class="md-nav__item">
1403 <a href="../../package/pip/user-group-option/" class="md-nav__link">
1404 userGroupOption
1405 </a>
1406 </li>
1407
1408
1409
1410
1411
1412
1413
1414 <li class="md-nav__item">
1415 <a href="../../package/pip/user-menu/" class="md-nav__link">
1416 userMenu
1417 </a>
1418 </li>
1419
1420
1421
1422
1423
1424
1425
1426 <li class="md-nav__item">
1427 <a href="../../package/pip/user-notification-event/" class="md-nav__link">
1428 userNotificationEvent
1429 </a>
1430 </li>
1431
1432
1433
1434
1435
1436
1437
1438 <li class="md-nav__item">
1439 <a href="../../package/pip/user-option/" class="md-nav__link">
1440 userOption
1441 </a>
1442 </li>
1443
1444
1445
1446
1447
1448
1449
1450 <li class="md-nav__item">
1451 <a href="../../package/pip/user-profile-menu/" class="md-nav__link">
1452 userProfileMenu
1453 </a>
1454 </li>
1455
1456
1457
1458 </ul>
1459 </nav>
1460 </li>
1461
1462
1463
1464
1465
1466
1467
1468 <li class="md-nav__item">
1469 <a href="../../package/database-php-api/" class="md-nav__link">
1470 Database PHP API
1471 </a>
1472 </li>
1473
1474
1475
1476 </ul>
1477 </nav>
1478 </li>
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490 <li class="md-nav__item md-nav__item--nested">
1491
1492
1493 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" >
1494
1495 <label class="md-nav__link" for="__nav_6">
1496 Migration
1497 <span class="md-nav__icon md-icon"></span>
1498 </label>
1499 <nav class="md-nav" aria-label="Migration" data-md-level="1">
1500 <label class="md-nav__title" for="__nav_6">
1501 <span class="md-nav__icon md-icon"></span>
1502 Migration
1503 </label>
1504 <ul class="md-nav__list" data-md-scrollfix>
1505
1506
1507
1508
1509
1510
1511 <li class="md-nav__item md-nav__item--nested">
1512
1513
1514 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_1" type="checkbox" id="__nav_6_1" >
1515
1516 <label class="md-nav__link" for="__nav_6_1">
1517 Migrating from WSC 5.3
1518 <span class="md-nav__icon md-icon"></span>
1519 </label>
1520 <nav class="md-nav" aria-label="Migrating from WSC 5.3" data-md-level="2">
1521 <label class="md-nav__title" for="__nav_6_1">
1522 <span class="md-nav__icon md-icon"></span>
1523 Migrating from WSC 5.3
1524 </label>
1525 <ul class="md-nav__list" data-md-scrollfix>
1526
1527
1528
1529
1530
1531 <li class="md-nav__item">
1532 <a href="../../migration/wsc53/php/" class="md-nav__link">
1533 PHP API
1534 </a>
1535 </li>
1536
1537
1538
1539
1540
1541
1542
1543 <li class="md-nav__item">
1544 <a href="../../migration/wsc53/session/" class="md-nav__link">
1545 Session Handling and Authentication
1546 </a>
1547 </li>
1548
1549
1550
1551
1552
1553
1554
1555 <li class="md-nav__item">
1556 <a href="../../migration/wsc53/javascript/" class="md-nav__link">
1557 JavaScript
1558 </a>
1559 </li>
1560
1561
1562
1563
1564
1565
1566
1567 <li class="md-nav__item">
1568 <a href="../../migration/wsc53/templates/" class="md-nav__link">
1569 Templates
1570 </a>
1571 </li>
1572
1573
1574
1575
1576
1577
1578
1579 <li class="md-nav__item">
1580 <a href="../../migration/wsc53/libraries/" class="md-nav__link">
1581 Third Party Libraries
1582 </a>
1583 </li>
1584
1585
1586
1587 </ul>
1588 </nav>
1589 </li>
1590
1591
1592
1593
1594
1595
1596
1597
1598 <li class="md-nav__item md-nav__item--nested">
1599
1600
1601 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_2" type="checkbox" id="__nav_6_2" >
1602
1603 <label class="md-nav__link" for="__nav_6_2">
1604 Migrating from WSC 5.2
1605 <span class="md-nav__icon md-icon"></span>
1606 </label>
1607 <nav class="md-nav" aria-label="Migrating from WSC 5.2" data-md-level="2">
1608 <label class="md-nav__title" for="__nav_6_2">
1609 <span class="md-nav__icon md-icon"></span>
1610 Migrating from WSC 5.2
1611 </label>
1612 <ul class="md-nav__list" data-md-scrollfix>
1613
1614
1615
1616
1617
1618 <li class="md-nav__item">
1619 <a href="../../migration/wsc52/php/" class="md-nav__link">
1620 PHP API
1621 </a>
1622 </li>
1623
1624
1625
1626
1627
1628
1629
1630 <li class="md-nav__item">
1631 <a href="../../migration/wsc52/templates/" class="md-nav__link">
1632 Templates and Languages
1633 </a>
1634 </li>
1635
1636
1637
1638
1639
1640
1641
1642 <li class="md-nav__item">
1643 <a href="../../migration/wsc52/libraries/" class="md-nav__link">
1644 Third Party Libraries
1645 </a>
1646 </li>
1647
1648
1649
1650 </ul>
1651 </nav>
1652 </li>
1653
1654
1655
1656
1657
1658
1659
1660
1661 <li class="md-nav__item md-nav__item--nested">
1662
1663
1664 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_3" type="checkbox" id="__nav_6_3" >
1665
1666 <label class="md-nav__link" for="__nav_6_3">
1667 Migrating from WSC 3.1
1668 <span class="md-nav__icon md-icon"></span>
1669 </label>
1670 <nav class="md-nav" aria-label="Migrating from WSC 3.1" data-md-level="2">
1671 <label class="md-nav__title" for="__nav_6_3">
1672 <span class="md-nav__icon md-icon"></span>
1673 Migrating from WSC 3.1
1674 </label>
1675 <ul class="md-nav__list" data-md-scrollfix>
1676
1677
1678
1679
1680
1681 <li class="md-nav__item">
1682 <a href="../../migration/wsc31/php/" class="md-nav__link">
1683 PHP API
1684 </a>
1685 </li>
1686
1687
1688
1689 </ul>
1690 </nav>
1691 </li>
1692
1693
1694
1695
1696
1697
1698
1699
1700 <li class="md-nav__item md-nav__item--nested">
1701
1702
1703 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_4" type="checkbox" id="__nav_6_4" >
1704
1705 <label class="md-nav__link" for="__nav_6_4">
1706 Migrating from WSC 3.0
1707 <span class="md-nav__icon md-icon"></span>
1708 </label>
1709 <nav class="md-nav" aria-label="Migrating from WSC 3.0" data-md-level="2">
1710 <label class="md-nav__title" for="__nav_6_4">
1711 <span class="md-nav__icon md-icon"></span>
1712 Migrating from WSC 3.0
1713 </label>
1714 <ul class="md-nav__list" data-md-scrollfix>
1715
1716
1717
1718
1719
1720 <li class="md-nav__item">
1721 <a href="../../migration/wsc30/php/" class="md-nav__link">
1722 PHP API
1723 </a>
1724 </li>
1725
1726
1727
1728
1729
1730
1731
1732 <li class="md-nav__item">
1733 <a href="../../migration/wsc30/javascript/" class="md-nav__link">
1734 JavaScript API
1735 </a>
1736 </li>
1737
1738
1739
1740
1741
1742
1743
1744 <li class="md-nav__item">
1745 <a href="../../migration/wsc30/templates/" class="md-nav__link">
1746 Templates
1747 </a>
1748 </li>
1749
1750
1751
1752
1753
1754
1755
1756 <li class="md-nav__item">
1757 <a href="../../migration/wsc30/css/" class="md-nav__link">
1758 CSS
1759 </a>
1760 </li>
1761
1762
1763
1764
1765
1766
1767
1768 <li class="md-nav__item">
1769 <a href="../../migration/wsc30/package/" class="md-nav__link">
1770 Package Components
1771 </a>
1772 </li>
1773
1774
1775
1776 </ul>
1777 </nav>
1778 </li>
1779
1780
1781
1782
1783
1784
1785
1786
1787 <li class="md-nav__item md-nav__item--nested">
1788
1789
1790 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_5" type="checkbox" id="__nav_6_5" >
1791
1792 <label class="md-nav__link" for="__nav_6_5">
1793 Migrating from WCF 2.1
1794 <span class="md-nav__icon md-icon"></span>
1795 </label>
1796 <nav class="md-nav" aria-label="Migrating from WCF 2.1" data-md-level="2">
1797 <label class="md-nav__title" for="__nav_6_5">
1798 <span class="md-nav__icon md-icon"></span>
1799 Migrating from WCF 2.1
1800 </label>
1801 <ul class="md-nav__list" data-md-scrollfix>
1802
1803
1804
1805
1806
1807 <li class="md-nav__item">
1808 <a href="../../migration/wcf21/php/" class="md-nav__link">
1809 PHP API
1810 </a>
1811 </li>
1812
1813
1814
1815
1816
1817
1818
1819 <li class="md-nav__item">
1820 <a href="../../migration/wcf21/templates/" class="md-nav__link">
1821 Templates
1822 </a>
1823 </li>
1824
1825
1826
1827
1828
1829
1830
1831 <li class="md-nav__item">
1832 <a href="../../migration/wcf21/css/" class="md-nav__link">
1833 CSS
1834 </a>
1835 </li>
1836
1837
1838
1839
1840
1841
1842
1843 <li class="md-nav__item">
1844 <a href="../../migration/wcf21/package/" class="md-nav__link">
1845 Package Components
1846 </a>
1847 </li>
1848
1849
1850
1851 </ul>
1852 </nav>
1853 </li>
1854
1855
1856
1857 </ul>
1858 </nav>
1859 </li>
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871 <li class="md-nav__item md-nav__item--nested">
1872
1873
1874 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >
1875
1876 <label class="md-nav__link" for="__nav_7">
1877 Tutorials
1878 <span class="md-nav__icon md-icon"></span>
1879 </label>
1880 <nav class="md-nav" aria-label="Tutorials" data-md-level="1">
1881 <label class="md-nav__title" for="__nav_7">
1882 <span class="md-nav__icon md-icon"></span>
1883 Tutorials
1884 </label>
1885 <ul class="md-nav__list" data-md-scrollfix>
1886
1887
1888
1889
1890
1891
1892 <li class="md-nav__item md-nav__item--nested">
1893
1894
1895 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7_1" type="checkbox" id="__nav_7_1" >
1896
1897 <label class="md-nav__link" for="__nav_7_1">
1898 Tutorial Series
1899 <span class="md-nav__icon md-icon"></span>
1900 </label>
1901 <nav class="md-nav" aria-label="Tutorial Series" data-md-level="2">
1902 <label class="md-nav__title" for="__nav_7_1">
1903 <span class="md-nav__icon md-icon"></span>
1904 Tutorial Series
1905 </label>
1906 <ul class="md-nav__list" data-md-scrollfix>
1907
1908
1909
1910
1911
1912 <li class="md-nav__item">
1913 <a href="../../tutorial/series/overview/" class="md-nav__link">
1914 Overview
1915 </a>
1916 </li>
1917
1918
1919
1920
1921
1922
1923
1924 <li class="md-nav__item">
1925 <a href="../../tutorial/series/part_1/" class="md-nav__link">
1926 Part 1
1927 </a>
1928 </li>
1929
1930
1931
1932
1933
1934
1935
1936 <li class="md-nav__item">
1937 <a href="../../tutorial/series/part_2/" class="md-nav__link">
1938 Part 2
1939 </a>
1940 </li>
1941
1942
1943
1944
1945
1946
1947
1948 <li class="md-nav__item">
1949 <a href="../../tutorial/series/part_3/" class="md-nav__link">
1950 Part 3
1951 </a>
1952 </li>
1953
1954
1955
1956 </ul>
1957 </nav>
1958 </li>
1959
1960
1961
1962 </ul>
1963 </nav>
1964 </li>
1965
1966
1967
1968 </ul>
1969</nav>
1970 </div>
1971 </div>
1972 </div>
1973
1974
1975
1976 <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
1977 <div class="md-sidebar__scrollwrap">
1978 <div class="md-sidebar__inner">
1979
1980<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
1981
1982
1983
1984
1985
1986 <label class="md-nav__title" for="__toc">
1987 <span class="md-nav__icon md-icon"></span>
1988 Table of contents
1989 </label>
1990 <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
1991
1992 <li class="md-nav__item">
1993 <a href="#uialignment" class="md-nav__link">
1994 Ui/Alignment
1995 </a>
1996
1997 <nav class="md-nav" aria-label="Ui/Alignment">
1998 <ul class="md-nav__list">
1999
2000 <li class="md-nav__item">
2001 <a href="#setelement-element-referenceelement-element-options-object" class="md-nav__link">
2002 set(element: Element, referenceElement: Element, options: Object)
2003 </a>
2004
2005 <nav class="md-nav" aria-label="set(element: Element, referenceElement: Element, options: Object)">
2006 <ul class="md-nav__list">
2007
2008 <li class="md-nav__item">
2009 <a href="#verticaloffset-number" class="md-nav__link">
2010 verticalOffset: number
2011 </a>
2012
2013</li>
2014
2015 <li class="md-nav__item">
2016 <a href="#pointer-boolean" class="md-nav__link">
2017 pointer: boolean
2018 </a>
2019
2020</li>
2021
2022 <li class="md-nav__item">
2023 <a href="#pointeroffset-number" class="md-nav__link">
2024 pointerOffset: number
2025 </a>
2026
2027</li>
2028
2029 <li class="md-nav__item">
2030 <a href="#pointerclassnames-string" class="md-nav__link">
2031 pointerClassNames: string[]
2032 </a>
2033
2034</li>
2035
2036 <li class="md-nav__item">
2037 <a href="#refdimensionselement-element" class="md-nav__link">
2038 refDimensionsElement: Element
2039 </a>
2040
2041</li>
2042
2043 <li class="md-nav__item">
2044 <a href="#horizontal-string" class="md-nav__link">
2045 horizontal: string
2046 </a>
2047
2048</li>
2049
2050 <li class="md-nav__item">
2051 <a href="#vertical-string" class="md-nav__link">
2052 vertical: string
2053 </a>
2054
2055</li>
2056
2057 <li class="md-nav__item">
2058 <a href="#allowflip-string" class="md-nav__link">
2059 allowFlip: string
2060 </a>
2061
2062</li>
2063
2064 </ul>
2065 </nav>
2066
2067</li>
2068
2069 </ul>
2070 </nav>
2071
2072</li>
2073
2074 <li class="md-nav__item">
2075 <a href="#uicloseoverlay" class="md-nav__link">
2076 Ui/CloseOverlay
2077 </a>
2078
2079 <nav class="md-nav" aria-label="Ui/CloseOverlay">
2080 <ul class="md-nav__list">
2081
2082 <li class="md-nav__item">
2083 <a href="#addidentifier-string-callback-void" class="md-nav__link">
2084 add(identifier: string, callback: () =&gt; void)
2085 </a>
2086
2087</li>
2088
2089 </ul>
2090 </nav>
2091
2092</li>
2093
2094 <li class="md-nav__item">
2095 <a href="#uiconfirmation" class="md-nav__link">
2096 Ui/Confirmation
2097 </a>
2098
2099 <nav class="md-nav" aria-label="Ui/Confirmation">
2100 <ul class="md-nav__list">
2101
2102 <li class="md-nav__item">
2103 <a href="#showoptions-object" class="md-nav__link">
2104 show(options: Object)
2105 </a>
2106
2107 <nav class="md-nav" aria-label="show(options: Object)">
2108 <ul class="md-nav__list">
2109
2110 <li class="md-nav__item">
2111 <a href="#cancel-parameters-object-void" class="md-nav__link">
2112 cancel: (parameters: Object) =&gt; void
2113 </a>
2114
2115</li>
2116
2117 <li class="md-nav__item">
2118 <a href="#confirm-parameters-object-void" class="md-nav__link">
2119 confirm: (parameters: Object) =&gt; void
2120 </a>
2121
2122</li>
2123
2124 <li class="md-nav__item">
2125 <a href="#message-string" class="md-nav__link">
2126 message: string
2127 </a>
2128
2129</li>
2130
2131 <li class="md-nav__item">
2132 <a href="#messageishtml" class="md-nav__link">
2133 messageIsHtml
2134 </a>
2135
2136</li>
2137
2138 <li class="md-nav__item">
2139 <a href="#parameters-object" class="md-nav__link">
2140 parameters: Object
2141 </a>
2142
2143</li>
2144
2145 <li class="md-nav__item">
2146 <a href="#template-string" class="md-nav__link">
2147 template: string
2148 </a>
2149
2150</li>
2151
2152 </ul>
2153 </nav>
2154
2155</li>
2156
2157 </ul>
2158 </nav>
2159
2160</li>
2161
2162 <li class="md-nav__item">
2163 <a href="#uinotification" class="md-nav__link">
2164 Ui/Notification
2165 </a>
2166
2167 <nav class="md-nav" aria-label="Ui/Notification">
2168 <ul class="md-nav__list">
2169
2170 <li class="md-nav__item">
2171 <a href="#showmessage-string-callback-void-cssclassname-string" class="md-nav__link">
2172 show(message: string, callback?: () =&gt; void, cssClassName?: string)
2173 </a>
2174
2175</li>
2176
2177 </ul>
2178 </nav>
2179
2180</li>
2181
2182 </ul>
2183
2184</nav>
2185 </div>
2186 </div>
2187 </div>
2188
2189
2190 <div class="md-content" data-md-component="content">
2191 <article class="md-content__inner md-typeset">
2192
2193
2194
2195 <h1 id="user-interface-javascript-api">User Interface - JavaScript API<a class="headerlink" href="#user-interface-javascript-api" title="Permanent link">#</a></h1>
2196<h2 id="uialignment"><code>Ui/Alignment</code><a class="headerlink" href="#uialignment" title="Permanent link">#</a></h2>
2197<p>Calculates the alignment of one element relative to another element, with support
2198for boundary constraints, alignment restrictions and additional pointer elements.</p>
2199<h3 id="setelement-element-referenceelement-element-options-object"><code>set(element: Element, referenceElement: Element, options: Object)</code><a class="headerlink" href="#setelement-element-referenceelement-element-options-object" title="Permanent link">#</a></h3>
2200<p>Calculates and sets the alignment of the element <code>element</code>.</p>
2201<h4 id="verticaloffset-number"><code>verticalOffset: number</code><a class="headerlink" href="#verticaloffset-number" title="Permanent link">#</a></h4>
2202<p><em>Defaults to <code>0</code>.</em></p>
2203<p>Creates a gap between the element and the reference element, in pixels.</p>
2204<h4 id="pointer-boolean"><code>pointer: boolean</code><a class="headerlink" href="#pointer-boolean" title="Permanent link">#</a></h4>
2205<p><em>Defaults to <code>false</code>.</em></p>
2206<p>Sets the position of the pointer element, requires an existing child of the
2207element with the CSS class <code>.elementPointer</code>.</p>
2208<h4 id="pointeroffset-number"><code>pointerOffset: number</code><a class="headerlink" href="#pointeroffset-number" title="Permanent link">#</a></h4>
2209<p><em>Defaults to <code>4</code>.</em></p>
2210<p>The margin from the left/right edge of the element and is used to avoid the
2211arrow from being placed right at the edge.</p>
2212<p>Does not apply when aligning the element to the reference elemnent's center.</p>
2213<h4 id="pointerclassnames-string"><code>pointerClassNames: string[]</code><a class="headerlink" href="#pointerclassnames-string" title="Permanent link">#</a></h4>
2214<p><em>Defaults to <code>[]</code>.</em></p>
2215<p>If your element uses CSS-only pointers, such as using the <code>::before</code> or <code>::after</code>
2216pseudo selectors, you can specifiy two separate CSS class names that control the
2217alignment:</p>
2218<ul>
2219<li><code>pointerClassNames[0]</code> is applied to the element when the pointer is displayed
2220 at the bottom.</li>
2221<li><code>pointerClassNames[1]</code> is used to align the pointer to the right side of the
2222 element.</li>
2223</ul>
2224<h4 id="refdimensionselement-element"><code>refDimensionsElement: Element</code><a class="headerlink" href="#refdimensionselement-element" title="Permanent link">#</a></h4>
2225<p><em>Defaults to <code>null</code>.</em></p>
2226<p>An alternative element that will be used to determine the position and dimensions
2227of the reference element. This can be useful if you reference element is contained
2228in a wrapper element with alternating dimensions.</p>
2229<h4 id="horizontal-string"><code>horizontal: string</code><a class="headerlink" href="#horizontal-string" title="Permanent link">#</a></h4>
2230<div class="admonition info">
2231<p class="admonition-title">This value is automatically flipped for RTL (right-to-left) languages, <code>left</code> is changed into <code>right</code> and vice versa.</p>
2232</div>
2233<p><em>Defaults to <code>"left"</code>.</em></p>
2234<p>Sets the prefered alignment, accepts either <code>left</code> or <code>right</code>. The value <code>left</code>
2235instructs the module to align the element with the left boundary of the reference
2236element.</p>
2237<p>The <code>horizontal</code> alignment is used as the default and a flip only occurs, if there
2238is not enough space in the desired direction. If the element exceeds the boundaries
2239in both directions, the value of <code>horizontal</code> is used.</p>
2240<h4 id="vertical-string"><code>vertical: string</code><a class="headerlink" href="#vertical-string" title="Permanent link">#</a></h4>
2241<p><em>Defaults to <code>"bottom"</code>.</em></p>
2242<p>Sets the prefered alignment, accepts either <code>bottom</code> or <code>top</code>. The value <code>bottom</code>
2243instructs the module to align the element below the reference element.</p>
2244<p>The <code>vertical</code> alignment is used as the default and a flip only occurs, if there
2245is not enough space in the desired direction. If the element exceeds the boundaries
2246in both directions, the value of <code>vertical</code> is used.</p>
2247<h4 id="allowflip-string"><code>allowFlip: string</code><a class="headerlink" href="#allowflip-string" title="Permanent link">#</a></h4>
2248<div class="admonition info">
2249<p class="admonition-title">The value for <code>horizontal</code> is automatically flipped for RTL (right-to-left) languages, <code>left</code> is changed into <code>right</code> and vice versa. This setting only controls the behavior when violating space constraints, therefore the aforementioned transformation is always applied.</p>
2250</div>
2251<p><em>Defaults to <code>"both"</code>.</em></p>
2252<p>Restricts the automatic alignment flipping if the element exceeds the window
2253boundaries in the instructed direction.</p>
2254<ul>
2255<li><code>both</code> - No restrictions.</li>
2256<li><code>horizontal</code> - Element can be aligned with the left <em>or</em> the right boundary of
2257 the reference element, but the vertical position is fixed.</li>
2258<li><code>vertical</code> - Element can be aligned below <em>or</em> above the reference element,
2259 but the vertical position is fixed.</li>
2260<li><code>none</code> - No flipping can occur, the element will be aligned regardless of
2261 any space constraints.</li>
2262</ul>
2263<h2 id="uicloseoverlay"><code>Ui/CloseOverlay</code><a class="headerlink" href="#uicloseoverlay" title="Permanent link">#</a></h2>
2264<p>Register elements that should be closed when the user clicks anywhere else, such
2265as drop-down menus or tooltips.</p>
2266<div class="highlight"><pre><span></span><code><span class="nx">require</span><span class="p">([</span><span class="s2">&quot;Ui/CloseOverlay&quot;</span><span class="p">],</span> <span class="kd">function</span><span class="p">(</span><span class="nx">UiCloseOverlay</span><span class="p">)</span> <span class="p">{</span>
2267 <span class="nx">UiCloseOverlay</span><span class="p">.</span><span class="nx">add</span><span class="p">(</span><span class="s2">&quot;App/Foo&quot;</span><span class="p">,</span> <span class="kd">function</span><span class="p">()</span> <span class="p">{</span>
2268 <span class="c1">// invoked, close something</span>
2269 <span class="p">});</span>
2270<span class="p">});</span>
2271</code></pre></div>
45ca63d0
TD		 2272<h3 id="addidentifier-string-callback-void"><code>add(identifier: string, callback: () =&gt; void)</code><a class="headerlink" href="#addidentifier-string-callback-void" title="Permanent link">#</a></h3>
2273<p>Adds a callback that will be invoked when the user clicks anywhere else.</p>
2274<h2 id="uiconfirmation"><code>Ui/Confirmation</code><a class="headerlink" href="#uiconfirmation" title="Permanent link">#</a></h2>
2275<p>Prompt the user to make a decision before carrying out an action, such as a safety
2276warning before permanently deleting content.</p>
2277<div class="highlight"><pre><span></span><code><span class="nx">require</span><span class="p">([</span><span class="s2">&quot;Ui/Confirmation&quot;</span><span class="p">],</span> <span class="kd">function</span><span class="p">(</span><span class="nx">UiConfirmation</span><span class="p">)</span> <span class="p">{</span>
2278 <span class="nx">UiConfirmation</span><span class="p">.</span><span class="nx">show</span><span class="p">({</span>
2279 <span class="nx">confirm</span><span class="o">:</span> <span class="kd">function</span><span class="p">()</span> <span class="p">{</span>
2280 <span class="c1">// the user has confirmed the dialog</span>
2281 <span class="p">},</span>
2282 <span class="nx">message</span><span class="o">:</span> <span class="s2">&quot;Do you really want to continue?&quot;</span>
2283 <span class="p">});</span>
2284<span class="p">});</span>
2285</code></pre></div>
45ca63d0
TD		 2286<h3 id="showoptions-object"><code>show(options: Object)</code><a class="headerlink" href="#showoptions-object" title="Permanent link">#</a></h3>
2287<p>Displays a dialog overlay with actions buttons to confirm or reject the dialog.</p>
2288<h4 id="cancel-parameters-object-void"><code>cancel: (parameters: Object) =&gt; void</code><a class="headerlink" href="#cancel-parameters-object-void" title="Permanent link">#</a></h4>
2289<p><em>Defaults to <code>null</code>.</em></p>
2290<p>Callback that is invoked when the dialog was rejected.</p>
2291<h4 id="confirm-parameters-object-void"><code>confirm: (parameters: Object) =&gt; void</code><a class="headerlink" href="#confirm-parameters-object-void" title="Permanent link">#</a></h4>
2292<p><em>Defaults to <code>null</code>.</em></p>
2293<p>Callback that is invoked when the user has confirmed the dialog.</p>
2294<h4 id="message-string"><code>message: string</code><a class="headerlink" href="#message-string" title="Permanent link">#</a></h4>
2295<p><em>Defaults to '""'.</em></p>
2296<p>Text that is displayed in the content area of the dialog, optionally this can
2297be HTML, but this requires <code>messageIsHtml</code> to be enabled.</p>
2298<h4 id="messageishtml"><code>messageIsHtml</code><a class="headerlink" href="#messageishtml" title="Permanent link">#</a></h4>
2299<p><em>Defaults to <code>false</code>.</em></p>
2300<p>The <code>message</code> option is interpreted as text-only, setting this option to <code>true</code>
2301will cause the <code>message</code> to be evaluated as HTML.</p>
2302<h4 id="parameters-object"><code>parameters: Object</code><a class="headerlink" href="#parameters-object" title="Permanent link">#</a></h4>
2303<p>Optional list of parameter options that will be passed to the <code>cancel()</code> and
2304<code>confirm()</code> callbacks.</p>
2305<h4 id="template-string"><code>template: string</code><a class="headerlink" href="#template-string" title="Permanent link">#</a></h4>
2306<p>An optional HTML template that will be inserted into the dialog content area,
2307but after the <code>message</code> section.</p>
2308<h2 id="uinotification"><code>Ui/Notification</code><a class="headerlink" href="#uinotification" title="Permanent link">#</a></h2>
2309<p>Displays a simple notification at the very top of the window, such as a success
2310message for Ajax based actions.</p>
2311<div class="highlight"><pre><span></span><code><span class="nx">require</span><span class="p">([</span><span class="s2">&quot;Ui/Notification&quot;</span><span class="p">],</span> <span class="kd">function</span><span class="p">(</span><span class="nx">UiNotification</span><span class="p">)</span> <span class="p">{</span>
2312 <span class="nx">UiNotification</span><span class="p">.</span><span class="nx">show</span><span class="p">(</span>
2313 <span class="s2">&quot;Your changes have been saved.&quot;</span><span class="p">,</span>
2314 <span class="kd">function</span><span class="p">()</span> <span class="p">{</span>
2315 <span class="c1">// this callback will be invoked after 2 seconds</span>
2316 <span class="p">},</span>
2317 <span class="s2">&quot;success&quot;</span>
2318 <span class="p">);</span>
2319<span class="p">});</span>
2320</code></pre></div>
45ca63d0
TD		 2321<h3 id="showmessage-string-callback-void-cssclassname-string"><code>show(message: string, callback?: () =&gt; void, cssClassName?: string)</code><a class="headerlink" href="#showmessage-string-callback-void-cssclassname-string" title="Permanent link">#</a></h3>
2322<p>Shows the notification and executes the callback after 2 seconds.</p>
2323
2324
2325
2326
2327
2328
2329
2330 </article>
2331 </div>
2332 </div>
2333 </main>
2334
2335
2336<footer class="md-footer">
2337
2338 <nav class="md-footer__inner md-grid" aria-label="Footer">
2339
2340 <a href="../new-api_browser/" class="md-footer__link md-footer__link--prev" rel="prev">
2341 <div class="md-footer__button md-icon">
2342 <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>
2343 </div>
2344 <div class="md-footer__title">
2345 <div class="md-ellipsis">
2346 <span class="md-footer__direction">
2347 Previous
2348 </span>
2349 Browser and Screen Sizes
2350 </div>
2351 </div>
2352 </a>
2353
2354
2355 <a href="../legacy-api/" class="md-footer__link md-footer__link--next" rel="next">
2356 <div class="md-footer__title">
2357 <div class="md-ellipsis">
2358 <span class="md-footer__direction">
2359 Next
2360 </span>
2361 Legacy API
2362 </div>
2363 </div>
2364 <div class="md-footer__button md-icon">
2365 <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>
2366 </div>
2367 </a>
2368
2369 </nav>
2370
2371 <div class="md-footer-meta md-typeset">
2372 <div class="md-footer-meta__inner md-grid">
2373 <div class="md-footer-copyright">
2374
2375 <div class="md-footer-copyright__highlight">
2376 Copyright © 2020 WoltLab GmbH
2377 </div>
2378
2379 Made with
2380 <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
2381 Material for MkDocs
2382 </a>
fb88dc6e 2383
45ca63d0
TD		 2384 </div>
2385 <div class="md-footer-copyright">
2386 <a href="https://www.woltlab.com/legal-notice/">Legal Notice</a>
2387 <a href="https://www.woltlab.com/privacy-policy/">Privacy Policy</a>
2388</div>
2389 </div>
2390 </div>
2391</footer>
2392
2393 </div>
2394 <div class="md-dialog" data-md-component="dialog">
2395 <div class="md-dialog__inner md-typeset"></div>
2396 </div>
2397 <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.fb4a9340.min.js", "version": {"provider": "mike"}}</script>
2398
2399
fb88dc6e 2400 <script src="../../assets/javascripts/bundle.5cf3e710.min.js"></script>
45ca63d0
TD		 2401
2402
2403 </body>
2404</html>