DevExtreme jQuery/JS - Keyboard Support
An end user can use the following keys to interact with the widget.
| Key | Action |
|---|---|
| ← → ↑ ↓ | Moves the color pointer. |
| Ctrl + ↑ | Moves the RGB slider up. |
| Ctrl + ↓ | Moves the RGB slider down. |
| Ctrl + ← | Moves the transparency slider left. |
| Ctrl + → | Moves the transparency slider right. |
| Enter | Selects the color. |
You can implement a custom handler for a key using the registerKeyHandler(key, handler) method.
jQuery
JavaScript
function registerKeyHandlers () {
const colorBox = $("#colorBoxContainer").dxColorBox("instance");
colorBox.registerKeyHandler("backspace", function(e) {
// The argument "e" contains information on the event
});
colorBox.registerKeyHandler("space", function(e) {
// ...
});
}Angular
TypeScript
import { ..., ViewChild, AfterViewInit } from '@angular/core';
import { DxColorBoxModule, DxColorBoxComponent } from 'devextreme-angular';
// ...
export class AppComponent implements AfterViewInit {
@ViewChild(DxColorBoxComponent, { static: false }) colorBox: DxColorBoxComponent;
// Prior to Angular 8
// @ViewChild(DxColorBoxComponent) colorBox: DxColorBoxComponent;
ngAfterViewInit () {
this.colorBox.instance.registerKeyHandler('backspace', function(e) {
// The argument "e" contains information on the event
});
this.colorBox.instance.registerKeyHandler('space', function(e) {
// ...
});
}
}
@NgModule({
imports: [
// ...
DxColorBoxModule
],
// ...
})Vue
<template>
<DxColorBox :ref="myColorBoxRef" />
</template>
<script>
import 'devextreme/dist/css/dx.common.css';
import 'devextreme/dist/css/dx.light.css';
import DxColorBox from 'devextreme-vue/color-box';
const myColorBoxRef = 'my-color-box';
export default {
components: {
DxColorBox
},
data() {
return {
myColorBoxRef
}
},
computed: {
colorBox: function() {
return this.$refs[myColorBoxRef].instance;
}
},
mounted: function() {
this.colorBox.registerKeyHandler('backspace', function(e) {
// The argument "e" contains information on the event
});
this.colorBox.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 { ColorBox } from 'devextreme-react/color-box';
class App extends React.Component {
constructor(props) {
super(props);
this.colorBoxRef = React.createRef();
}
render() {
return (
<ColorBox ref={this.colorBoxRef} />
);
}
get colorBox() {
return this.colorBoxRef.current.instance;
}
componentDidMount() {
this.colorBox.registerKeyHandler('backspace', function(e) {
// The argument "e" contains information on the event
});
this.colorBox.registerKeyHandler('space', function(e) {
// ...
});
}
}
export default App;See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
- ColorBox Demos
- ColorBox API Reference
Feedback