JavaScript/jQuery Button - Keyboard Support
An end user can use the following keys to interact with the UI component.
| Key | Action |
|---|---|
| Enter or Space | Identical to a click. |
You can implement a custom handler for a key using the registerKeyHandler(key, handler) method.
jQuery
JavaScript
function registerKeyHandlers () {
const button = $("#buttonContainer").dxButton("instance");
button.registerKeyHandler("backspace", function(e) {
// The argument "e" contains information on the event
});
button.registerKeyHandler("space", function(e) {
// ...
});
}Angular
TypeScript
import { ..., ViewChild, AfterViewInit } from '@angular/core';
import { DxButtonModule, DxButtonComponent } from 'devextreme-angular';
// ...
export class AppComponent implements AfterViewInit {
@ViewChild(DxButtonComponent, { static: false }) button: DxButtonComponent;
// Prior to Angular 8
// @ViewChild(DxButtonComponent) button: DxButtonComponent;
ngAfterViewInit () {
this.button.instance.registerKeyHandler('backspace', function(e) {
// The argument "e" contains information on the event
});
this.button.instance.registerKeyHandler('space', function(e) {
// ...
});
}
}
@NgModule({
imports: [
// ...
DxButtonModule
],
// ...
})Vue
<template>
<DxButton :ref="myButtonRef" />
</template>
<script>
import 'devextreme/dist/css/dx.light.css';
import DxButton from 'devextreme-vue/button';
const myButtonRef = 'my-button';
export default {
components: {
DxButton
},
data() {
return {
myButtonRef
}
},
computed: {
button: function() {
return this.$refs[myButtonRef].instance;
}
},
mounted: function() {
this.button.registerKeyHandler('backspace', function(e) {
// The argument "e" contains information on the event
});
this.button.registerKeyHandler('space', function(e) {
// ...
});
}
}
</script>React
App.js
import React from 'react';
import 'devextreme/dist/css/dx.light.css';
import { Button } from 'devextreme-react/button';
class App extends React.Component {
constructor(props) {
super(props);
this.buttonRef = React.createRef();
}
render() {
return (
<Button ref={this.buttonRef} />
);
}
get button() {
return this.buttonRef.current.instance;
}
componentDidMount() {
this.button.registerKeyHandler('backspace', function(e) {
// The argument "e" contains information on the event
});
this.button.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.