JavaScript/jQuery Popup - Keyboard Support
An end user can use the following keys to interact with the UI component.
Key | Action |
---|---|
↑ → ↓ ← | Drags the popup when it is focused and dragEnabled is true. |
Esc | Closes the popup. |
You can implement a custom handler for a key using the registerKeyHandler(key, handler) method.
jQuery
JavaScript
function registerKeyHandlers () { const popup = $("#popupContainer").dxPopup("instance"); popup.registerKeyHandler("backspace", function(e) { // The argument "e" contains information on the event }); popup.registerKeyHandler("space", function(e) { // ... }); }
Angular
TypeScript
import { ..., ViewChild, AfterViewInit } from '@angular/core'; import { DxPopupModule, DxPopupComponent } from 'devextreme-angular'; // ... export class AppComponent implements AfterViewInit { @ViewChild(DxPopupComponent, { static: false }) popup: DxPopupComponent; // Prior to Angular 8 // @ViewChild(DxPopupComponent) popup: DxPopupComponent; ngAfterViewInit () { this.popup.instance.registerKeyHandler('backspace', function(e) { // The argument "e" contains information on the event }); this.popup.instance.registerKeyHandler('space', function(e) { // ... }); } } @NgModule({ imports: [ // ... DxPopupModule ], // ... })
Vue
<template> <DxPopup :ref="myPopupRef" /> </template> <script> import 'devextreme/dist/css/dx.light.css'; import DxPopup from 'devextreme-vue/popup'; const myPopupRef = 'my-popup'; export default { components: { DxPopup }, data() { return { myPopupRef } }, computed: { popup: function() { return this.$refs[myPopupRef].instance; } }, mounted: function() { this.popup.registerKeyHandler('backspace', function(e) { // The argument "e" contains information on the event }); this.popup.registerKeyHandler('space', function(e) { // ... }); } } </script>
React
App.js
import React from 'react'; import 'devextreme/dist/css/dx.light.css'; import { Popup } from 'devextreme-react/popup'; class App extends React.Component { constructor(props) { super(props); this.popupRef = React.createRef(); } render() { return ( <Popup ref={this.popupRef} /> ); } get popup() { return this.popupRef.current.instance; } componentDidMount() { this.popup.registerKeyHandler('backspace', function(e) { // The argument "e" contains information on the event }); this.popup.registerKeyHandler('space', function(e) { // ... }); } } export default App;
See Also
Feel free to share topic-related thoughts here.
If you have technical questions, please create a support ticket in the DevExpress Support Center.
Thank you for the feedback!
If you have technical questions, please create a support ticket in the DevExpress Support Center.