5.4/javascript/new-api_browser/index.html

   1
   2 <!doctype html>
   3 <html lang="en" class="no-js">
   4   <head>
   5
   6       <meta charset="utf-8">
   7       <meta name="viewport" content="width=device-width,initial-scale=1">
   8
   9
  10
  11
  12       <link rel="icon" href="../../assets/default.favicon.ico">
  13       <meta name="generator" content="mkdocs-1.1.2, mkdocs-material-7.1.0">
  14
  15
  16
  17         <title>Browser and Screen Sizes - WoltLab Suite Documentation</title>
  18
  19
  20
  21       <link rel="stylesheet" href="../../assets/stylesheets/main.33e2939f.min.css">
  22
  23
  24         <link rel="stylesheet" href="../../assets/stylesheets/palette.ef6f36e2.min.css">
  25
  26
  27
  28           <meta name="theme-color" content="#009485">
  29
  30
  31
  32
  33
  34
  35
  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="">
  53
  54
  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
  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="#browser-and-screen-sizes-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
  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" data-md-component="logo">
  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               Browser and Screen Sizes
 101
 102           </span>
 103         </div>
 104       </div>
 105     </div>
 106
 107
 108
 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">
 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>
 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
 139
 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
 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>
 146   </div>
 147   <div class="md-source__repository">
 148     GitHub
 149   </div>
 150 </a>
 151       </div>
 152
 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
 172 <nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
 173   <label class="md-nav__title" for="__drawer">
 174     <a href="../.." title="WoltLab Suite Documentation" class="md-nav__button md-logo" aria-label="WoltLab Suite Documentation" data-md-component="logo">
 175
 176   <img src="../../assets/logo.png" alt="logo">
 177
 178     </a>
 179     WoltLab Suite Documentation
 180   </label>
 181
 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
 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>
 188   </div>
 189   <div class="md-source__repository">
 190     GitHub
 191   </div>
 192 </a>
 193     </div>
 194
 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
 310     <li class="md-nav__item md-nav__item--nested">
 311
 312
 313         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5_1" type="checkbox" id="__nav_2_5_1" >
 314
 315       <label class="md-nav__link" for="__nav_2_5_1">
 316         Caches
 317         <span class="md-nav__icon md-icon"></span>
 318       </label>
 319       <nav class="md-nav" aria-label="Caches" data-md-level="3">
 320         <label class="md-nav__title" for="__nav_2_5_1">
 321           <span class="md-nav__icon md-icon"></span>
 322           Caches
 323         </label>
 324         <ul class="md-nav__list" data-md-scrollfix>
 325
 326
 327
 328
 329
 330     <li class="md-nav__item">
 331       <a href="../../php/api/caches/" class="md-nav__link">
 332         Overview
 333       </a>
 334     </li>
 335
 336
 337
 338
 339
 340
 341
 342     <li class="md-nav__item">
 343       <a href="../../php/api/caches_persistent-caches/" class="md-nav__link">
 344         Persistent Caches
 345       </a>
 346     </li>
 347
 348
 349
 350
 351
 352
 353
 354     <li class="md-nav__item">
 355       <a href="../../php/api/caches_runtime-caches/" class="md-nav__link">
 356         Runtime Caches
 357       </a>
 358     </li>
 359
 360
 361
 362         </ul>
 363       </nav>
 364     </li>
 365
 366
 367
 368
 369
 370
 371
 372     <li class="md-nav__item">
 373       <a href="../../php/api/comments/" class="md-nav__link">
 374         Comments
 375       </a>
 376     </li>
 377
 378
 379
 380
 381
 382
 383
 384     <li class="md-nav__item">
 385       <a href="../../php/api/cronjobs/" class="md-nav__link">
 386         Cronjobs
 387       </a>
 388     </li>
 389
 390
 391
 392
 393
 394
 395
 396     <li class="md-nav__item">
 397       <a href="../../php/api/events/" class="md-nav__link">
 398         Events
 399       </a>
 400     </li>
 401
 402
 403
 404
 405
 406
 407
 408
 409     <li class="md-nav__item md-nav__item--nested">
 410
 411
 412         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5_5" type="checkbox" id="__nav_2_5_5" >
 413
 414       <label class="md-nav__link" for="__nav_2_5_5">
 415         Form Builder
 416         <span class="md-nav__icon md-icon"></span>
 417       </label>
 418       <nav class="md-nav" aria-label="Form Builder" data-md-level="3">
 419         <label class="md-nav__title" for="__nav_2_5_5">
 420           <span class="md-nav__icon md-icon"></span>
 421           Form Builder
 422         </label>
 423         <ul class="md-nav__list" data-md-scrollfix>
 424
 425
 426
 427
 428
 429     <li class="md-nav__item">
 430       <a href="../../php/api/form_builder/overview/" class="md-nav__link">
 431         Overview
 432       </a>
 433     </li>
 434
 435
 436
 437
 438
 439
 440
 441     <li class="md-nav__item">
 442       <a href="../../php/api/form_builder/structure/" class="md-nav__link">
 443         Structure
 444       </a>
 445     </li>
 446
 447
 448
 449
 450
 451
 452
 453     <li class="md-nav__item">
 454       <a href="../../php/api/form_builder/form_fields/" class="md-nav__link">
 455         Fields
 456       </a>
 457     </li>
 458
 459
 460
 461
 462
 463
 464
 465     <li class="md-nav__item">
 466       <a href="../../php/api/form_builder/validation_data/" class="md-nav__link">
 467         Validation and Data
 468       </a>
 469     </li>
 470
 471
 472
 473
 474
 475
 476
 477     <li class="md-nav__item">
 478       <a href="../../php/api/form_builder/dependencies/" class="md-nav__link">
 479         Dependencies
 480       </a>
 481     </li>
 482
 483
 484
 485         </ul>
 486       </nav>
 487     </li>
 488
 489
 490
 491
 492
 493
 494
 495     <li class="md-nav__item">
 496       <a href="../../php/api/package_installation_plugins/" class="md-nav__link">
 497         Package Installation Plugins
 498       </a>
 499     </li>
 500
 501
 502
 503
 504
 505
 506
 507     <li class="md-nav__item">
 508       <a href="../../php/api/user_activity_points/" class="md-nav__link">
 509         User Activity Points
 510       </a>
 511     </li>
 512
 513
 514
 515
 516
 517
 518
 519     <li class="md-nav__item">
 520       <a href="../../php/api/user_notifications/" class="md-nav__link">
 521         User Notifications
 522       </a>
 523     </li>
 524
 525
 526
 527
 528
 529
 530
 531     <li class="md-nav__item">
 532       <a href="../../php/api/sitemaps/" class="md-nav__link">
 533         Sitemaps
 534       </a>
 535     </li>
 536
 537
 538
 539         </ul>
 540       </nav>
 541     </li>
 542
 543
 544
 545
 546
 547
 548
 549     <li class="md-nav__item">
 550       <a href="../../php/code-style/" class="md-nav__link">
 551         Code Style
 552       </a>
 553     </li>
 554
 555
 556
 557
 558
 559
 560
 561     <li class="md-nav__item">
 562       <a href="../../php/apps/" class="md-nav__link">
 563         Apps
 564       </a>
 565     </li>
 566
 567
 568
 569
 570
 571
 572
 573     <li class="md-nav__item">
 574       <a href="../../php/gdpr/" class="md-nav__link">
 575         GDPR
 576       </a>
 577     </li>
 578
 579
 580
 581         </ul>
 582       </nav>
 583     </li>
 584
 585
 586
 587
 588
 589
 590
 591
 592
 593
 594
 595     <li class="md-nav__item md-nav__item--nested">
 596
 597
 598         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" type="checkbox" id="__nav_3" >
 599
 600       <label class="md-nav__link" for="__nav_3">
 601         Languages, Templates & CSS
 602         <span class="md-nav__icon md-icon"></span>
 603       </label>
 604       <nav class="md-nav" aria-label="Languages, Templates & CSS" data-md-level="1">
 605         <label class="md-nav__title" for="__nav_3">
 606           <span class="md-nav__icon md-icon"></span>
 607           Languages, Templates & CSS
 608         </label>
 609         <ul class="md-nav__list" data-md-scrollfix>
 610
 611
 612
 613
 614
 615     <li class="md-nav__item">
 616       <a href="../../view/languages/" class="md-nav__link">
 617         Languages
 618       </a>
 619     </li>
 620
 621
 622
 623
 624
 625
 626
 627     <li class="md-nav__item">
 628       <a href="../../view/templates/" class="md-nav__link">
 629         Templates
 630       </a>
 631     </li>
 632
 633
 634
 635
 636
 637
 638
 639     <li class="md-nav__item">
 640       <a href="../../view/template-plugins/" class="md-nav__link">
 641         Template Plugins
 642       </a>
 643     </li>
 644
 645
 646
 647
 648
 649
 650
 651     <li class="md-nav__item">
 652       <a href="../../view/css/" class="md-nav__link">
 653         CSS
 654       </a>
 655     </li>
 656
 657
 658
 659         </ul>
 660       </nav>
 661     </li>
 662
 663
 664
 665
 666
 667
 668
 669
 670
 671
 672
 673
 674
 675     <li class="md-nav__item md-nav__item--active md-nav__item--nested">
 676
 677
 678         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" checked>
 679
 680       <label class="md-nav__link" for="__nav_4">
 681         TypeScript and JavaScript API
 682         <span class="md-nav__icon md-icon"></span>
 683       </label>
 684       <nav class="md-nav" aria-label="TypeScript and JavaScript API" data-md-level="1">
 685         <label class="md-nav__title" for="__nav_4">
 686           <span class="md-nav__icon md-icon"></span>
 687           TypeScript and JavaScript API
 688         </label>
 689         <ul class="md-nav__list" data-md-scrollfix>
 690
 691
 692
 693
 694
 695     <li class="md-nav__item">
 696       <a href="../general-usage/" class="md-nav__link">
 697         General Usage
 698       </a>
 699     </li>
 700
 701
 702
 703
 704
 705
 706
 707     <li class="md-nav__item">
 708       <a href="../typescript/" class="md-nav__link">
 709         TypeScript
 710       </a>
 711     </li>
 712
 713
 714
 715
 716
 717
 718
 719
 720
 721
 722     <li class="md-nav__item md-nav__item--active md-nav__item--nested">
 723
 724
 725         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4_3" type="checkbox" id="__nav_4_3" checked>
 726
 727       <label class="md-nav__link" for="__nav_4_3">
 728         New API
 729         <span class="md-nav__icon md-icon"></span>
 730       </label>
 731       <nav class="md-nav" aria-label="New API" data-md-level="2">
 732         <label class="md-nav__title" for="__nav_4_3">
 733           <span class="md-nav__icon md-icon"></span>
 734           New API
 735         </label>
 736         <ul class="md-nav__list" data-md-scrollfix>
 737
 738
 739
 740
 741
 742     <li class="md-nav__item">
 743       <a href="../new-api_writing-a-module/" class="md-nav__link">
 744         Writing a module
 745       </a>
 746     </li>
 747
 748
 749
 750
 751
 752
 753
 754     <li class="md-nav__item">
 755       <a href="../new-api_data-structures/" class="md-nav__link">
 756         Data Structures
 757       </a>
 758     </li>
 759
 760
 761
 762
 763
 764
 765
 766     <li class="md-nav__item">
 767       <a href="../new-api_core/" class="md-nav__link">
 768         Core Functions
 769       </a>
 770     </li>
 771
 772
 773
 774
 775
 776
 777
 778     <li class="md-nav__item">
 779       <a href="../new-api_dom/" class="md-nav__link">
 780         DOM
 781       </a>
 782     </li>
 783
 784
 785
 786
 787
 788
 789
 790     <li class="md-nav__item">
 791       <a href="../new-api_events/" class="md-nav__link">
 792         Event Handling
 793       </a>
 794     </li>
 795
 796
 797
 798
 799
 800
 801
 802     <li class="md-nav__item">
 803       <a href="../new-api_ajax/" class="md-nav__link">
 804         Ajax
 805       </a>
 806     </li>
 807
 808
 809
 810
 811
 812
 813
 814     <li class="md-nav__item">
 815       <a href="../new-api_dialogs/" class="md-nav__link">
 816         Dialogs
 817       </a>
 818     </li>
 819
 820
 821
 822
 823
 824
 825
 826
 827
 828     <li class="md-nav__item md-nav__item--active">
 829
 830       <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
 831
 832
 833
 834
 835         <label class="md-nav__link md-nav__link--active" for="__toc">
 836           Browser and Screen Sizes
 837           <span class="md-nav__icon md-icon"></span>
 838         </label>
 839
 840       <a href="./" class="md-nav__link md-nav__link--active">
 841         Browser and Screen Sizes
 842       </a>
 843
 844
 845 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
 846
 847
 848
 849
 850
 851     <label class="md-nav__title" for="__toc">
 852       <span class="md-nav__icon md-icon"></span>
 853       Table of contents
 854     </label>
 855     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
 856
 857         <li class="md-nav__item">
 858   <a href="#uiscreen" class="md-nav__link">
 859     Ui/Screen
 860   </a>
 861
 862     <nav class="md-nav" aria-label="Ui/Screen">
 863       <ul class="md-nav__list">
 864
 865           <li class="md-nav__item">
 866   <a href="#supported-aliases" class="md-nav__link">
 867     Supported Aliases
 868   </a>
 869
 870 </li>
 871
 872           <li class="md-nav__item">
 873   <a href="#onquery-string-callbacks-object-string" class="md-nav__link">
 874     on(query: string, callbacks: Object): string
 875   </a>
 876
 877 </li>
 878
 879           <li class="md-nav__item">
 880   <a href="#removequery-string-uuid-string" class="md-nav__link">
 881     remove(query: string, uuid: string)
 882   </a>
 883
 884 </li>
 885
 886           <li class="md-nav__item">
 887   <a href="#isquery-string-boolean" class="md-nav__link">
 888     is(query: string): boolean
 889   </a>
 890
 891 </li>
 892
 893           <li class="md-nav__item">
 894   <a href="#scrolldisable" class="md-nav__link">
 895     scrollDisable()
 896   </a>
 897
 898 </li>
 899
 900           <li class="md-nav__item">
 901   <a href="#scrollenable" class="md-nav__link">
 902     scrollEnable()
 903   </a>
 904
 905 </li>
 906
 907       </ul>
 908     </nav>
 909
 910 </li>
 911
 912         <li class="md-nav__item">
 913   <a href="#environment" class="md-nav__link">
 914     Environment
 915   </a>
 916
 917     <nav class="md-nav" aria-label="Environment">
 918       <ul class="md-nav__list">
 919
 920           <li class="md-nav__item">
 921   <a href="#browser-string" class="md-nav__link">
 922     browser(): string
 923   </a>
 924
 925 </li>
 926
 927           <li class="md-nav__item">
 928   <a href="#platform-string" class="md-nav__link">
 929     platform(): string
 930   </a>
 931
 932 </li>
 933
 934       </ul>
 935     </nav>
 936
 937 </li>
 938
 939     </ul>
 940
 941 </nav>
 942
 943     </li>
 944
 945
 946
 947
 948
 949
 950
 951     <li class="md-nav__item">
 952       <a href="../new-api_ui/" class="md-nav__link">
 953         User Interface
 954       </a>
 955     </li>
 956
 957
 958
 959         </ul>
 960       </nav>
 961     </li>
 962
 963
 964
 965
 966
 967
 968
 969     <li class="md-nav__item">
 970       <a href="../legacy-api/" class="md-nav__link">
 971         Legacy API
 972       </a>
 973     </li>
 974
 975
 976
 977
 978
 979
 980
 981     <li class="md-nav__item">
 982       <a href="../helper-functions/" class="md-nav__link">
 983         Helper Functions
 984       </a>
 985     </li>
 986
 987
 988
 989
 990
 991
 992
 993     <li class="md-nav__item">
 994       <a href="../code-snippets/" class="md-nav__link">
 995         Code Snippets
 996       </a>
 997     </li>
 998
 999
