latest/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.2">
  14
  15
  16
  17         <title>Browser and Screen Sizes - WoltLab Suite Documentation</title>
  18
  19
  20
  21       <link rel="stylesheet" href="../../assets/stylesheets/main.6f955dcd.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
 836         <label class="md-nav__link md-nav__link--active" for="__toc">
 837           Browser and Screen Sizes
 838           <span class="md-nav__icon md-icon"></span>
 839         </label>
 840
 841       <a href="./" class="md-nav__link md-nav__link--active">
 842         Browser and Screen Sizes
 843       </a>
 844
 845
 846 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
 847
 848
 849
 850
 851
 852
 853     <label class="md-nav__title" for="__toc">
 854       <span class="md-nav__icon md-icon"></span>
 855       Table of contents
 856     </label>
 857     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
 858
 859         <li class="md-nav__item">
 860   <a href="#uiscreen" class="md-nav__link">
 861     Ui/Screen
 862   </a>
 863
 864     <nav class="md-nav" aria-label="Ui/Screen">
 865       <ul class="md-nav__list">
 866
 867           <li class="md-nav__item">
 868   <a href="#supported-aliases" class="md-nav__link">
 869     Supported Aliases
 870   </a>
 871
 872 </li>
 873
 874           <li class="md-nav__item">
 875   <a href="#onquery-string-callbacks-object-string" class="md-nav__link">
 876     on(query: string, callbacks: Object): string
 877   </a>
 878
 879 </li>
 880
 881           <li class="md-nav__item">
 882   <a href="#removequery-string-uuid-string" class="md-nav__link">
 883     remove(query: string, uuid: string)
 884   </a>
 885
 886 </li>
 887
 888           <li class="md-nav__item">
 889   <a href="#isquery-string-boolean" class="md-nav__link">
 890     is(query: string): boolean
 891   </a>
 892
 893 </li>
 894
 895           <li class="md-nav__item">
 896   <a href="#scrolldisable" class="md-nav__link">
 897     scrollDisable()
 898   </a>
 899
 900 </li>
 901
 902           <li class="md-nav__item">
 903   <a href="#scrollenable" class="md-nav__link">
 904     scrollEnable()
 905   </a>
 906
 907 </li>
 908
 909       </ul>
 910     </nav>
 911
 912 </li>
 913
 914         <li class="md-nav__item">
 915   <a href="#environment" class="md-nav__link">
 916     Environment
 917   </a>
 918
 919     <nav class="md-nav" aria-label="Environment">
 920       <ul class="md-nav__list">
 921
 922           <li class="md-nav__item">
 923   <a href="#browser-string" class="md-nav__link">
 924     browser(): string
 925   </a>
 926
 927 </li>
 928
 929           <li class="md-nav__item">
 930   <a href="#platform-string" class="md-nav__link">
 931     platform(): string
 932   </a>
 933
 934 </li>
 935
 936       </ul>
 937     </nav>
 938
 939 </li>
 940
 941     </ul>
 942
 943 </nav>
 944
 945     </li>
 946
 947
 948
 949
 950
 951
 952
 953     <li class="md-nav__item">
 954       <a href="../new-api_ui/" class="md-nav__link">
 955         User Interface
 956       </a>
 957     </li>
 958
 959
 960
 961         </ul>
 962       </nav>
 963     </li>
 964
 965
 966
 967
 968
 969
 970
 971     <li class="md-nav__item">
 972       <a href="../legacy-api/" class="md-nav__link">
 973         Legacy API
 974       </a>
 975     </li>
 976
 977
 978
 979
 980
 981
 982
 983     <li class="md-nav__item">
 984       <a href="../helper-functions/" class="md-nav__link">
 985         Helper Functions
 986       </a>
 987     </li>
 988
 989
 990
 991
 992
 993
 994
 995     <li class="md-nav__item">
 996       <a href="../code-snippets/" class="md-nav__link">
 997         Code Snippets
 998       </a>
 999     </li>
