3 <html lang=
"en" class=
"no-js">
7 <meta name=
"viewport" content=
"width=device-width,initial-scale=1">
12 <link rel=
"shortcut icon" href=
"../../assets/default.favicon.ico">
13 <meta name=
"generator" content=
"mkdocs-1.1.2, mkdocs-material-7.0.5">
17 <title>Event Handling - WoltLab Suite Documentation
</title>
21 <link rel=
"stylesheet" href=
"../../assets/stylesheets/main.77f3fd56.min.css">
24 <link rel=
"stylesheet" href=
"../../assets/stylesheets/palette.7fa14f5b.min.css">
28 <meta name=
"theme-color" content=
"#009485">
37 <link rel=
"stylesheet" href=
"../../stylesheets/extra.css">
51 <body dir=
"ltr" data-md-color-scheme=
"" data-md-color-primary=
"teal" data-md-color-accent=
"">
55 <input class=
"md-toggle" data-md-toggle=
"drawer" type=
"checkbox" id=
"__drawer" autocomplete=
"off">
56 <input class=
"md-toggle" data-md-toggle=
"search" type=
"checkbox" id=
"__search" autocomplete=
"off">
57 <label class=
"md-overlay" for=
"__drawer"></label>
58 <div data-md-component=
"skip">
61 <a href=
"#event-handling-javascript-api" class=
"md-skip">
66 <div data-md-component=
"announce">
68 <aside class=
"md-announce">
69 <div class=
"md-announce__inner md-grid md-typeset">
71 <a href=
"https://www.woltlab.com">Back to
<strong>woltlab.com
</strong></a>
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">
84 <img src=
"../../assets/logo.png" alt=
"logo">
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>
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
97 <div class=
"md-header__topic" data-md-component=
"header-topic">
98 <span class=
"md-ellipsis">
106 <div class=
"md-header__options">
110 <label class=
"md-header__button md-icon" for=
"__search">
111 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
114 <div class=
"md-search" data-md-component=
"search" role=
"dialog">
115 <label class=
"md-search__overlay" for=
"__search"></label>
116 <div class=
"md-search__inner" role=
"search">
117 <form class=
"md-search__form" name=
"search">
118 <input type=
"text" class=
"md-search__input" name=
"query" aria-label=
"Search" placeholder=
"Search" autocapitalize=
"off" autocorrect=
"off" autocomplete=
"off" spellcheck=
"false" data-md-component=
"search-query" data-md-state=
"active" required
>
119 <label class=
"md-search__icon md-icon" for=
"__search">
120 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
121 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
123 <button type=
"reset" class=
"md-search__icon md-icon" aria-label=
"Clear" tabindex=
"-1">
124 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M19 6.41L17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41z"/></svg>
127 <div class=
"md-search__output">
128 <div class=
"md-search__scrollwrap" data-md-scrollfix
>
129 <div class=
"md-search-result" data-md-component=
"search-result">
130 <div class=
"md-search-result__meta">
133 <ol class=
"md-search-result__list"></ol>
144 <div class=
"md-container" data-md-component=
"container">
149 <main class=
"md-main" data-md-component=
"main">
150 <div class=
"md-main__inner md-grid">
154 <div class=
"md-sidebar md-sidebar--primary" data-md-component=
"sidebar" data-md-type=
"navigation" >
155 <div class=
"md-sidebar__scrollwrap">
156 <div class=
"md-sidebar__inner">
162 <nav class=
"md-nav md-nav--primary" aria-label=
"Navigation" data-md-level=
"0">
163 <label class=
"md-nav__title" for=
"__drawer">
164 <a href=
"../.." title=
"WoltLab Suite Documentation" class=
"md-nav__button md-logo" aria-label=
"WoltLab Suite Documentation">
166 <img src=
"../../assets/logo.png" alt=
"logo">
169 WoltLab Suite Documentation
172 <ul class=
"md-nav__list" data-md-scrollfix
>
181 <li class=
"md-nav__item">
182 <a href=
"../../getting-started/" class=
"md-nav__link">
197 <li class=
"md-nav__item md-nav__item--nested">
200 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2" type=
"checkbox" id=
"__nav_2" >
202 <label class=
"md-nav__link" for=
"__nav_2">
204 <span class=
"md-nav__icon md-icon"></span>
206 <nav class=
"md-nav" aria-label=
"PHP API" data-md-level=
"1">
207 <label class=
"md-nav__title" for=
"__nav_2">
208 <span class=
"md-nav__icon md-icon"></span>
211 <ul class=
"md-nav__list" data-md-scrollfix
>
217 <li class=
"md-nav__item">
218 <a href=
"../../php/pages/" class=
"md-nav__link">
229 <li class=
"md-nav__item">
230 <a href=
"../../php/database-objects/" class=
"md-nav__link">
241 <li class=
"md-nav__item">
242 <a href=
"../../php/database-access/" class=
"md-nav__link">
253 <li class=
"md-nav__item">
254 <a href=
"../../php/exceptions/" class=
"md-nav__link">
266 <li class=
"md-nav__item md-nav__item--nested">
269 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5" type=
"checkbox" id=
"__nav_2_5" >
271 <label class=
"md-nav__link" for=
"__nav_2_5">
273 <span class=
"md-nav__icon md-icon"></span>
275 <nav class=
"md-nav" aria-label=
"API" data-md-level=
"2">
276 <label class=
"md-nav__title" for=
"__nav_2_5">
277 <span class=
"md-nav__icon md-icon"></span>
280 <ul class=
"md-nav__list" data-md-scrollfix
>
286 <li class=
"md-nav__item">
287 <a href=
"../../php/api/caches/" class=
"md-nav__link">
298 <li class=
"md-nav__item">
299 <a href=
"../../php/api/comments/" class=
"md-nav__link">
310 <li class=
"md-nav__item">
311 <a href=
"../../php/api/cronjobs/" class=
"md-nav__link">
322 <li class=
"md-nav__item">
323 <a href=
"../../php/api/events/" class=
"md-nav__link">
335 <li class=
"md-nav__item md-nav__item--nested">
338 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5_5" type=
"checkbox" id=
"__nav_2_5_5" >
340 <label class=
"md-nav__link" for=
"__nav_2_5_5">
342 <span class=
"md-nav__icon md-icon"></span>
344 <nav class=
"md-nav" aria-label=
"Form Builder" data-md-level=
"3">
345 <label class=
"md-nav__title" for=
"__nav_2_5_5">
346 <span class=
"md-nav__icon md-icon"></span>
349 <ul class=
"md-nav__list" data-md-scrollfix
>
355 <li class=
"md-nav__item">
356 <a href=
"../../php/api/form_builder/overview/" class=
"md-nav__link">
367 <li class=
"md-nav__item">
368 <a href=
"../../php/api/form_builder/structure/" class=
"md-nav__link">
379 <li class=
"md-nav__item">
380 <a href=
"../../php/api/form_builder/form_fields/" class=
"md-nav__link">
391 <li class=
"md-nav__item">
392 <a href=
"../../php/api/form_builder/validation_data/" class=
"md-nav__link">
403 <li class=
"md-nav__item">
404 <a href=
"../../php/api/form_builder/dependencies/" class=
"md-nav__link">
421 <li class=
"md-nav__item">
422 <a href=
"../../php/api/package_installation_plugins/" class=
"md-nav__link">
423 Package Installation Plugins
433 <li class=
"md-nav__item">
434 <a href=
"../../php/api/user_activity_points/" class=
"md-nav__link">
445 <li class=
"md-nav__item">
446 <a href=
"../../php/api/user_notifications/" class=
"md-nav__link">
457 <li class=
"md-nav__item">
458 <a href=
"../../php/api/sitemaps/" class=
"md-nav__link">
475 <li class=
"md-nav__item">
476 <a href=
"../../php/code-style/" class=
"md-nav__link">
487 <li class=
"md-nav__item">
488 <a href=
"../../php/apps/" class=
"md-nav__link">
499 <li class=
"md-nav__item">
500 <a href=
"../../php/gdpr/" class=
"md-nav__link">
521 <li class=
"md-nav__item md-nav__item--nested">
524 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_3" type=
"checkbox" id=
"__nav_3" >
526 <label class=
"md-nav__link" for=
"__nav_3">
527 Languages, Templates & CSS
528 <span class=
"md-nav__icon md-icon"></span>
530 <nav class=
"md-nav" aria-label=
"Languages, Templates & CSS" data-md-level=
"1">
531 <label class=
"md-nav__title" for=
"__nav_3">
532 <span class=
"md-nav__icon md-icon"></span>
533 Languages, Templates & CSS
535 <ul class=
"md-nav__list" data-md-scrollfix
>
541 <li class=
"md-nav__item">
542 <a href=
"../../view/languages/" class=
"md-nav__link">
553 <li class=
"md-nav__item">
554 <a href=
"../../view/templates/" class=
"md-nav__link">
565 <li class=
"md-nav__item">
566 <a href=
"../../view/css/" class=
"md-nav__link">
589 <li class=
"md-nav__item md-nav__item--active md-nav__item--nested">
592 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4" type=
"checkbox" id=
"__nav_4" checked
>
594 <label class=
"md-nav__link" for=
"__nav_4">
596 <span class=
"md-nav__icon md-icon"></span>
598 <nav class=
"md-nav" aria-label=
"JavaScript API" data-md-level=
"1">
599 <label class=
"md-nav__title" for=
"__nav_4">
600 <span class=
"md-nav__icon md-icon"></span>
603 <ul class=
"md-nav__list" data-md-scrollfix
>
609 <li class=
"md-nav__item">
610 <a href=
"../general-usage/" class=
"md-nav__link">
624 <li class=
"md-nav__item md-nav__item--active md-nav__item--nested">
627 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4_2" type=
"checkbox" id=
"__nav_4_2" checked
>
629 <label class=
"md-nav__link" for=
"__nav_4_2">
631 <span class=
"md-nav__icon md-icon"></span>
633 <nav class=
"md-nav" aria-label=
"New API" data-md-level=
"2">
634 <label class=
"md-nav__title" for=
"__nav_4_2">
635 <span class=
"md-nav__icon md-icon"></span>
638 <ul class=
"md-nav__list" data-md-scrollfix
>
644 <li class=
"md-nav__item">
645 <a href=
"../new-api_writing-a-module/" class=
"md-nav__link">
656 <li class=
"md-nav__item">
657 <a href=
"../new-api_data-structures/" class=
"md-nav__link">
668 <li class=
"md-nav__item">
669 <a href=
"../new-api_core/" class=
"md-nav__link">
680 <li class=
"md-nav__item">
681 <a href=
"../new-api_dom/" class=
"md-nav__link">
694 <li class=
"md-nav__item md-nav__item--active">
696 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"toc" type=
"checkbox" id=
"__toc">
701 <label class=
"md-nav__link md-nav__link--active" for=
"__toc">
703 <span class=
"md-nav__icon md-icon"></span>
706 <a href=
"./" class=
"md-nav__link md-nav__link--active">
711 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
717 <label class=
"md-nav__title" for=
"__toc">
718 <span class=
"md-nav__icon md-icon"></span>
721 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
723 <li class=
"md-nav__item">
724 <a href=
"#eventkey" class=
"md-nav__link">
728 <nav class=
"md-nav" aria-label=
"EventKey">
729 <ul class=
"md-nav__list">
731 <li class=
"md-nav__item">
732 <a href=
"#arrowdownevent-keyboardevent-boolean" class=
"md-nav__link">
733 ArrowDown(event: KeyboardEvent): boolean
738 <li class=
"md-nav__item">
739 <a href=
"#arrowleftevent-keyboardevent-boolean" class=
"md-nav__link">
740 ArrowLeft(event: KeyboardEvent): boolean
745 <li class=
"md-nav__item">
746 <a href=
"#arrowrightevent-keyboardevent-boolean" class=
"md-nav__link">
747 ArrowRight(event: KeyboardEvent): boolean
752 <li class=
"md-nav__item">
753 <a href=
"#arrowupevent-keyboardevent-boolean" class=
"md-nav__link">
754 ArrowUp(event: KeyboardEvent): boolean
759 <li class=
"md-nav__item">
760 <a href=
"#commaevent-keyboardevent-boolean" class=
"md-nav__link">
761 Comma(event: KeyboardEvent): boolean
766 <li class=
"md-nav__item">
767 <a href=
"#enterevent-keyboardevent-boolean" class=
"md-nav__link">
768 Enter(event: KeyboardEvent): boolean
773 <li class=
"md-nav__item">
774 <a href=
"#escapeevent-keyboardevent-boolean" class=
"md-nav__link">
775 Escape(event: KeyboardEvent): boolean
780 <li class=
"md-nav__item">
781 <a href=
"#tabevent-keyboardevent-boolean" class=
"md-nav__link">
782 Tab(event: KeyboardEvent): boolean
792 <li class=
"md-nav__item">
793 <a href=
"#eventhandler" class=
"md-nav__link">
797 <nav class=
"md-nav" aria-label=
"EventHandler">
798 <ul class=
"md-nav__list">
800 <li class=
"md-nav__item">
801 <a href=
"#identifiying-events-with-the-developer-tools" class=
"md-nav__link">
802 Identifiying Events with the Developer Tools
807 <li class=
"md-nav__item">
808 <a href=
"#addidentifier-string-action-string-callback-data-object-void-string" class=
"md-nav__link">
809 add(identifier: string, action: string, callback: (data: Object) =
> void): string
814 <li class=
"md-nav__item">
815 <a href=
"#fireidentifier-string-action-string-data-object" class=
"md-nav__link">
816 fire(identifier: string, action: string, data?: Object)
821 <li class=
"md-nav__item">
822 <a href=
"#removeidentifier-string-action-string-uuid-string" class=
"md-nav__link">
823 remove(identifier: string, action: string, uuid: string)
828 <li class=
"md-nav__item">
829 <a href=
"#removeallidentifier-string-action-string" class=
"md-nav__link">
830 removeAll(identifier: string, action: string)
835 <li class=
"md-nav__item">
836 <a href=
"#removeallbysuffixidentifier-string-suffix-string" class=
"md-nav__link">
837 removeAllBySuffix(identifier: string, suffix: string)
859 <li class=
"md-nav__item">
860 <a href=
"../new-api_ajax/" class=
"md-nav__link">
871 <li class=
"md-nav__item">
872 <a href=
"../new-api_dialogs/" class=
"md-nav__link">
883 <li class=
"md-nav__item">
884 <a href=
"../new-api_browser/" class=
"md-nav__link">
885 Browser and Screen Sizes
895 <li class=
"md-nav__item">
896 <a href=
"../new-api_ui/" class=
"md-nav__link">
913 <li class=
"md-nav__item">
914 <a href=
"../legacy-api/" class=
"md-nav__link">
925 <li class=
"md-nav__item">
926 <a href=
"../helper-functions/" class=
"md-nav__link">
937 <li class=
"md-nav__item">
938 <a href=
"../code-snippets/" class=
"md-nav__link">
959 <li class=
"md-nav__item md-nav__item--nested">
962 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5" type=
"checkbox" id=
"__nav_5" >
964 <label class=
"md-nav__link" for=
"__nav_5">
966 <span class=
"md-nav__icon md-icon"></span>
968 <nav class=
"md-nav" aria-label=
"Package Components" data-md-level=
"1">
969 <label class=
"md-nav__title" for=
"__nav_5">
970 <span class=
"md-nav__icon md-icon"></span>
973 <ul class=
"md-nav__list" data-md-scrollfix
>
979 <li class=
"md-nav__item">
980 <a href=
"../../package/package-xml/" class=
"md-nav__link">
992 <li class=
"md-nav__item md-nav__item--nested">
995 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5_2" type=
"checkbox" id=
"__nav_5_2" >
997 <label class=
"md-nav__link" for=
"__nav_5_2">
999 <span class=
"md-nav__icon md-icon"></span>
1001 <nav class=
"md-nav" aria-label=
"PIPs" data-md-level=
"2">
1002 <label class=
"md-nav__title" for=
"__nav_5_2">
1003 <span class=
"md-nav__icon md-icon"></span>
1006 <ul class=
"md-nav__list" data-md-scrollfix
>
1012 <li class=
"md-nav__item">
1013 <a href=
"../../package/pip/" class=
"md-nav__link">
1024 <li class=
"md-nav__item">
1025 <a href=
"../../package/pip/acl-option/" class=
"md-nav__link">
1036 <li class=
"md-nav__item">
1037 <a href=
"../../package/pip/acp-menu/" class=
"md-nav__link">
1048 <li class=
"md-nav__item">
1049 <a href=
"../../package/pip/acp-search-provider/" class=
"md-nav__link">
1060 <li class=
"md-nav__item">
1061 <a href=
"../../package/pip/acp-template/" class=
"md-nav__link">
1072 <li class=
"md-nav__item">
1073 <a href=
"../../package/pip/bbcode/" class=
"md-nav__link">
1084 <li class=
"md-nav__item">
1085 <a href=
"../../package/pip/box/" class=
"md-nav__link">
1096 <li class=
"md-nav__item">
1097 <a href=
"../../package/pip/clipboard-action/" class=
"md-nav__link">
1108 <li class=
"md-nav__item">
1109 <a href=
"../../package/pip/core-object/" class=
"md-nav__link">
1120 <li class=
"md-nav__item">
1121 <a href=
"../../package/pip/cronjob/" class=
"md-nav__link">
1132 <li class=
"md-nav__item">
1133 <a href=
"../../package/pip/event-listener/" class=
"md-nav__link">
1144 <li class=
"md-nav__item">
1145 <a href=
"../../package/pip/file/" class=
"md-nav__link">
1156 <li class=
"md-nav__item">
1157 <a href=
"../../package/pip/language/" class=
"md-nav__link">
1168 <li class=
"md-nav__item">
1169 <a href=
"../../package/pip/media-provider/" class=
"md-nav__link">
1180 <li class=
"md-nav__item">
1181 <a href=
"../../package/pip/menu/" class=
"md-nav__link">
1192 <li class=
"md-nav__item">
1193 <a href=
"../../package/pip/menu-item/" class=
"md-nav__link">
1204 <li class=
"md-nav__item">
1205 <a href=
"../../package/pip/object-type/" class=
"md-nav__link">
1216 <li class=
"md-nav__item">
1217 <a href=
"../../package/pip/object-type-definition/" class=
"md-nav__link">
1218 objectTypeDefinition
1228 <li class=
"md-nav__item">
1229 <a href=
"../../package/pip/option/" class=
"md-nav__link">
1240 <li class=
"md-nav__item">
1241 <a href=
"../../package/pip/page/" class=
"md-nav__link">
1252 <li class=
"md-nav__item">
1253 <a href=
"../../package/pip/pip/" class=
"md-nav__link">
1264 <li class=
"md-nav__item">
1265 <a href=
"../../package/pip/script/" class=
"md-nav__link">
1276 <li class=
"md-nav__item">
1277 <a href=
"../../package/pip/smiley/" class=
"md-nav__link">
1288 <li class=
"md-nav__item">
1289 <a href=
"../../package/pip/sql/" class=
"md-nav__link">
1300 <li class=
"md-nav__item">
1301 <a href=
"../../package/pip/style/" class=
"md-nav__link">
1312 <li class=
"md-nav__item">
1313 <a href=
"../../package/pip/template/" class=
"md-nav__link">
1324 <li class=
"md-nav__item">
1325 <a href=
"../../package/pip/template-listener/" class=
"md-nav__link">
1336 <li class=
"md-nav__item">
1337 <a href=
"../../package/pip/user-group-option/" class=
"md-nav__link">
1348 <li class=
"md-nav__item">
1349 <a href=
"../../package/pip/user-menu/" class=
"md-nav__link">
1360 <li class=
"md-nav__item">
1361 <a href=
"../../package/pip/user-notification-event/" class=
"md-nav__link">
1362 userNotificationEvent
1372 <li class=
"md-nav__item">
1373 <a href=
"../../package/pip/user-option/" class=
"md-nav__link">
1384 <li class=
"md-nav__item">
1385 <a href=
"../../package/pip/user-profile-menu/" class=
"md-nav__link">
1402 <li class=
"md-nav__item">
1403 <a href=
"../../package/database-php-api/" class=
"md-nav__link">
1424 <li class=
"md-nav__item md-nav__item--nested">
1427 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6" type=
"checkbox" id=
"__nav_6" >
1429 <label class=
"md-nav__link" for=
"__nav_6">
1431 <span class=
"md-nav__icon md-icon"></span>
1433 <nav class=
"md-nav" aria-label=
"Migration" data-md-level=
"1">
1434 <label class=
"md-nav__title" for=
"__nav_6">
1435 <span class=
"md-nav__icon md-icon"></span>
1438 <ul class=
"md-nav__list" data-md-scrollfix
>
1445 <li class=
"md-nav__item md-nav__item--nested">
1448 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_1" type=
"checkbox" id=
"__nav_6_1" >
1450 <label class=
"md-nav__link" for=
"__nav_6_1">
1451 Migrating from WSC
5.3
1452 <span class=
"md-nav__icon md-icon"></span>
1454 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.3" data-md-level=
"2">
1455 <label class=
"md-nav__title" for=
"__nav_6_1">
1456 <span class=
"md-nav__icon md-icon"></span>
1457 Migrating from WSC
5.3
1459 <ul class=
"md-nav__list" data-md-scrollfix
>
1465 <li class=
"md-nav__item">
1466 <a href=
"../../migration/wsc53/php/" class=
"md-nav__link">
1477 <li class=
"md-nav__item">
1478 <a href=
"../../migration/wsc53/session/" class=
"md-nav__link">
1479 Session Handling and Authentication
1489 <li class=
"md-nav__item">
1490 <a href=
"../../migration/wsc53/javascript/" class=
"md-nav__link">
1501 <li class=
"md-nav__item">
1502 <a href=
"../../migration/wsc53/templates/" class=
"md-nav__link">
1513 <li class=
"md-nav__item">
1514 <a href=
"../../migration/wsc53/libraries/" class=
"md-nav__link">
1515 Third Party Libraries
1532 <li class=
"md-nav__item md-nav__item--nested">
1535 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_2" type=
"checkbox" id=
"__nav_6_2" >
1537 <label class=
"md-nav__link" for=
"__nav_6_2">
1538 Migrating from WSC
5.2
1539 <span class=
"md-nav__icon md-icon"></span>
1541 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.2" data-md-level=
"2">
1542 <label class=
"md-nav__title" for=
"__nav_6_2">
1543 <span class=
"md-nav__icon md-icon"></span>
1544 Migrating from WSC
5.2
1546 <ul class=
"md-nav__list" data-md-scrollfix
>
1552 <li class=
"md-nav__item">
1553 <a href=
"../../migration/wsc52/php/" class=
"md-nav__link">
1564 <li class=
"md-nav__item">
1565 <a href=
"../../migration/wsc52/templates/" class=
"md-nav__link">
1566 Templates and Languages
1576 <li class=
"md-nav__item">
1577 <a href=
"../../migration/wsc52/libraries/" class=
"md-nav__link">
1578 Third Party Libraries
1595 <li class=
"md-nav__item md-nav__item--nested">
1598 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_3" type=
"checkbox" id=
"__nav_6_3" >
1600 <label class=
"md-nav__link" for=
"__nav_6_3">
1601 Migrating from WSC
3.1
1602 <span class=
"md-nav__icon md-icon"></span>
1604 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.1" data-md-level=
"2">
1605 <label class=
"md-nav__title" for=
"__nav_6_3">
1606 <span class=
"md-nav__icon md-icon"></span>
1607 Migrating from WSC
3.1
1609 <ul class=
"md-nav__list" data-md-scrollfix
>
1615 <li class=
"md-nav__item">
1616 <a href=
"../../migration/wsc31/php/" class=
"md-nav__link">
1634 <li class=
"md-nav__item md-nav__item--nested">
1637 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_4" type=
"checkbox" id=
"__nav_6_4" >
1639 <label class=
"md-nav__link" for=
"__nav_6_4">
1640 Migrating from WSC
3.0
1641 <span class=
"md-nav__icon md-icon"></span>
1643 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.0" data-md-level=
"2">
1644 <label class=
"md-nav__title" for=
"__nav_6_4">
1645 <span class=
"md-nav__icon md-icon"></span>
1646 Migrating from WSC
3.0
1648 <ul class=
"md-nav__list" data-md-scrollfix
>
1654 <li class=
"md-nav__item">
1655 <a href=
"../../migration/wsc30/php/" class=
"md-nav__link">
1666 <li class=
"md-nav__item">
1667 <a href=
"../../migration/wsc30/javascript/" class=
"md-nav__link">
1678 <li class=
"md-nav__item">
1679 <a href=
"../../migration/wsc30/templates/" class=
"md-nav__link">
1690 <li class=
"md-nav__item">
1691 <a href=
"../../migration/wsc30/css/" class=
"md-nav__link">
1702 <li class=
"md-nav__item">
1703 <a href=
"../../migration/wsc30/package/" class=
"md-nav__link">
1721 <li class=
"md-nav__item md-nav__item--nested">
1724 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_5" type=
"checkbox" id=
"__nav_6_5" >
1726 <label class=
"md-nav__link" for=
"__nav_6_5">
1727 Migrating from WCF
2.1
1728 <span class=
"md-nav__icon md-icon"></span>
1730 <nav class=
"md-nav" aria-label=
"Migrating from WCF 2.1" data-md-level=
"2">
1731 <label class=
"md-nav__title" for=
"__nav_6_5">
1732 <span class=
"md-nav__icon md-icon"></span>
1733 Migrating from WCF
2.1
1735 <ul class=
"md-nav__list" data-md-scrollfix
>
1741 <li class=
"md-nav__item">
1742 <a href=
"../../migration/wcf21/php/" class=
"md-nav__link">
1753 <li class=
"md-nav__item">
1754 <a href=
"../../migration/wcf21/templates/" class=
"md-nav__link">
1765 <li class=
"md-nav__item">
1766 <a href=
"../../migration/wcf21/css/" class=
"md-nav__link">
1777 <li class=
"md-nav__item">
1778 <a href=
"../../migration/wcf21/package/" class=
"md-nav__link">
1805 <li class=
"md-nav__item md-nav__item--nested">
1808 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7" type=
"checkbox" id=
"__nav_7" >
1810 <label class=
"md-nav__link" for=
"__nav_7">
1812 <span class=
"md-nav__icon md-icon"></span>
1814 <nav class=
"md-nav" aria-label=
"Tutorials" data-md-level=
"1">
1815 <label class=
"md-nav__title" for=
"__nav_7">
1816 <span class=
"md-nav__icon md-icon"></span>
1819 <ul class=
"md-nav__list" data-md-scrollfix
>
1826 <li class=
"md-nav__item md-nav__item--nested">
1829 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7_1" type=
"checkbox" id=
"__nav_7_1" >
1831 <label class=
"md-nav__link" for=
"__nav_7_1">
1833 <span class=
"md-nav__icon md-icon"></span>
1835 <nav class=
"md-nav" aria-label=
"Tutorial Series" data-md-level=
"2">
1836 <label class=
"md-nav__title" for=
"__nav_7_1">
1837 <span class=
"md-nav__icon md-icon"></span>
1840 <ul class=
"md-nav__list" data-md-scrollfix
>
1846 <li class=
"md-nav__item">
1847 <a href=
"../../tutorial/series/overview/" class=
"md-nav__link">
1858 <li class=
"md-nav__item">
1859 <a href=
"../../tutorial/series/part_1/" class=
"md-nav__link">
1870 <li class=
"md-nav__item">
1871 <a href=
"../../tutorial/series/part_2/" class=
"md-nav__link">
1882 <li class=
"md-nav__item">
1883 <a href=
"../../tutorial/series/part_3/" class=
"md-nav__link">
1910 <div class=
"md-sidebar md-sidebar--secondary" data-md-component=
"sidebar" data-md-type=
"toc" >
1911 <div class=
"md-sidebar__scrollwrap">
1912 <div class=
"md-sidebar__inner">
1914 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
1920 <label class=
"md-nav__title" for=
"__toc">
1921 <span class=
"md-nav__icon md-icon"></span>
1924 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
1926 <li class=
"md-nav__item">
1927 <a href=
"#eventkey" class=
"md-nav__link">
1931 <nav class=
"md-nav" aria-label=
"EventKey">
1932 <ul class=
"md-nav__list">
1934 <li class=
"md-nav__item">
1935 <a href=
"#arrowdownevent-keyboardevent-boolean" class=
"md-nav__link">
1936 ArrowDown(event: KeyboardEvent): boolean
1941 <li class=
"md-nav__item">
1942 <a href=
"#arrowleftevent-keyboardevent-boolean" class=
"md-nav__link">
1943 ArrowLeft(event: KeyboardEvent): boolean
1948 <li class=
"md-nav__item">
1949 <a href=
"#arrowrightevent-keyboardevent-boolean" class=
"md-nav__link">
1950 ArrowRight(event: KeyboardEvent): boolean
1955 <li class=
"md-nav__item">
1956 <a href=
"#arrowupevent-keyboardevent-boolean" class=
"md-nav__link">
1957 ArrowUp(event: KeyboardEvent): boolean
1962 <li class=
"md-nav__item">
1963 <a href=
"#commaevent-keyboardevent-boolean" class=
"md-nav__link">
1964 Comma(event: KeyboardEvent): boolean
1969 <li class=
"md-nav__item">
1970 <a href=
"#enterevent-keyboardevent-boolean" class=
"md-nav__link">
1971 Enter(event: KeyboardEvent): boolean
1976 <li class=
"md-nav__item">
1977 <a href=
"#escapeevent-keyboardevent-boolean" class=
"md-nav__link">
1978 Escape(event: KeyboardEvent): boolean
1983 <li class=
"md-nav__item">
1984 <a href=
"#tabevent-keyboardevent-boolean" class=
"md-nav__link">
1985 Tab(event: KeyboardEvent): boolean
1995 <li class=
"md-nav__item">
1996 <a href=
"#eventhandler" class=
"md-nav__link">
2000 <nav class=
"md-nav" aria-label=
"EventHandler">
2001 <ul class=
"md-nav__list">
2003 <li class=
"md-nav__item">
2004 <a href=
"#identifiying-events-with-the-developer-tools" class=
"md-nav__link">
2005 Identifiying Events with the Developer Tools
2010 <li class=
"md-nav__item">
2011 <a href=
"#addidentifier-string-action-string-callback-data-object-void-string" class=
"md-nav__link">
2012 add(identifier: string, action: string, callback: (data: Object) =
> void): string
2017 <li class=
"md-nav__item">
2018 <a href=
"#fireidentifier-string-action-string-data-object" class=
"md-nav__link">
2019 fire(identifier: string, action: string, data?: Object)
2024 <li class=
"md-nav__item">
2025 <a href=
"#removeidentifier-string-action-string-uuid-string" class=
"md-nav__link">
2026 remove(identifier: string, action: string, uuid: string)
2031 <li class=
"md-nav__item">
2032 <a href=
"#removeallidentifier-string-action-string" class=
"md-nav__link">
2033 removeAll(identifier: string, action: string)
2038 <li class=
"md-nav__item">
2039 <a href=
"#removeallbysuffixidentifier-string-suffix-string" class=
"md-nav__link">
2040 removeAllBySuffix(identifier: string, suffix: string)
2058 <div class=
"md-content" data-md-component=
"content">
2059 <article class=
"md-content__inner md-typeset">
2063 <h1 id=
"event-handling-javascript-api">Event Handling - JavaScript API
<a class=
"headerlink" href=
"#event-handling-javascript-api" title=
"Permanent link">#
</a></h1>
2064 <h2 id=
"eventkey"><code>EventKey
</code><a class=
"headerlink" href=
"#eventkey" title=
"Permanent link">#
</a></h2>
2065 <p>This class offers a set of static methods that can be used to determine if some
2066 common keys are being pressed. Internally it compares either the
<code>.key
</code> property
2067 if it is supported or the value of
<code>.which
</code>.
</p>
2068 <div class=
"highlight"><pre><span></span><code><span class=
"nx">require
</span><span class=
"p">([
</span><span class=
"s2">"EventKey
"</span><span class=
"p">],
</span> <span class=
"kd">function
</span><span class=
"p">(
</span><span class=
"nx">EventKey
</span><span class=
"p">)
</span> <span class=
"p">{
</span>
2069 <span class=
"nx">elBySel
</span><span class=
"p">(
</span><span class=
"s2">".some-input
"</span><span class=
"p">).
</span><span class=
"nx">addEventListener
</span><span class=
"p">(
</span><span class=
"s2">"keydown
"</span><span class=
"p">,
</span> <span class=
"kd">function
</span><span class=
"p">(
</span><span class=
"nx">event
</span><span class=
"p">)
</span> <span class=
"p">{
</span>
2070 <span class=
"k">if
</span> <span class=
"p">(
</span><span class=
"nx">EventKey
</span><span class=
"p">.
</span><span class=
"nx">Enter
</span><span class=
"p">(
</span><span class=
"nx">event
</span><span class=
"p">))
</span> <span class=
"p">{
</span>
2071 <span class=
"c1">// the `Enter` key was pressed
</span>
2072 <span class=
"p">}
</span>
2073 <span class=
"p">});
</span>
2074 <span class=
"p">});
</span>
2076 <h3 id=
"arrowdownevent-keyboardevent-boolean"><code>ArrowDown(event: KeyboardEvent): boolean
</code><a class=
"headerlink" href=
"#arrowdownevent-keyboardevent-boolean" title=
"Permanent link">#
</a></h3>
2077 <p>Returns true if the user has pressed the
<code>↓
</code> key.
</p>
2078 <h3 id=
"arrowleftevent-keyboardevent-boolean"><code>ArrowLeft(event: KeyboardEvent): boolean
</code><a class=
"headerlink" href=
"#arrowleftevent-keyboardevent-boolean" title=
"Permanent link">#
</a></h3>
2079 <p>Returns true if the user has pressed the
<code>←
</code> key.
</p>
2080 <h3 id=
"arrowrightevent-keyboardevent-boolean"><code>ArrowRight(event: KeyboardEvent): boolean
</code><a class=
"headerlink" href=
"#arrowrightevent-keyboardevent-boolean" title=
"Permanent link">#
</a></h3>
2081 <p>Returns true if the user has pressed the
<code>→
</code> key.
</p>
2082 <h3 id=
"arrowupevent-keyboardevent-boolean"><code>ArrowUp(event: KeyboardEvent): boolean
</code><a class=
"headerlink" href=
"#arrowupevent-keyboardevent-boolean" title=
"Permanent link">#
</a></h3>
2083 <p>Returns true if the user has pressed the
<code>↑
</code> key.
</p>
2084 <h3 id=
"commaevent-keyboardevent-boolean"><code>Comma(event: KeyboardEvent): boolean
</code><a class=
"headerlink" href=
"#commaevent-keyboardevent-boolean" title=
"Permanent link">#
</a></h3>
2085 <p>Returns true if the user has pressed the
<code>,
</code> key.
</p>
2086 <h3 id=
"enterevent-keyboardevent-boolean"><code>Enter(event: KeyboardEvent): boolean
</code><a class=
"headerlink" href=
"#enterevent-keyboardevent-boolean" title=
"Permanent link">#
</a></h3>
2087 <p>Returns true if the user has pressed the
<code>↲
</code> key.
</p>
2088 <h3 id=
"escapeevent-keyboardevent-boolean"><code>Escape(event: KeyboardEvent): boolean
</code><a class=
"headerlink" href=
"#escapeevent-keyboardevent-boolean" title=
"Permanent link">#
</a></h3>
2089 <p>Returns true if the user has pressed the
<code>Esc
</code> key.
</p>
2090 <h3 id=
"tabevent-keyboardevent-boolean"><code>Tab(event: KeyboardEvent): boolean
</code><a class=
"headerlink" href=
"#tabevent-keyboardevent-boolean" title=
"Permanent link">#
</a></h3>
2091 <p>Returns true if the user has pressed the
<code>↹
</code> key.
</p>
2092 <h2 id=
"eventhandler"><code>EventHandler
</code><a class=
"headerlink" href=
"#eventhandler" title=
"Permanent link">#
</a></h2>
2093 <p>A synchronous event system based on string identifiers rather than DOM elements,
2094 similar to the PHP event system in WoltLab Suite. Any components can listen to
2095 events or trigger events itself at any time.
</p>
2096 <h3 id=
"identifiying-events-with-the-developer-tools">Identifiying Events with the Developer Tools
<a class=
"headerlink" href=
"#identifiying-events-with-the-developer-tools" title=
"Permanent link">#
</a></h3>
2097 <p>The Developer Tools in WoltLab Suite
3.1 offer an easy option to identify existing
2098 events that are fired while code is being executed. You can enable this watch
2099 mode through your browser's console using
<code>Devtools.toggleEventLogging()
</code>:
</p>
2100 <div class=
"highlight"><pre><span></span><code>> Devtools.toggleEventLogging();
2101 < Event logging enabled
2102 < [Devtools.EventLogging] Firing event: bar @ com.example.app.foo
2103 < [Devtools.EventLogging] Firing event: baz @ com.example.app.foo
2105 <h3 id=
"addidentifier-string-action-string-callback-data-object-void-string"><code>add(identifier: string, action: string, callback: (data: Object) =
> void): string
</code><a class=
"headerlink" href=
"#addidentifier-string-action-string-callback-data-object-void-string" title=
"Permanent link">#
</a></h3>
2106 <p>Adding an event listeners returns a randomly generated UUIDv4 that is used to
2107 identify the listener. This UUID is required to remove a specific listener through
2108 the
<code>remove()
</code> method.
</p>
2109 <h3 id=
"fireidentifier-string-action-string-data-object"><code>fire(identifier: string, action: string, data?: Object)
</code><a class=
"headerlink" href=
"#fireidentifier-string-action-string-data-object" title=
"Permanent link">#
</a></h3>
2110 <p>Triggers an event using an optional
<code>data
</code> object that is passed to each listener
2112 <h3 id=
"removeidentifier-string-action-string-uuid-string"><code>remove(identifier: string, action: string, uuid: string)
</code><a class=
"headerlink" href=
"#removeidentifier-string-action-string-uuid-string" title=
"Permanent link">#
</a></h3>
2113 <p>Removes a previously registered event listener using the UUID returned by
<code>add()
</code>.
</p>
2114 <h3 id=
"removeallidentifier-string-action-string"><code>removeAll(identifier: string, action: string)
</code><a class=
"headerlink" href=
"#removeallidentifier-string-action-string" title=
"Permanent link">#
</a></h3>
2115 <p>Removes all event listeners registered for the provided
<code>identifier
</code> and
<code>action
</code>.
</p>
2116 <h3 id=
"removeallbysuffixidentifier-string-suffix-string"><code>removeAllBySuffix(identifier: string, suffix: string)
</code><a class=
"headerlink" href=
"#removeallbysuffixidentifier-string-suffix-string" title=
"Permanent link">#
</a></h3>
2117 <p>Removes all event listeners for an
<code>identifier
</code> whose action ends with the value
2118 of
<code>suffix
</code>.
</p>
2132 <footer class=
"md-footer">
2134 <nav class=
"md-footer__inner md-grid" aria-label=
"Footer">
2136 <a href=
"../new-api_dom/" class=
"md-footer__link md-footer__link--prev" rel=
"prev">
2137 <div class=
"md-footer__button md-icon">
2138 <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>
2140 <div class=
"md-footer__title">
2141 <div class=
"md-ellipsis">
2142 <span class=
"md-footer__direction">
2151 <a href=
"../new-api_ajax/" class=
"md-footer__link md-footer__link--next" rel=
"next">
2152 <div class=
"md-footer__title">
2153 <div class=
"md-ellipsis">
2154 <span class=
"md-footer__direction">
2160 <div class=
"md-footer__button md-icon">
2161 <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>
2167 <div class=
"md-footer-meta md-typeset">
2168 <div class=
"md-footer-meta__inner md-grid">
2169 <div class=
"md-footer-copyright">
2171 <div class=
"md-footer-copyright__highlight">
2172 Copyright ©
2020 WoltLab GmbH
2176 <a href=
"https://squidfunk.github.io/mkdocs-material/" target=
"_blank" rel=
"noopener">
2181 <div class=
"md-footer-copyright">
2182 <a href=
"https://www.woltlab.com/legal-notice/">Legal Notice
</a>
2183 <a href=
"https://www.woltlab.com/privacy-policy/">Privacy Policy
</a>
2190 <div class=
"md-dialog" data-md-component=
"dialog">
2191 <div class=
"md-dialog__inner md-typeset"></div>
2193 <script id=
"__config" type=
"application/json">{
"base":
"../..",
"features": [],
"translations": {
"clipboard.copy":
"Copy to clipboard",
"clipboard.copied":
"Copied to clipboard",
"search.config.lang":
"en",
"search.config.pipeline":
"trimmer, stopWordFilter",
"search.config.separator":
"[\\s\\-]+",
"search.placeholder":
"Search",
"search.result.placeholder":
"Type to start searching",
"search.result.none":
"No matching documents",
"search.result.one":
"1 matching document",
"search.result.other":
"# matching documents",
"search.result.more.one":
"1 more on this page",
"search.result.more.other":
"# more on this page",
"search.result.term.missing":
"Missing"},
"search":
"../../assets/javascripts/workers/search.fb4a9340.min.js",
"version": {
"provider":
"mike"}}
</script>
2196 <script src=
"../../assets/javascripts/bundle.5cf3e710.min.js"></script>