A newer version of this page is available. Switch to the current version.

Keyboard Support

An end user can use the following keys to interact with the widget.

Key Action
Shows the previous image.
Shows the following image.

You can implement a custom handler for a key using the registerKeyHandler(key, handler) method.

jQuery
JavaScript
function registerKeyHandlers () {
    let gallery =  $("#galleryContainer").dxGallery("instance");
    gallery.registerKeyHandler("backspace", function (e) {
        // The argument "e" contains information on the event
    });
    gallery.registerKeyHandler("space", function (e) {
        // ...
    });
}
Angular
TypeScript
import { ..., ViewChild, AfterViewInit } from "@angular/core";
import { DxGalleryModule, DxGalleryComponent } from "devextreme-angular";
// ...
export class AppComponent implements AfterViewInit {
    @ViewChild(DxGalleryComponent, { static: false }) gallery: DxGalleryComponent
    // Prior to Angular 8
    // @ViewChild(DxGalleryComponent) gallery: DxGalleryComponent
    ngAfterViewInit () {
        this.gallery.instance.registerKeyHandler("backspace", function (e) {
            // The argument "e" contains information on the event
        });
        this.gallery.instance.registerKeyHandler("space", function (e) {
            // ...
        });
    }
}
@NgModule({
    imports: [
        // ...
        DxGalleryModule
    ],
    // ...
})
See Also