1000
1001
1002
1003         </ul>
1004       </nav>
1005     </li>
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017     <li class="md-nav__item md-nav__item--nested">
1018
1019
1020         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" >
1021
1022       <label class="md-nav__link" for="__nav_5">
1023         Package Components
1024         <span class="md-nav__icon md-icon"></span>
1025       </label>
1026       <nav class="md-nav" aria-label="Package Components" data-md-level="1">
1027         <label class="md-nav__title" for="__nav_5">
1028           <span class="md-nav__icon md-icon"></span>
1029           Package Components
1030         </label>
1031         <ul class="md-nav__list" data-md-scrollfix>
1032
1033
1034
1035
1036
1037     <li class="md-nav__item">
1038       <a href="../../package/package-xml/" class="md-nav__link">
1039         package.xml
1040       </a>
1041     </li>
1042
1043
1044
1045
1046
1047
1048
1049
1050     <li class="md-nav__item md-nav__item--nested">
1051
1052
1053         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_2" type="checkbox" id="__nav_5_2" >
1054
1055       <label class="md-nav__link" for="__nav_5_2">
1056         PIPs
1057         <span class="md-nav__icon md-icon"></span>
1058       </label>
1059       <nav class="md-nav" aria-label="PIPs" data-md-level="2">
1060         <label class="md-nav__title" for="__nav_5_2">
1061           <span class="md-nav__icon md-icon"></span>
1062           PIPs
1063         </label>
1064         <ul class="md-nav__list" data-md-scrollfix>
1065
1066
1067
1068
1069
1070     <li class="md-nav__item">
1071       <a href="../../package/pip/" class="md-nav__link">
1072         Overview
1073       </a>
1074     </li>
1075
1076
1077
1078
1079
1080
1081
1082     <li class="md-nav__item">
1083       <a href="../../package/pip/acl-option/" class="md-nav__link">
1084         aclOption
1085       </a>
1086     </li>
1087
1088
1089
1090
1091
1092
1093
1094     <li class="md-nav__item">
1095       <a href="../../package/pip/acp-menu/" class="md-nav__link">
1096         acpMenu
1097       </a>
1098     </li>
1099
1100
1101
1102
1103
1104
1105
1106     <li class="md-nav__item">
1107       <a href="../../package/pip/acp-search-provider/" class="md-nav__link">
1108         acpSearchProvider
1109       </a>
1110     </li>
1111
1112
1113
1114
1115
1116
1117
1118     <li class="md-nav__item">
1119       <a href="../../package/pip/acp-template/" class="md-nav__link">
1120         acpTemplate
1121       </a>
1122     </li>
1123
1124
1125
1126
1127
1128
1129
1130     <li class="md-nav__item">
1131       <a href="../../package/pip/bbcode/" class="md-nav__link">
1132         bbcode
1133       </a>
1134     </li>
1135
1136
1137
1138
1139
1140
1141
1142     <li class="md-nav__item">
1143       <a href="../../package/pip/box/" class="md-nav__link">
1144         box
1145       </a>
1146     </li>
1147
1148
1149
1150
1151
1152
1153
1154     <li class="md-nav__item">
1155       <a href="../../package/pip/clipboard-action/" class="md-nav__link">
1156         clipboardAction
1157       </a>
1158     </li>
1159
1160
1161
1162
1163
1164
1165
1166     <li class="md-nav__item">
1167       <a href="../../package/pip/core-object/" class="md-nav__link">
1168         coreObject
1169       </a>
1170     </li>
1171
1172
1173
1174
1175
1176
1177
1178     <li class="md-nav__item">
1179       <a href="../../package/pip/cronjob/" class="md-nav__link">
1180         cronjob
1181       </a>
1182     </li>
1183
1184
1185
1186
1187
1188
1189
1190     <li class="md-nav__item">
1191       <a href="../../package/pip/database/" class="md-nav__link">
1192         database
1193       </a>
1194     </li>
1195
1196
1197
1198
1199
1200
1201
1202     <li class="md-nav__item">
1203       <a href="../../package/pip/event-listener/" class="md-nav__link">
1204         eventListener
1205       </a>
1206     </li>
1207
1208
1209
1210
1211
1212
1213
1214     <li class="md-nav__item">
1215       <a href="../../package/pip/file/" class="md-nav__link">
1216         file
1217       </a>
1218     </li>
1219
1220
1221
1222
1223
1224
1225
1226     <li class="md-nav__item">
1227       <a href="../../package/pip/language/" class="md-nav__link">
1228         language
1229       </a>
1230     </li>
1231
1232
1233
1234
1235
1236
1237
1238     <li class="md-nav__item">
1239       <a href="../../package/pip/media-provider/" class="md-nav__link">
1240         mediaProvider
1241       </a>
1242     </li>
1243
1244
1245
1246
1247
1248
1249
1250     <li class="md-nav__item">
1251       <a href="../../package/pip/menu/" class="md-nav__link">
1252         menu
1253       </a>
1254     </li>
1255
1256
1257
1258
1259
1260
1261
1262     <li class="md-nav__item">
1263       <a href="../../package/pip/menu-item/" class="md-nav__link">
1264         menuItem
1265       </a>
1266     </li>
1267
1268
1269
1270
1271
1272
1273
1274     <li class="md-nav__item">
1275       <a href="../../package/pip/object-type/" class="md-nav__link">
1276         objectType
1277       </a>
1278     </li>
1279
1280
1281
1282
1283
1284
1285
1286     <li class="md-nav__item">
1287       <a href="../../package/pip/object-type-definition/" class="md-nav__link">
1288         objectTypeDefinition
1289       </a>
1290     </li>
1291
1292
1293
1294
1295
1296
1297
1298     <li class="md-nav__item">
1299       <a href="../../package/pip/option/" class="md-nav__link">
1300         option
1301       </a>
1302     </li>
1303
1304
1305
1306
1307
1308
1309
1310     <li class="md-nav__item">
1311       <a href="../../package/pip/page/" class="md-nav__link">
1312         page
1313       </a>
1314     </li>
1315
1316
1317
1318
1319
1320
1321
1322     <li class="md-nav__item">
1323       <a href="../../package/pip/pip/" class="md-nav__link">
1324         pip
1325       </a>
1326     </li>
1327
1328
1329
1330
1331
1332
1333
1334     <li class="md-nav__item">
1335       <a href="../../package/pip/script/" class="md-nav__link">
1336         script
1337       </a>
1338     </li>
1339
1340
1341
1342
1343
1344
1345
1346     <li class="md-nav__item">
1347       <a href="../../package/pip/smiley/" class="md-nav__link">
1348         smiley
1349       </a>
1350     </li>
1351
1352
1353
1354
1355
1356
1357
1358     <li class="md-nav__item">
1359       <a href="../../package/pip/sql/" class="md-nav__link">
1360         sql
1361       </a>
1362     </li>
1363
1364
1365
1366
1367
1368
1369
1370     <li class="md-nav__item">
1371       <a href="../../package/pip/style/" class="md-nav__link">
1372         style
1373       </a>
1374     </li>
1375
1376
1377
1378
1379
1380
1381
1382     <li class="md-nav__item">
1383       <a href="../../package/pip/template/" class="md-nav__link">
1384         template
1385       </a>
1386     </li>
1387
1388
1389
1390
1391
1392
1393
1394     <li class="md-nav__item">
1395       <a href="../../package/pip/template-listener/" class="md-nav__link">
1396         templateListener
1397       </a>
1398     </li>
1399
1400
1401
1402
1403
1404
1405
1406     <li class="md-nav__item">
1407       <a href="../../package/pip/user-group-option/" class="md-nav__link">
1408         userGroupOption
1409       </a>
1410     </li>
1411
1412
1413
1414
1415
1416
1417
1418     <li class="md-nav__item">
1419       <a href="../../package/pip/user-menu/" class="md-nav__link">
1420         userMenu
1421       </a>
1422     </li>
1423
1424
1425
1426
1427
1428
1429
1430     <li class="md-nav__item">
1431       <a href="../../package/pip/user-notification-event/" class="md-nav__link">
1432         userNotificationEvent
1433       </a>
1434     </li>
1435
1436
1437
1438
1439
1440
1441
1442     <li class="md-nav__item">
1443       <a href="../../package/pip/user-option/" class="md-nav__link">
1444         userOption
1445       </a>
1446     </li>
1447
1448
1449
1450
1451
1452
1453
1454     <li class="md-nav__item">
1455       <a href="../../package/pip/user-profile-menu/" class="md-nav__link">
1456         userProfileMenu
1457       </a>
1458     </li>
1459
1460
1461
1462         </ul>
1463       </nav>
1464     </li>
1465
1466
1467
1468
1469
1470
1471
1472     <li class="md-nav__item">
1473       <a href="../../package/database-php-api/" class="md-nav__link">
1474         Database PHP API
1475       </a>
1476     </li>
1477
1478
1479
1480         </ul>
1481       </nav>
1482     </li>
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494     <li class="md-nav__item md-nav__item--nested">
1495
1496
1497         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" >
1498
1499       <label class="md-nav__link" for="__nav_6">
1500         Migration
1501         <span class="md-nav__icon md-icon"></span>
1502       </label>
1503       <nav class="md-nav" aria-label="Migration" data-md-level="1">
1504         <label class="md-nav__title" for="__nav_6">
1505           <span class="md-nav__icon md-icon"></span>
1506           Migration
1507         </label>
1508         <ul class="md-nav__list" data-md-scrollfix>
1509
1510
1511
1512
1513
1514
1515     <li class="md-nav__item md-nav__item--nested">
1516
1517
1518         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_1" type="checkbox" id="__nav_6_1" >
1519
1520       <label class="md-nav__link" for="__nav_6_1">
1521         Migrating from WSC 5.3
1522         <span class="md-nav__icon md-icon"></span>
1523       </label>
1524       <nav class="md-nav" aria-label="Migrating from WSC 5.3" data-md-level="2">
1525         <label class="md-nav__title" for="__nav_6_1">
1526           <span class="md-nav__icon md-icon"></span>
1527           Migrating from WSC 5.3
1528         </label>
1529         <ul class="md-nav__list" data-md-scrollfix>
1530
1531
1532
1533
1534
1535     <li class="md-nav__item">
1536       <a href="../../migration/wsc53/php/" class="md-nav__link">
1537         PHP API
1538       </a>
1539     </li>
1540
1541
1542
1543
1544
1545
1546
1547     <li class="md-nav__item">
1548       <a href="../../migration/wsc53/session/" class="md-nav__link">
1549         Session Handling and Authentication
1550       </a>
1551     </li>
1552
1553
1554
1555
1556
1557
1558
1559     <li class="md-nav__item">
1560       <a href="../../migration/wsc53/javascript/" class="md-nav__link">
1561         TypeScript and JavaScript
1562       </a>
1563     </li>
1564
1565
1566
1567
1568
1569
1570
1571     <li class="md-nav__item">
1572       <a href="../../migration/wsc53/templates/" class="md-nav__link">
1573         Templates
1574       </a>
1575     </li>
1576
1577
1578
1579
1580
1581
1582
1583     <li class="md-nav__item">
1584       <a href="../../migration/wsc53/libraries/" class="md-nav__link">
1585         Third Party Libraries
1586       </a>
1587     </li>
1588
1589
1590
1591         </ul>
1592       </nav>
1593     </li>
1594
1595
1596
1597
1598
1599
1600
1601
1602     <li class="md-nav__item md-nav__item--nested">
1603
1604
1605         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_2" type="checkbox" id="__nav_6_2" >
1606
1607       <label class="md-nav__link" for="__nav_6_2">
1608         Migrating from WSC 5.2
1609         <span class="md-nav__icon md-icon"></span>
1610       </label>
1611       <nav class="md-nav" aria-label="Migrating from WSC 5.2" data-md-level="2">
1612         <label class="md-nav__title" for="__nav_6_2">
1613           <span class="md-nav__icon md-icon"></span>
1614           Migrating from WSC 5.2
1615         </label>
1616         <ul class="md-nav__list" data-md-scrollfix>
1617
1618
1619
1620
1621
1622     <li class="md-nav__item">
1623       <a href="../../migration/wsc52/php/" class="md-nav__link">
1624         PHP API
1625       </a>
1626     </li>
1627
1628
1629
1630
1631
1632
1633
1634     <li class="md-nav__item">
1635       <a href="../../migration/wsc52/templates/" class="md-nav__link">
1636         Templates and Languages
1637       </a>
1638     </li>
1639
1640
1641
1642
1643
1644
1645
1646     <li class="md-nav__item">
1647       <a href="../../migration/wsc52/libraries/" class="md-nav__link">
1648         Third Party Libraries
1649       </a>
1650     </li>
1651
1652
1653
1654         </ul>
1655       </nav>
1656     </li>
1657
1658
1659
1660
1661
1662
1663
1664
1665     <li class="md-nav__item md-nav__item--nested">
1666
1667
1668         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_3" type="checkbox" id="__nav_6_3" >
1669
1670       <label class="md-nav__link" for="__nav_6_3">
1671         Migrating from WSC 3.1
1672         <span class="md-nav__icon md-icon"></span>
1673       </label>
1674       <nav class="md-nav" aria-label="Migrating from WSC 3.1" data-md-level="2">
1675         <label class="md-nav__title" for="__nav_6_3">
1676           <span class="md-nav__icon md-icon"></span>
1677           Migrating from WSC 3.1
1678         </label>
1679         <ul class="md-nav__list" data-md-scrollfix>
1680
1681
1682
1683
1684
1685     <li class="md-nav__item">
1686       <a href="../../migration/wsc31/php/" class="md-nav__link">
1687         PHP API
1688       </a>
1689     </li>
1690
1691
1692
1693         </ul>
1694       </nav>
1695     </li>
1696
1697
1698
1699
1700
1701
1702
1703
1704     <li class="md-nav__item md-nav__item--nested">
1705
1706
1707         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_4" type="checkbox" id="__nav_6_4" >
1708
1709       <label class="md-nav__link" for="__nav_6_4">
1710         Migrating from WSC 3.0
1711         <span class="md-nav__icon md-icon"></span>
1712       </label>
1713       <nav class="md-nav" aria-label="Migrating from WSC 3.0" data-md-level="2">
1714         <label class="md-nav__title" for="__nav_6_4">
1715           <span class="md-nav__icon md-icon"></span>
1716           Migrating from WSC 3.0
1717         </label>
1718         <ul class="md-nav__list" data-md-scrollfix>
1719
1720
1721
1722
1723
1724     <li class="md-nav__item">
1725       <a href="../../migration/wsc30/php/" class="md-nav__link">
1726         PHP API
1727       </a>
1728     </li>
1729
1730
1731
1732
1733
1734
1735
1736     <li class="md-nav__item">
1737       <a href="../../migration/wsc30/javascript/" class="md-nav__link">
1738         JavaScript API
1739       </a>
1740     </li>
1741
1742
1743
1744
1745
1746
1747
1748     <li class="md-nav__item">
1749       <a href="../../migration/wsc30/templates/" class="md-nav__link">
1750         Templates
1751       </a>
1752     </li>
1753
1754
1755
1756
1757
1758
1759
1760     <li class="md-nav__item">
1761       <a href="../../migration/wsc30/css/" class="md-nav__link">
1762         CSS
1763       </a>
1764     </li>
1765
1766
1767
1768
1769
1770
1771
1772     <li class="md-nav__item">
1773       <a href="../../migration/wsc30/package/" class="md-nav__link">
1774         Package Components
1775       </a>
1776     </li>
1777
1778
1779
1780         </ul>
1781       </nav>
1782     </li>
1783
1784
1785
1786
1787
1788
1789
1790
1791     <li class="md-nav__item md-nav__item--nested">
1792
1793
1794         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_5" type="checkbox" id="__nav_6_5" >
1795
1796       <label class="md-nav__link" for="__nav_6_5">
1797         Migrating from WCF 2.1
1798         <span class="md-nav__icon md-icon"></span>
1799       </label>
1800       <nav class="md-nav" aria-label="Migrating from WCF 2.1" data-md-level="2">
1801         <label class="md-nav__title" for="__nav_6_5">
1802           <span class="md-nav__icon md-icon"></span>
1803           Migrating from WCF 2.1
1804         </label>
1805         <ul class="md-nav__list" data-md-scrollfix>
1806
1807
1808
1809
1810
1811     <li class="md-nav__item">
1812       <a href="../../migration/wcf21/php/" class="md-nav__link">
1813         PHP API
1814       </a>
1815     </li>
1816
1817
1818
1819
1820
1821
1822
1823     <li class="md-nav__item">
1824       <a href="../../migration/wcf21/templates/" class="md-nav__link">
1825         Templates
1826       </a>
1827     </li>
1828
1829
1830
1831
1832
1833
1834
1835     <li class="md-nav__item">
1836       <a href="../../migration/wcf21/css/" class="md-nav__link">
1837         CSS
1838       </a>
1839     </li>
1840
1841
1842
1843
1844
1845
1846
1847     <li class="md-nav__item">
1848       <a href="../../migration/wcf21/package/" class="md-nav__link">
1849         Package Components
1850       </a>
1851     </li>
1852
1853
1854
1855         </ul>
1856       </nav>
1857     </li>
1858
1859
1860
1861         </ul>
1862       </nav>
1863     </li>
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875     <li class="md-nav__item md-nav__item--nested">
1876
1877
1878         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >
1879
1880       <label class="md-nav__link" for="__nav_7">
1881         Tutorials
1882         <span class="md-nav__icon md-icon"></span>
1883       </label>
1884       <nav class="md-nav" aria-label="Tutorials" data-md-level="1">
1885         <label class="md-nav__title" for="__nav_7">
1886           <span class="md-nav__icon md-icon"></span>
1887           Tutorials
1888         </label>
1889         <ul class="md-nav__list" data-md-scrollfix>
1890
1891
1892
1893
1894
1895
1896     <li class="md-nav__item md-nav__item--nested">
1897
1898
1899         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7_1" type="checkbox" id="__nav_7_1" >
1900
1901       <label class="md-nav__link" for="__nav_7_1">
1902         Tutorial Series
1903         <span class="md-nav__icon md-icon"></span>
1904       </label>
1905       <nav class="md-nav" aria-label="Tutorial Series" data-md-level="2">
1906         <label class="md-nav__title" for="__nav_7_1">
1907           <span class="md-nav__icon md-icon"></span>
1908           Tutorial Series
1909         </label>
1910         <ul class="md-nav__list" data-md-scrollfix>
1911
1912
1913
1914
1915
1916     <li class="md-nav__item">
1917       <a href="../../tutorial/series/overview/" class="md-nav__link">
1918         Overview
1919       </a>
1920     </li>
1921
1922
1923
1924
1925
1926
1927
1928     <li class="md-nav__item">
1929       <a href="../../tutorial/series/part_1/" class="md-nav__link">
1930         Part 1
1931       </a>
1932     </li>
1933
1934
1935
1936
1937
1938
1939
1940     <li class="md-nav__item">
1941       <a href="../../tutorial/series/part_2/" class="md-nav__link">
1942         Part 2
1943       </a>
1944     </li>
1945
1946
1947
1948
1949
1950
1951
1952     <li class="md-nav__item">
1953       <a href="../../tutorial/series/part_3/" class="md-nav__link">
1954         Part 3
1955       </a>
1956     </li>
1957
1958
1959
1960
1961
1962
1963
1964     <li class="md-nav__item">
1965       <a href="../../tutorial/series/part_4/" class="md-nav__link">
1966         Part 4
1967       </a>
1968     </li>
1969
1970
1971
1972         </ul>
1973       </nav>
1974     </li>
1975
1976
1977
1978         </ul>
1979       </nav>
1980     </li>
1981
1982
1983
1984   </ul>
1985 </nav>
1986                   </div>
1987                 </div>
1988               </div>
1989
1990
1991
1992               <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
1993                 <div class="md-sidebar__scrollwrap">
1994                   <div class="md-sidebar__inner">
1995
1996 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
1997
1998
1999
2000
2001
2002
2003     <label class="md-nav__title" for="__toc">
2004       <span class="md-nav__icon md-icon"></span>
2005       Table of contents
2006     </label>
2007     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
2008
2009         <li class="md-nav__item">
2010   <a href="#uiscreen" class="md-nav__link">
2011     Ui/Screen
2012   </a>
2013
2014     <nav class="md-nav" aria-label="Ui/Screen">
2015       <ul class="md-nav__list">
2016
2017           <li class="md-nav__item">
2018   <a href="#supported-aliases" class="md-nav__link">
2019     Supported Aliases
2020   </a>
2021
2022 </li>
2023
2024           <li class="md-nav__item">
2025   <a href="#onquery-string-callbacks-object-string" class="md-nav__link">
2026     on(query: string, callbacks: Object): string
2027   </a>
2028
2029 </li>
2030
2031           <li class="md-nav__item">
2032   <a href="#removequery-string-uuid-string" class="md-nav__link">
2033     remove(query: string, uuid: string)
2034   </a>
2035
2036 </li>
2037
2038           <li class="md-nav__item">
2039   <a href="#isquery-string-boolean" class="md-nav__link">
2040     is(query: string): boolean
2041   </a>
2042
2043 </li>
2044
2045           <li class="md-nav__item">
2046   <a href="#scrolldisable" class="md-nav__link">
2047     scrollDisable()
2048   </a>
2049
2050 </li>
2051
2052           <li class="md-nav__item">
2053   <a href="#scrollenable" class="md-nav__link">
2054     scrollEnable()
2055   </a>
2056
2057 </li>
2058
2059       </ul>
2060     </nav>
2061
2062 </li>
2063
2064         <li class="md-nav__item">
2065   <a href="#environment" class="md-nav__link">
2066     Environment
2067   </a>
2068
2069     <nav class="md-nav" aria-label="Environment">
2070       <ul class="md-nav__list">
2071
2072           <li class="md-nav__item">
2073   <a href="#browser-string" class="md-nav__link">
2074     browser(): string
2075   </a>
2076
2077 </li>
2078
2079           <li class="md-nav__item">
2080   <a href="#platform-string" class="md-nav__link">
2081     platform(): string
2082   </a>
2083
2084 </li>
2085
2086       </ul>
2087     </nav>
2088
2089 </li>
2090
2091     </ul>
2092
2093 </nav>
2094                   </div>
2095                 </div>
2096               </div>
2097
2098
2099           <div class="md-content" data-md-component="content">
2100             <article class="md-content__inner md-typeset">
2101
2102
2103                   <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">
2104                     <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>
2105                   </a>
2106
2107
2108                 <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>
2109 <h2 id="uiscreen"><code>Ui/Screen</code><a class="headerlink" href="#uiscreen" title="Permanent link">#</a></h2>
2110 <p>CSS offers powerful media queries that alter the layout depending on the screen
2111 sizes, including but not limited to changes between landscape and portrait mode
2112 on mobile devices.</p>
2113 <p>The <code>Ui/Screen</code> module exposes a consistent interface to execute JavaScript code
2114 based on the same media queries that are available in the CSS code already. It
2115 features support for unmatching and executing code when a rule matches for the
2116 first time during the page lifecycle.</p>
2117 <h3 id="supported-aliases">Supported Aliases<a class="headerlink" href="#supported-aliases" title="Permanent link">#</a></h3>
2118 <p>You can pass in custom media queries, but it is strongly recommended to use the
2119 built-in media queries that match the same dimensions as your CSS.</p>
2120 <table>
2121 <thead>
2122 <tr>
2123 <th>Alias</th>
2124 <th>Media Query</th>
2125 </tr>
2126 </thead>
2127 <tbody>
2128 <tr>
2129 <td><code>screen-xs</code></td>
2130 <td><code>(max-width: 544px)</code></td>
2131 </tr>
2132 <tr>
2133 <td><code>screen-sm</code></td>
2134 <td><code>(min-width: 545px) and (max-width: 768px)</code></td>
2135 </tr>
2136 <tr>
2137 <td><code>screen-sm-down</code></td>
2138 <td><code>(max-width: 768px)</code></td>
2139 </tr>
2140 <tr>
2141 <td><code>screen-sm-up</code></td>
2142 <td><code>(min-width: 545px)</code></td>
2143 </tr>
2144 <tr>
2145 <td><code>screen-sm-md</code></td>
2146 <td><code>(min-width: 545px) and (max-width: 1024px)</code></td>
2147 </tr>
2148 <tr>
2149 <td><code>screen-md</code></td>
2150 <td><code>(min-width: 769px) and (max-width: 1024px)</code></td>
2151 </tr>
2152 <tr>
2153 <td><code>screen-md-down</code></td>
2154 <td><code>(max-width: 1024px)</code></td>
2155 </tr>
2156 <tr>
2157 <td><code>screen-md-up</code></td>
2158 <td><code>(min-width: 769px)</code></td>
2159 </tr>
2160 <tr>
2161 <td><code>screen-lg</code></td>
2162 <td><code>(min-width: 1025px)</code></td>
2163 </tr>
2164 </tbody>
2165 </table>
2166 <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>
2167 <p>Registers a set of callback functions for the provided media query, the possible
2168 keys are <code>match</code>, <code>unmatch</code> and <code>setup</code>. The method returns a randomly generated
2169 UUIDv4 that is used to identify these callbacks and allows them to be removed
2170 via <code>.remove()</code>.</p>
2171 <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>
2172 <p>Removes all callbacks for a media query that match the UUIDv4 that was previously
2173 obtained from the call to <code>.on()</code>.</p>
2174 <h3 id="isquery-string-boolean"><code>is(query: string): boolean</code><a class="headerlink" href="#isquery-string-boolean" title="Permanent link">#</a></h3>
2175 <p>Tests if the provided media query currently matches and returns true on match.</p>
2176 <h3 id="scrolldisable"><code>scrollDisable()</code><a class="headerlink" href="#scrolldisable" title="Permanent link">#</a></h3>
2177 <p>Temporarily prevents the page from being scrolled, until <code>.scrollEnable()</code> is
2178 called.</p>
2179 <h3 id="scrollenable"><code>scrollEnable()</code><a class="headerlink" href="#scrollenable" title="Permanent link">#</a></h3>
2180 <p>Enables page scrolling again, unless another pending action has also prevented
2181 the page scrolling.</p>
2182 <h2 id="environment"><code>Environment</code><a class="headerlink" href="#environment" title="Permanent link">#</a></h2>
2183 <div class="admonition warning">
2184 <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>
2185 </div>
2186 <p>Sometimes it may be necessary to alter the behavior of your code depending on
2187 the browser platform (e. g. mobile devices) or based on a specific browser in
2188 order to work-around some quirks.</p>
2189 <h3 id="browser-string"><code>browser(): string</code><a class="headerlink" href="#browser-string" title="Permanent link">#</a></h3>
2190 <p>Attempts to detect browsers based on their technology and supported CSS vendor
2191 prefixes, and although somewhat reliable for major browsers, it is highly
2192 recommended to use feature detection instead.</p>
2193 <p>Possible values:
2194  - <code>chrome</code> (includes Opera 15+ and Vivaldi)
2195  - <code>firefox</code>
2196  - <code>safari</code>
2197  - <code>microsoft</code> (Internet Explorer and Edge)
2198  - <code>other</code> (default)</p>
2199 <h3 id="platform-string"><code>platform(): string</code><a class="headerlink" href="#platform-string" title="Permanent link">#</a></h3>
2200 <p>Attempts to detect the browser platform using user agent sniffing.</p>
2201 <p>Possible values:
2202  - <code>ios</code>
2203  - <code>android</code>
2204  - <code>windows</code> (IE Mobile)
2205  - <code>mobile</code> (generic mobile device)
2206  - <code>desktop</code> (default)</p>
2207
2208
2209
2210
2211 <hr>
2212 <div class="md-source-date">
2213   <small>
2214
2215       Last update: 2021-01-08
2216
2217   </small>
2218 </div>
2219
2220
2221
2222
2223
2224
2225
2226
2227             </article>
2228           </div>
2229         </div>
2230
2231       </main>
2232
2233
2234 <footer class="md-footer">
2235
2236     <nav class="md-footer__inner md-grid" aria-label="Footer">
2237
2238         <a href="../new-api_dialogs/" class="md-footer__link md-footer__link--prev" rel="prev">
2239           <div class="md-footer__button md-icon">
2240             <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>
2241           </div>
2242           <div class="md-footer__title">
2243             <div class="md-ellipsis">
2244               <span class="md-footer__direction">
2245                 Previous
2246               </span>
2247               Dialogs
2248             </div>
2249           </div>
2250         </a>
2251
2252
2253         <a href="../new-api_ui/" class="md-footer__link md-footer__link--next" rel="next">
2254           <div class="md-footer__title">
2255             <div class="md-ellipsis">
2256               <span class="md-footer__direction">
2257                 Next
2258               </span>
2259               User Interface
2260             </div>
2261           </div>
2262           <div class="md-footer__button md-icon">
2263             <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>
2264           </div>
2265         </a>
2266
2267     </nav>
2268
2269   <div class="md-footer-meta md-typeset">
2270     <div class="md-footer-meta__inner md-grid">
2271       <div class="md-footer-copyright">
2272
2273           <div class="md-footer-copyright__highlight">
2274             Copyright © 2020 WoltLab GmbH
2275           </div>
2276
2277         Made with
2278         <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
2279           Material for MkDocs
2280         </a>
2281
2282       </div>
2283       <div class="md-footer-copyright">
2284         <a href="https://www.woltlab.com/legal-notice/">Legal Notice</a>
2285         <a href="https://www.woltlab.com/privacy-policy/">Privacy Policy</a>
2286 </div>
2287     </div>
2288   </div>
2289 </footer>
2290
2291     </div>
2292     <div class="md-dialog" data-md-component="dialog">
2293       <div class="md-dialog__inner md-typeset"></div>
2294     </div>
2295     <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>
2296
2297
2298       <script src="../../assets/javascripts/bundle.4ea5477f.min.js"></script>
2299
2300
2301   </body>
2302 </html>