Sign up (with export icon)

ui/bindings/addkeyboardhandlingforgrid

Api-module iconmodule

Functions

  • Chevron-right icon

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

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

    See source (with github icon)

    Parameters

    options: object

    Configuration options.

    Properties
    options.focusTracker: FocusTracker

    A focus tracker for grid elements.

    options.gridItems: ViewCollection

    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

Was this page helpful?

Every day, we work hard to keep our documentation complete. Have you spotted outdated information? Is something missing? Please report it via our issue tracker.

GitHubSupportContact Us

© 2003 - 2026  CKSource. All rights reserved.