Neo4j Visualization Library
    Preparing search index...

    Type Alias KeyboardInteractionOptions

    Options for the keyboard interaction handler. Allows configuring which keys trigger specific navigation actions. Each key combo is an array of strings: the last element is the primary key (event.key), and any preceding elements are modifier keys ('Shift', 'Ctrl', 'Alt', 'Meta').

    import { KeyboardInteractionOptions } from '@neo4j-nvl/interaction-handlers'

    const options: KeyboardInteractionOptions = {
      navigateForwardKey: ['Tab'],
      contextMenuKey: ['Shift', 'F10']
    }
    type KeyboardInteractionOptions = {
        canvasOutlineColor?: string;
        contextMenuKey?: string[];
        enterGraphKey?: string[];
        exitGraphKey?: string[];
        largeMoveStep?: number;
        largeMoveStepModifier?: "Shift" | "Ctrl" | "Alt" | "Meta";
        moveDownKey?: string[];
        moveLeftKey?: string[];
        moveRightKey?: string[];
        moveStep?: number;
        moveUpKey?: string[];
        navigateBackwardKey?: string[];
        navigateForwardKey?: string[];
    }
    Index
    canvasOutlineColor? contextMenuKey? enterGraphKey? exitGraphKey? largeMoveStep? largeMoveStepModifier? moveDownKey? moveLeftKey? moveRightKey? moveStep? moveUpKey? navigateBackwardKey? navigateForwardKey?
    canvasOutlineColor?: string

    The color of the outline shown when the canvas receives keyboard focus. Default: '#30839D'

    contextMenuKey?: string[]

    Key combo for opening the context menu on the focused element. Default: ['Shift', 'F10']

    enterGraphKey?: string[]

    Key combo for entering the graph and focusing the first element. Default: ['Enter']

    exitGraphKey?: string[]

    Key combo for exiting the graph (blur focused element and container). Default: ['Escape']

    largeMoveStep?: number

    Distance in screen pixels the node(s) are moved per key press while KeyboardInteractionOptions.largeMoveStepModifier is held. Default: 50

    largeMoveStepModifier?: "Shift" | "Ctrl" | "Alt" | "Meta"

    Modifier key that, held together with a move key, applies KeyboardInteractionOptions.largeMoveStep instead of KeyboardInteractionOptions.moveStep. Default: 'Shift'

    moveDownKey?: string[]

    Key combo for moving the selected (or focused) node(s) down. Default: ['ArrowDown']

    moveLeftKey?: string[]

    Key combo for moving the selected (or focused) node(s) left. Default: ['ArrowLeft']

    moveRightKey?: string[]

    Key combo for moving the selected (or focused) node(s) right. Default: ['ArrowRight']

    moveStep?: number

    Distance in screen pixels the node(s) are moved per key press. Converted to graph coordinates using the current zoom level, so the node travels the same visible distance however far the graph is zoomed in or out. Default: 5

    moveUpKey?: string[]

    Key combo for moving the selected (or focused) node(s) up. Default: ['ArrowUp']

    navigateBackwardKey?: string[]

    Key combo for navigating focus to the previous element. Default: ['Shift', 'Tab']

    navigateForwardKey?: string[]

    Key combo for navigating focus to the next element. Default: ['Tab']

    Settings

    On This Page
    Properties