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