DevExtreme jQuery/JS - Keyboard Support
An end user can use the following keys to interact with the widget.
| Key | Action |
|---|---|
| ← | Moves focus to the previous item. |
| → | Moves focus to the next item. |
You can implement a custom handler for a key using the registerKeyHandler(key, handler) method.
jQuery
JavaScript
function registerKeyHandlers () {
const navBar = $("#navBarContainer").dxNavBar("instance");
navBar.registerKeyHandler("backspace", function(e) {
// The argument "e" contains information on the event
});
navBar.registerKeyHandler("space", function(e) {
// ...
});
}Angular
TypeScript
import { ..., ViewChild, AfterViewInit } from '@angular/core';
import { DxNavBarModule, DxNavBarComponent } from 'devextreme-angular';
// ...
export class AppComponent implements AfterViewInit {
@ViewChild(DxNavBarComponent, { static: false }) navBar: DxNavBarComponent;
// Prior to Angular 8
// @ViewChild(DxNavBarComponent) navBar: DxNavBarComponent;
ngAfterViewInit () {
this.navBar.instance.registerKeyHandler('backspace', function(e) {
// The argument "e" contains information on the event
});
this.navBar.instance.registerKeyHandler('space', function(e) {
// ...
});
}
}
@NgModule({
imports: [
// ...
DxNavBarModule
],
// ...
})Vue
<template>
<DxNavBar :ref="myNavBarRef" />
</template>
<script>
import 'devextreme/dist/css/dx.common.css';
import 'devextreme/dist/css/dx.light.css';
import DxNavBar from 'devextreme-vue/nav-bar';
const myNavBarRef = 'my-nav-bar';
export default {
components: {
DxNavBar
},
data() {
return {
myNavBarRef
}
},
computed: {
navBar: function() {
return this.$refs[myNavBarRef].instance;
}
},
mounted: function() {
this.navBar.registerKeyHandler('backspace', function(e) {
// The argument "e" contains information on the event
});
this.navBar.registerKeyHandler('space', function(e) {
// ...
});
}
}
</script>React
App.js
import React from 'react';
import 'devextreme/dist/css/dx.common.css';
import 'devextreme/dist/css/dx.light.css';
import { NavBar } from 'devextreme-react/nav-bar';
class App extends React.Component {
constructor(props) {
super(props);
this.navBarRef = React.createRef();
}
render() {
return (
<NavBar ref={this.navBarRef} />
);
}
get navBar() {
return this.navBarRef.current.instance;
}
componentDidMount() {
this.navBar.registerKeyHandler('backspace', function(e) {
// The argument "e" contains information on the event
});
this.navBar.registerKeyHandler('space', function(e) {
// ...
});
}
}
export default App;See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
- NavBar Demos
- NavBar API Reference
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.