1000
1001         </ul>
1002       </nav>
1003     </li>
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015     <li class="md-nav__item md-nav__item--nested">
1016
1017
1018         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" >
1019
1020       <label class="md-nav__link" for="__nav_5">
1021         Package Components
1022         <span class="md-nav__icon md-icon"></span>
1023       </label>
1024       <nav class="md-nav" aria-label="Package Components" data-md-level="1">
1025         <label class="md-nav__title" for="__nav_5">
1026           <span class="md-nav__icon md-icon"></span>
1027           Package Components
1028         </label>
1029         <ul class="md-nav__list" data-md-scrollfix>
1030
1031
1032
1033
1034
1035     <li class="md-nav__item">
1036       <a href="../../package/package-xml/" class="md-nav__link">
1037         package.xml
1038       </a>
1039     </li>
1040
1041
1042
1043
1044
1045
1046
1047
1048     <li class="md-nav__item md-nav__item--nested">
1049
1050
1051         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_2" type="checkbox" id="__nav_5_2" >
1052
1053       <label class="md-nav__link" for="__nav_5_2">
1054         PIPs
1055         <span class="md-nav__icon md-icon"></span>
1056       </label>
1057       <nav class="md-nav" aria-label="PIPs" data-md-level="2">
1058         <label class="md-nav__title" for="__nav_5_2">
1059           <span class="md-nav__icon md-icon"></span>
1060           PIPs
1061         </label>
1062         <ul class="md-nav__list" data-md-scrollfix>
1063
1064
1065
1066
1067
1068     <li class="md-nav__item">
1069       <a href="../../package/pip/" class="md-nav__link">
1070         Overview
1071       </a>
1072     </li>
1073
1074
1075
1076
1077
1078
1079
1080     <li class="md-nav__item">
1081       <a href="../../package/pip/acl-option/" class="md-nav__link">
1082         aclOption
1083       </a>
1084     </li>
1085
1086
1087
1088
1089
1090
1091
1092     <li class="md-nav__item">
1093       <a href="../../package/pip/acp-menu/" class="md-nav__link">
1094         acpMenu
1095       </a>
1096     </li>
1097
1098
1099
1100
1101
1102
1103
1104     <li class="md-nav__item">
1105       <a href="../../package/pip/acp-search-provider/" class="md-nav__link">
1106         acpSearchProvider
1107       </a>
1108     </li>
1109
1110
1111
1112
1113
1114
1115
1116     <li class="md-nav__item">
1117       <a href="../../package/pip/acp-template/" class="md-nav__link">
1118         acpTemplate
1119       </a>
1120     </li>
1121
1122
1123
1124
1125
1126
1127
1128     <li class="md-nav__item">
1129       <a href="../../package/pip/bbcode/" class="md-nav__link">
1130         bbcode
1131       </a>
1132     </li>
1133
1134
1135
1136
1137
1138
1139
1140     <li class="md-nav__item">
1141       <a href="../../package/pip/box/" class="md-nav__link">
1142         box
1143       </a>
1144     </li>
1145
1146
1147
1148
1149
1150
1151
1152     <li class="md-nav__item">
1153       <a href="../../package/pip/clipboard-action/" class="md-nav__link">
1154         clipboardAction
1155       </a>
1156     </li>
1157
1158
1159
1160
1161
1162
1163
1164     <li class="md-nav__item">
1165       <a href="../../package/pip/core-object/" class="md-nav__link">
1166         coreObject
1167       </a>
1168     </li>
1169
1170
1171
1172
1173
1174
1175
1176     <li class="md-nav__item">
1177       <a href="../../package/pip/cronjob/" class="md-nav__link">
1178         cronjob
1179       </a>
1180     </li>
1181
1182
1183
1184
1185
1186
1187
1188     <li class="md-nav__item">
1189       <a href="../../package/pip/database/" class="md-nav__link">
1190         database
1191       </a>
1192     </li>
1193
1194
1195
1196
1197
1198
1199
1200     <li class="md-nav__item">
1201       <a href="../../package/pip/event-listener/" class="md-nav__link">
1202         eventListener
1203       </a>
1204     </li>
1205
1206
1207
1208
1209
1210
1211
1212     <li class="md-nav__item">
1213       <a href="../../package/pip/file/" class="md-nav__link">
1214         file
1215       </a>
1216     </li>
1217
1218
1219
1220
1221
1222
1223
1224     <li class="md-nav__item">
1225       <a href="../../package/pip/language/" class="md-nav__link">
1226         language
1227       </a>
1228     </li>
1229
1230
1231
1232
1233
1234
1235
1236     <li class="md-nav__item">
1237       <a href="../../package/pip/media-provider/" class="md-nav__link">
1238         mediaProvider
1239       </a>
1240     </li>
1241
1242
1243
1244
1245
1246
1247
1248     <li class="md-nav__item">
1249       <a href="../../package/pip/menu/" class="md-nav__link">
1250         menu
1251       </a>
1252     </li>
1253
1254
1255
1256
1257
1258
1259
1260     <li class="md-nav__item">
1261       <a href="../../package/pip/menu-item/" class="md-nav__link">
1262         menuItem
1263       </a>
1264     </li>
1265
1266
1267
1268
1269
1270
1271
1272     <li class="md-nav__item">
1273       <a href="../../package/pip/object-type/" class="md-nav__link">
1274         objectType
1275       </a>
1276     </li>
1277
1278
1279
1280
1281
1282
1283
1284     <li class="md-nav__item">
1285       <a href="../../package/pip/object-type-definition/" class="md-nav__link">
1286         objectTypeDefinition
1287       </a>
1288     </li>
1289
1290
1291
1292
1293
1294
1295
1296     <li class="md-nav__item">
1297       <a href="../../package/pip/option/" class="md-nav__link">
1298         option
1299       </a>
1300     </li>
1301
1302
1303
1304
1305
1306
1307
1308     <li class="md-nav__item">
1309       <a href="../../package/pip/page/" class="md-nav__link">
1310         page
1311       </a>
1312     </li>
1313
1314
1315
1316
1317
1318
1319
1320     <li class="md-nav__item">
1321       <a href="../../package/pip/pip/" class="md-nav__link">
1322         pip
1323       </a>
1324     </li>
1325
1326
1327
1328
1329
1330
1331
1332     <li class="md-nav__item">
1333       <a href="../../package/pip/script/" class="md-nav__link">
1334         script
1335       </a>
1336     </li>
1337
1338
1339
1340
1341
1342
1343
1344     <li class="md-nav__item">
1345       <a href="../../package/pip/smiley/" class="md-nav__link">
1346         smiley
1347       </a>
1348     </li>
1349
1350
1351
1352
1353
1354
1355
1356     <li class="md-nav__item">
1357       <a href="../../package/pip/sql/" class="md-nav__link">
1358         sql
1359       </a>
1360     </li>
1361
1362
1363
1364
1365
1366
1367
1368     <li class="md-nav__item">
1369       <a href="../../package/pip/style/" class="md-nav__link">
1370         style
1371       </a>
1372     </li>
1373
1374
1375
1376
1377
1378
1379
1380     <li class="md-nav__item">
1381       <a href="../../package/pip/template/" class="md-nav__link">
1382         template
1383       </a>
1384     </li>
1385
1386
1387
1388
1389
1390
1391
1392     <li class="md-nav__item">
1393       <a href="../../package/pip/template-listener/" class="md-nav__link">
1394         templateListener
1395       </a>
1396     </li>
1397
1398
1399
1400
1401
1402
1403
1404     <li class="md-nav__item">
1405       <a href="../../package/pip/user-group-option/" class="md-nav__link">
1406         userGroupOption
1407       </a>
1408     </li>
1409
1410
1411
1412
1413
1414
1415
1416     <li class="md-nav__item">
1417       <a href="../../package/pip/user-menu/" class="md-nav__link">
1418         userMenu
1419       </a>
1420     </li>
1421
1422
1423
1424
1425
1426
1427
1428     <li class="md-nav__item">
1429       <a href="../../package/pip/user-notification-event/" class="md-nav__link">
1430         userNotificationEvent
1431       </a>
1432     </li>
1433
1434
1435
1436
1437
1438
1439
1440     <li class="md-nav__item">
1441       <a href="../../package/pip/user-option/" class="md-nav__link">
1442         userOption
1443       </a>
1444     </li>
1445
1446
1447
1448
1449
1450
1451
1452     <li class="md-nav__item">
1453       <a href="../../package/pip/user-profile-menu/" class="md-nav__link">
1454         userProfileMenu
1455       </a>
1456     </li>
1457
1458
1459
1460         </ul>
1461       </nav>
1462     </li>
1463
1464
1465
1466
1467
1468
1469
1470     <li class="md-nav__item">
1471       <a href="../../package/database-php-api/" class="md-nav__link">
1472         Database PHP API
1473       </a>
1474     </li>
1475
1476
1477
1478         </ul>
1479       </nav>
1480     </li>
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492     <li class="md-nav__item md-nav__item--nested">
1493
1494
1495         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" >
1496
1497       <label class="md-nav__link" for="__nav_6">
1498         Migration
1499         <span class="md-nav__icon md-icon"></span>
1500       </label>
1501       <nav class="md-nav" aria-label="Migration" data-md-level="1">
1502         <label class="md-nav__title" for="__nav_6">
1503           <span class="md-nav__icon md-icon"></span>
1504           Migration
1505         </label>
1506         <ul class="md-nav__list" data-md-scrollfix>
1507
1508
1509
1510
1511
1512
1513     <li class="md-nav__item md-nav__item--nested">
1514
1515
1516         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_1" type="checkbox" id="__nav_6_1" >
1517
1518       <label class="md-nav__link" for="__nav_6_1">
1519         Migrating from WSC 5.3
1520         <span class="md-nav__icon md-icon"></span>
1521       </label>
1522       <nav class="md-nav" aria-label="Migrating from WSC 5.3" data-md-level="2">
1523         <label class="md-nav__title" for="__nav_6_1">
1524           <span class="md-nav__icon md-icon"></span>
1525           Migrating from WSC 5.3
1526         </label>
1527         <ul class="md-nav__list" data-md-scrollfix>
1528
1529
1530
1531
1532
1533     <li class="md-nav__item">
1534       <a href="../../migration/wsc53/php/" class="md-nav__link">
1535         PHP API
1536       </a>
1537     </li>
1538
1539
1540
1541
1542
1543
1544
1545     <li class="md-nav__item">
1546       <a href="../../migration/wsc53/session/" class="md-nav__link">
1547         Session Handling and Authentication
1548       </a>
1549     </li>
1550
1551
1552
1553
1554
1555
1556
1557     <li class="md-nav__item">
1558       <a href="../../migration/wsc53/javascript/" class="md-nav__link">
1559         TypeScript and JavaScript
1560       </a>
1561     </li>
1562
1563
1564
1565
1566
1567
1568
1569     <li class="md-nav__item">
1570       <a href="../../migration/wsc53/templates/" class="md-nav__link">
1571         Templates
1572       </a>
1573     </li>
1574
1575
1576
1577
1578
1579
1580
1581     <li class="md-nav__item">
1582       <a href="../../migration/wsc53/libraries/" class="md-nav__link">
1583         Third Party Libraries
1584       </a>
1585     </li>
1586
1587
1588
1589         </ul>
1590       </nav>
1591     </li>
1592
1593
1594
1595
1596
1597
1598
1599
1600     <li class="md-nav__item md-nav__item--nested">
1601
1602
1603         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_2" type="checkbox" id="__nav_6_2" >
1604
1605       <label class="md-nav__link" for="__nav_6_2">
1606         Migrating from WSC 5.2
1607         <span class="md-nav__icon md-icon"></span>
1608       </label>
1609       <nav class="md-nav" aria-label="Migrating from WSC 5.2" data-md-level="2">
1610         <label class="md-nav__title" for="__nav_6_2">
1611           <span class="md-nav__icon md-icon"></span>
1612           Migrating from WSC 5.2
1613         </label>
1614         <ul class="md-nav__list" data-md-scrollfix>
1615
1616
1617
1618
1619
1620     <li class="md-nav__item">
1621       <a href="../../migration/wsc52/php/" class="md-nav__link">
1622         PHP API
1623       </a>
1624     </li>
1625
1626
1627
1628
1629
1630
1631
1632     <li class="md-nav__item">
1633       <a href="../../migration/wsc52/templates/" class="md-nav__link">
1634         Templates and Languages
1635       </a>
1636     </li>
1637
1638
1639
1640
1641
1642
1643
1644     <li class="md-nav__item">
1645       <a href="../../migration/wsc52/libraries/" class="md-nav__link">
1646         Third Party Libraries
1647       </a>
1648     </li>
1649
1650
1651
1652         </ul>
1653       </nav>
1654     </li>
1655
1656
1657
1658
1659
1660
1661
1662
1663     <li class="md-nav__item md-nav__item--nested">
1664
1665
1666         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_3" type="checkbox" id="__nav_6_3" >
1667
1668       <label class="md-nav__link" for="__nav_6_3">
1669         Migrating from WSC 3.1
1670         <span class="md-nav__icon md-icon"></span>
1671       </label>
1672       <nav class="md-nav" aria-label="Migrating from WSC 3.1" data-md-level="2">
1673         <label class="md-nav__title" for="__nav_6_3">
1674           <span class="md-nav__icon md-icon"></span>
1675           Migrating from WSC 3.1
1676         </label>
1677         <ul class="md-nav__list" data-md-scrollfix>
1678
1679
1680
1681
1682
1683     <li class="md-nav__item">
1684       <a href="../../migration/wsc31/php/" class="md-nav__link">
1685         PHP API
1686       </a>
1687     </li>
1688
1689
1690
1691         </ul>
1692       </nav>
1693     </li>
1694
1695
1696
1697
1698
1699
1700
1701
1702     <li class="md-nav__item md-nav__item--nested">
1703
1704
1705         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_4" type="checkbox" id="__nav_6_4" >
1706
1707       <label class="md-nav__link" for="__nav_6_4">
1708         Migrating from WSC 3.0
1709         <span class="md-nav__icon md-icon"></span>
1710       </label>
1711       <nav class="md-nav" aria-label="Migrating from WSC 3.0" data-md-level="2">
1712         <label class="md-nav__title" for="__nav_6_4">
1713           <span class="md-nav__icon md-icon"></span>
1714           Migrating from WSC 3.0
1715         </label>
1716         <ul class="md-nav__list" data-md-scrollfix>
1717
1718
1719
1720
1721
1722     <li class="md-nav__item">
1723       <a href="../../migration/wsc30/php/" class="md-nav__link">
1724         PHP API
1725       </a>
1726     </li>
1727
1728
1729
1730
1731
1732
1733
1734     <li class="md-nav__item">
1735       <a href="../../migration/wsc30/javascript/" class="md-nav__link">
1736         JavaScript API
1737       </a>
1738     </li>
1739
1740
1741
1742
1743
1744
1745
1746     <li class="md-nav__item">
1747       <a href="../../migration/wsc30/templates/" class="md-nav__link">
1748         Templates
1749       </a>
1750     </li>
1751
1752
1753
1754
1755
1756
1757
1758     <li class="md-nav__item">
1759       <a href="../../migration/wsc30/css/" class="md-nav__link">
1760         CSS
1761       </a>
1762     </li>
1763
1764
1765
1766
1767
1768
1769
1770     <li class="md-nav__item">
1771       <a href="../../migration/wsc30/package/" class="md-nav__link">
1772         Package Components
1773       </a>
1774     </li>
1775
1776
1777
1778         </ul>
1779       </nav>
1780     </li>
1781
1782
1783
1784
1785
1786
1787
1788
1789     <li class="md-nav__item md-nav__item--nested">
1790
1791
1792         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_5" type="checkbox" id="__nav_6_5" >
1793
1794       <label class="md-nav__link" for="__nav_6_5">
1795         Migrating from WCF 2.1
1796         <span class="md-nav__icon md-icon"></span>
1797       </label>
1798       <nav class="md-nav" aria-label="Migrating from WCF 2.1" data-md-level="2">
1799         <label class="md-nav__title" for="__nav_6_5">
1800           <span class="md-nav__icon md-icon"></span>
1801           Migrating from WCF 2.1
1802         </label>
1803         <ul class="md-nav__list" data-md-scrollfix>
1804
1805
1806
1807
1808
1809     <li class="md-nav__item">
1810       <a href="../../migration/wcf21/php/" class="md-nav__link">
1811         PHP API
1812       </a>
1813     </li>
1814
1815
1816
1817
1818
1819
1820
1821     <li class="md-nav__item">
1822       <a href="../../migration/wcf21/templates/" class="md-nav__link">
1823         Templates
1824       </a>
1825     </li>
1826
1827
1828
1829
1830
1831
1832
1833     <li class="md-nav__item">
1834       <a href="../../migration/wcf21/css/" class="md-nav__link">
1835         CSS
1836       </a>
1837     </li>
1838
1839
1840
1841
1842
1843
1844
1845     <li class="md-nav__item">
1846       <a href="../../migration/wcf21/package/" class="md-nav__link">
1847         Package Components
1848       </a>
1849     </li>
1850
1851
1852
1853         </ul>
1854       </nav>
1855     </li>
1856
1857
1858
1859         </ul>
1860       </nav>
1861     </li>
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873     <li class="md-nav__item md-nav__item--nested">
1874
1875
1876         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >
1877
1878       <label class="md-nav__link" for="__nav_7">
1879         Tutorials
1880         <span class="md-nav__icon md-icon"></span>
1881       </label>
1882       <nav class="md-nav" aria-label="Tutorials" data-md-level="1">
1883         <label class="md-nav__title" for="__nav_7">
1884           <span class="md-nav__icon md-icon"></span>
1885           Tutorials
1886         </label>
1887         <ul class="md-nav__list" data-md-scrollfix>
1888
1889
1890
1891
1892
1893
1894     <li class="md-nav__item md-nav__item--nested">
1895
1896
1897         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7_1" type="checkbox" id="__nav_7_1" >
1898
1899       <label class="md-nav__link" for="__nav_7_1">
1900         Tutorial Series
1901         <span class="md-nav__icon md-icon"></span>
1902       </label>
1903       <nav class="md-nav" aria-label="Tutorial Series" data-md-level="2">
1904         <label class="md-nav__title" for="__nav_7_1">
1905           <span class="md-nav__icon md-icon"></span>
1906           Tutorial Series
1907         </label>
1908         <ul class="md-nav__list" data-md-scrollfix>
1909
1910
1911
1912
1913
1914     <li class="md-nav__item">
1915       <a href="../../tutorial/series/overview/" class="md-nav__link">
1916         Overview
1917       </a>
1918     </li>
1919
1920
1921
1922
1923
1924
1925
1926     <li class="md-nav__item">
1927       <a href="../../tutorial/series/part_1/" class="md-nav__link">
1928         Part 1
1929       </a>
1930     </li>
1931
1932
1933
1934
1935
1936
1937
1938     <li class="md-nav__item">
1939       <a href="../../tutorial/series/part_2/" class="md-nav__link">
1940         Part 2
1941       </a>
1942     </li>
1943
1944
1945
1946
1947
1948
1949
1950     <li class="md-nav__item">
1951       <a href="../../tutorial/series/part_3/" class="md-nav__link">
1952         Part 3
1953       </a>
1954     </li>
1955
1956
1957
1958         </ul>
1959       </nav>
1960     </li>
1961
1962
1963
1964         </ul>
1965       </nav>
1966     </li>
1967
1968
1969
1970   </ul>
1971 </nav>
1972                   </div>
1973                 </div>
1974               </div>
1975
1976
1977
1978               <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
1979                 <div class="md-sidebar__scrollwrap">
1980                   <div class="md-sidebar__inner">
1981
1982 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
1983
1984
1985
1986
1987
1988     <label class="md-nav__title" for="__toc">
1989       <span class="md-nav__icon md-icon"></span>
1990       Table of contents
1991     </label>
1992     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
1993
1994         <li class="md-nav__item">
1995   <a href="#uiscreen" class="md-nav__link">
1996     Ui/Screen
1997   </a>
1998
1999     <nav class="md-nav" aria-label="Ui/Screen">
2000       <ul class="md-nav__list">
2001
2002           <li class="md-nav__item">
2003   <a href="#supported-aliases" class="md-nav__link">
2004     Supported Aliases
2005   </a>
2006
2007 </li>
2008
2009           <li class="md-nav__item">
2010   <a href="#onquery-string-callbacks-object-string" class="md-nav__link">
2011     on(query: string, callbacks: Object): string
2012   </a>
2013
2014 </li>
2015
2016           <li class="md-nav__item">
2017   <a href="#removequery-string-uuid-string" class="md-nav__link">
2018     remove(query: string, uuid: string)
2019   </a>
2020
2021 </li>
2022
2023           <li class="md-nav__item">
2024   <a href="#isquery-string-boolean" class="md-nav__link">
2025     is(query: string): boolean
2026   </a>
2027
2028 </li>
2029
2030           <li class="md-nav__item">
2031   <a href="#scrolldisable" class="md-nav__link">
2032     scrollDisable()
2033   </a>
2034
2035 </li>
2036
2037           <li class="md-nav__item">
2038   <a href="#scrollenable" class="md-nav__link">
2039     scrollEnable()
2040   </a>
2041
2042 </li>
2043
2044       </ul>
2045     </nav>
2046
2047 </li>
2048
2049         <li class="md-nav__item">
2050   <a href="#environment" class="md-nav__link">
2051     Environment
2052   </a>
2053
2054     <nav class="md-nav" aria-label="Environment">
2055       <ul class="md-nav__list">
2056
2057           <li class="md-nav__item">
2058   <a href="#browser-string" class="md-nav__link">
2059     browser(): string
2060   </a>
2061
2062 </li>
2063
2064           <li class="md-nav__item">
2065   <a href="#platform-string" class="md-nav__link">
2066     platform(): string
2067   </a>
2068
2069 </li>
2070
2071       </ul>
2072     </nav>
2073
2074 </li>
2075
2076     </ul>
2077
2078 </nav>
2079                   </div>
2080                 </div>
2081               </div>
2082
2083
2084           <div class="md-content" data-md-component="content">
2085             <article class="md-content__inner md-typeset">
2086
2087
2088                   <a href="https://github.com/WoltLab/docs.woltlab.com/edit/5.4/docs/javascript/new-api_browser.md" title="Edit this page" class="md-content__button md-icon">
2089                     <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>
2090                   </a>
2091
2092
2093                 <h1 id="browser-and-screen-sizes-javascript-api">Browser and Screen Sizes - JavaScript API<a class="headerlink" href="#browser-and-screen-sizes-javascript-api" title="Permanent link">#</a></h1>
2094 <h2 id="uiscreen"><code>Ui/Screen</code><a class="headerlink" href="#uiscreen" title="Permanent link">#</a></h2>
2095 <p>CSS offers powerful media queries that alter the layout depending on the screen
2096 sizes, including but not limited to changes between landscape and portrait mode
2097 on mobile devices.</p>
2098 <p>The <code>Ui/Screen</code> module exposes a consistent interface to execute JavaScript code
2099 based on the same media queries that are available in the CSS code already. It
2100 features support for unmatching and executing code when a rule matches for the
2101 first time during the page lifecycle.</p>
2102 <h3 id="supported-aliases">Supported Aliases<a class="headerlink" href="#supported-aliases" title="Permanent link">#</a></h3>
2103 <p>You can pass in custom media queries, but it is strongly recommended to use the
2104 built-in media queries that match the same dimensions as your CSS.</p>
2105 <table>
2106 <thead>
2107 <tr>
2108 <th>Alias</th>
2109 <th>Media Query</th>
2110 </tr>
2111 </thead>
2112 <tbody>
2113 <tr>
2114 <td><code>screen-xs</code></td>
2115 <td><code>(max-width: 544px)</code></td>
2116 </tr>
2117 <tr>
2118 <td><code>screen-sm</code></td>
2119 <td><code>(min-width: 545px) and (max-width: 768px)</code></td>
2120 </tr>
2121 <tr>
2122 <td><code>screen-sm-down</code></td>
2123 <td><code>(max-width: 768px)</code></td>
2124 </tr>
2125 <tr>
2126 <td><code>screen-sm-up</code></td>
2127 <td><code>(min-width: 545px)</code></td>
2128 </tr>
2129 <tr>
2130 <td><code>screen-sm-md</code></td>
2131 <td><code>(min-width: 545px) and (max-width: 1024px)</code></td>
2132 </tr>
2133 <tr>
2134 <td><code>screen-md</code></td>
2135 <td><code>(min-width: 769px) and (max-width: 1024px)</code></td>
2136 </tr>
2137 <tr>
2138 <td><code>screen-md-down</code></td>
2139 <td><code>(max-width: 1024px)</code></td>
2140 </tr>
2141 <tr>
2142 <td><code>screen-md-up</code></td>
2143 <td><code>(min-width: 769px)</code></td>
2144 </tr>
2145 <tr>
2146 <td><code>screen-lg</code></td>
2147 <td><code>(min-width: 1025px)</code></td>
2148 </tr>
2149 </tbody>
2150 </table>
2151 <h3 id="onquery-string-callbacks-object-string"><code>on(query: string, callbacks: Object): string</code><a class="headerlink" href="#onquery-string-callbacks-object-string" title="Permanent link">#</a></h3>
2152 <p>Registers a set of callback functions for the provided media query, the possible
2153 keys are <code>match</code>, <code>unmatch</code> and <code>setup</code>. The method returns a randomly generated
2154 UUIDv4 that is used to identify these callbacks and allows them to be removed
2155 via <code>.remove()</code>.</p>
2156 <h3 id="removequery-string-uuid-string"><code>remove(query: string, uuid: string)</code><a class="headerlink" href="#removequery-string-uuid-string" title="Permanent link">#</a></h3>
2157 <p>Removes all callbacks for a media query that match the UUIDv4 that was previously
2158 obtained from the call to <code>.on()</code>.</p>
2159 <h3 id="isquery-string-boolean"><code>is(query: string): boolean</code><a class="headerlink" href="#isquery-string-boolean" title="Permanent link">#</a></h3>
2160 <p>Tests if the provided media query currently matches and returns true on match.</p>
2161 <h3 id="scrolldisable"><code>scrollDisable()</code><a class="headerlink" href="#scrolldisable" title="Permanent link">#</a></h3>
2162 <p>Temporarily prevents the page from being scrolled, until <code>.scrollEnable()</code> is
2163 called.</p>
2164 <h3 id="scrollenable"><code>scrollEnable()</code><a class="headerlink" href="#scrollenable" title="Permanent link">#</a></h3>
2165 <p>Enables page scrolling again, unless another pending action has also prevented
2166 the page scrolling.</p>
2167 <h2 id="environment"><code>Environment</code><a class="headerlink" href="#environment" title="Permanent link">#</a></h2>
2168 <div class="admonition warning">
2169 <p class="admonition-title">The <code>Environment</code> module uses a mixture of feature detection and user agent sniffing to determine the browser and platform. In general, its results have proven to be very accurate, but it should be taken with a grain of salt regardless. Especially the browser checks are designed to be your last resort, please use feature detection instead whenever it is possible!</p>
2170 </div>
2171 <p>Sometimes it may be necessary to alter the behavior of your code depending on
2172 the browser platform (e. g. mobile devices) or based on a specific browser in
2173 order to work-around some quirks.</p>
2174 <h3 id="browser-string"><code>browser(): string</code><a class="headerlink" href="#browser-string" title="Permanent link">#</a></h3>
2175 <p>Attempts to detect browsers based on their technology and supported CSS vendor
2176 prefixes, and although somewhat reliable for major browsers, it is highly
2177 recommended to use feature detection instead.</p>
2178 <p>Possible values:
2179  - <code>chrome</code> (includes Opera 15+ and Vivaldi)
2180  - <code>firefox</code>
2181  - <code>safari</code>
2182  - <code>microsoft</code> (Internet Explorer and Edge)
2183  - <code>other</code> (default)</p>
2184 <h3 id="platform-string"><code>platform(): string</code><a class="headerlink" href="#platform-string" title="Permanent link">#</a></h3>
2185 <p>Attempts to detect the browser platform using user agent sniffing.</p>
2186 <p>Possible values:
2187  - <code>ios</code>
2188  - <code>android</code>
2189  - <code>windows</code> (IE Mobile)
2190  - <code>mobile</code> (generic mobile device)
2191  - <code>desktop</code> (default)</p>
2192
2193
2194
2195
2196 <hr>
2197 <div class="md-source-date">
2198   <small>
2199
2200       Last update: 2021-01-08
2201
2202   </small>
2203 </div>
2204
2205
2206
2207
2208
2209
2210
2211
2212             </article>
2213           </div>
2214         </div>
2215
2216       </main>
2217
2218
2219 <footer class="md-footer">
2220
2221     <nav class="md-footer__inner md-grid" aria-label="Footer">
2222
2223         <a href="../new-api_dialogs/" class="md-footer__link md-footer__link--prev" rel="prev">
2224           <div class="md-footer__button md-icon">
2225             <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>
2226           </div>
2227           <div class="md-footer__title">
2228             <div class="md-ellipsis">
2229               <span class="md-footer__direction">
2230                 Previous
2231               </span>
2232               Dialogs
2233             </div>
2234           </div>
2235         </a>
2236
2237
2238         <a href="../new-api_ui/" class="md-footer__link md-footer__link--next" rel="next">
2239           <div class="md-footer__title">
2240             <div class="md-ellipsis">
2241               <span class="md-footer__direction">
2242                 Next
2243               </span>
2244               User Interface
2245             </div>
2246           </div>
2247           <div class="md-footer__button md-icon">
2248             <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>
2249           </div>
2250         </a>
2251
2252     </nav>
2253
2254   <div class="md-footer-meta md-typeset">
2255     <div class="md-footer-meta__inner md-grid">
2256       <div class="md-footer-copyright">
2257
2258           <div class="md-footer-copyright__highlight">
2259             Copyright © 2020 WoltLab GmbH
2260           </div>
2261
2262         Made with
2263         <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
2264           Material for MkDocs
2265         </a>
2266
2267       </div>
2268       <div class="md-footer-copyright">
2269         <a href="https://www.woltlab.com/legal-notice/">Legal Notice</a>
2270         <a href="https://www.woltlab.com/privacy-policy/">Privacy Policy</a>
2271 </div>
2272     </div>
2273   </div>
2274 </footer>
2275
2276     </div>
2277     <div class="md-dialog" data-md-component="dialog">
2278       <div class="md-dialog__inner md-typeset"></div>
2279     </div>
2280     <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>
2281
2282
2283       <script src="../../assets/javascripts/bundle.d892486b.min.js"></script>
2284
2285
2286   </body>
2287 </html>