CKEditor Ecosystem Documentation
Search
Home/CKEditor 5/API
Module

ui/bindings/addkeyboardhandlingforgrid

@ckeditor/ckeditor5-ui/src/bindings/addkeyboardhandlingforgrid

module

Filtering

Functions

  • addKeyboardHandlingForGrid( options = { options.focusTracker, options.gridItems, options.keystrokeHandler, options.numberOfColumns, [options.uiLanguageDirection] } ) → void

    See source

    A helper that adds a keyboard navigation support (arrow up/down/left/right) for grids.

    Parameters

    options : object

    Configuration options.

    Properties
    options.focusTracker : FocusTracker

    A focus tracker for grid elements.

    options.gridItems : ViewCollection<View<HTMLElement>>

    A collection of grid items.

    options.keystrokeHandler : KeystrokeHandler

    Keystroke handler to register navigation with arrow keys.

    options.numberOfColumns : number | () => number

    Number of columns in the grid. Can be specified as a function that returns the number (e.g. for responsive grids).

    [ options.uiLanguageDirection ] : string

    String of ui language direction.

    Returns

    void