React TextBox - Handle the Keyboard Events
The TextBox raises four keyboard events: keyDown, keyPress, keyUp and enterKey. Within the functions that handle them, you can access the original keyboard events. If you are not going to change the functions during the lifetime of the UI component, assign them to the respective UI component properties.
- import React from 'react';
- import 'devextreme/dist/css/dx.common.css';
- import 'devextreme/dist/css/dx.light.css';
- import { TextBox } from 'devextreme-react/text-box';
- class App extends React.Component {
- render() {
- return (
- <TextBox
- onKeyDown={this.onKeyDown}
- onKeyPress={this.onKeyPress}
- onKeyUp={this.onKeyUp}
- onEnterKey={this.onEnterKey}
- />
- );
- }
- onKeyDown(e) {
- let keyCode = e.event.key;
- // Event handling commands go here
- }
- onKeyPress(e) {
- let keyCode = e.event.key;
- // Event handling commands go here
- }
- onKeyUp(e) {
- let keyCode = e.event.key;
- // Event handling commands go here
- }
- onEnterKey(e) {
- // Event handling commands go here
- }
- }
- export default App;
If you are going to change the handling functions at runtime, or if you need to attach several functions to a single event, use the on(eventName, eventHandler) method. This approach is more typical of jQuery.
- const keyDownHandler1 = function (e) {
- const keyCode = e.event.key;
- // First handler of the "keyDown" event
- };
- const keyDownHandler2 = function (e) {
- const keyCode = e.event.key;
- // Second handler of the "keyDown" event
- };
- $("#textBoxContainer").dxTextBox("instance")
- .on("keyDown", keyDownHandler1)
- .on("keyDown", keyDownHandler2);
You can implement a custom handler for a key using the registerKeyHandler(key, handler) method.
- import React from 'react';
- import 'devextreme/dist/css/dx.common.css';
- import 'devextreme/dist/css/dx.light.css';
- import { TextBox } from 'devextreme-react/text-box';
- class App extends React.Component {
- constructor(props) {
- super(props);
- this.textBoxRef = React.createRef();
- }
- render() {
- return (
- <TextBox ref={this.textBoxRef} />
- );
- }
- get textBox() {
- return this.textBoxRef.current.instance;
- }
- componentDidMount() {
- this.textBox.registerKeyHandler('backspace', function(e) {
- // The argument "e" contains information on the event
- });
- this.textBox.registerKeyHandler('space', function(e) {
- // ...
- });
- }
- }
- export default App;
See Also
- Handle Events: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
- TextBox - Handle the Value Change Event
- TextBox Demos
If you have technical questions, please create a support ticket in the DevExpress Support Center.