JavaScript/jQuery NumberBox - Keyboard Support
An end user can use the following keys to interact with the UI component.
| Key | Action |
|---|---|
| ↑ or mouse wheel up | Increases the UI component value by a step. |
| ↓ or mouse wheel down | Decreases the UI component value by a step. |
You can implement a custom handler for a key using the registerKeyHandler(key, handler) method.
jQuery
JavaScript
function registerKeyHandlers () {
const numberBox = $("#numberBoxContainer").dxNumberBox("instance");
numberBox.registerKeyHandler("backspace", function(e) {
// The argument "e" contains information on the event
});
numberBox.registerKeyHandler("space", function(e) {
// ...
});
}Angular
TypeScript
import { ..., ViewChild, AfterViewInit } from '@angular/core';
import { DxNumberBoxModule, DxNumberBoxComponent } from 'devextreme-angular';
// ...
export class AppComponent implements AfterViewInit {
@ViewChild(DxNumberBoxComponent, { static: false }) numberBox: DxNumberBoxComponent;
// Prior to Angular 8
// @ViewChild(DxNumberBoxComponent) numberBox: DxNumberBoxComponent;
ngAfterViewInit () {
this.numberBox.instance.registerKeyHandler('backspace', function(e) {
// The argument "e" contains information on the event
});
this.numberBox.instance.registerKeyHandler('space', function(e) {
// ...
});
}
}
@NgModule({
imports: [
// ...
DxNumberBoxModule
],
// ...
})Vue
<template>
<DxNumberBox :ref="myNumberBoxRef" />
</template>
<script>
import 'devextreme/dist/css/dx.common.css';
import 'devextreme/dist/css/dx.light.css';
import DxNumberBox from 'devextreme-vue/number-box';
const myNumberBoxRef = 'my-number-box';
export default {
components: {
DxNumberBox
},
data() {
return {
myNumberBoxRef
}
},
computed: {
numberBox: function() {
return this.$refs[myNumberBoxRef].instance;
}
},
mounted: function() {
this.numberBox.registerKeyHandler('backspace', function(e) {
// The argument "e" contains information on the event
});
this.numberBox.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 { NumberBox } from 'devextreme-react/number-box';
class App extends React.Component {
constructor(props) {
super(props);
this.numberBoxRef = React.createRef();
}
render() {
return (
<NumberBox ref={this.numberBoxRef} />
);
}
get numberBox() {
return this.numberBoxRef.current.instance;
}
componentDidMount() {
this.numberBox.registerKeyHandler('backspace', function(e) {
// The argument "e" contains information on the event
});
this.numberBox.registerKeyHandler('space', function(e) {
// ...
});
}
}
export default App;See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
- NumberBox Demos
- NumberBox API Reference
Feedback