flexlayout-react
    Preparing search index...

    Interface INodeContextMenuOptions

    Options for getNodeContextMenuItems.

    interface INodeContextMenuOptions {
        actions?: NodeContextAction[];
        closeMenu?: () => void;
        getClassName?: (defaultClassName: string) => string;
        getIcon?: (
            action: NodeContextAction,
            node: TabSetNode | BorderNode | TabGroupNode | TabNode,
        ) => ReactNode;
        getLabel?: (
            action: NodeContextAction,
            node: TabSetNode | BorderNode | TabGroupNode | TabNode,
        ) => string;
        includeDisabled?: boolean;
        onAction?: (action: Action) => void;
    }
    Index
    actions? closeMenu? getClassName? getIcon? getLabel? includeDisabled? onAction?
    actions?: NodeContextAction[]

    the actions to build, in the order to show them (defaults to all actions for the node type). Actions that do not apply to the node type are skipped.

    closeMenu?: () => void

    close the open context menu (used by the group picker / pill rename / color controls)

    getClassName?: (defaultClassName: string) => string

    resolve a default CSS class name through the layout's classNameMapper

    getIcon?: (
        action: NodeContextAction,
        node: TabSetNode | BorderNode | TabGroupNode | TabNode,
    ) => ReactNode

    provide an icon for an item

    getLabel?: (
        action: NodeContextAction,
        node: TabSetNode | BorderNode | TabGroupNode | TabNode,
    ) => string

    override the default label of an item (takes precedence over the i18n labels)

    includeDisabled?: boolean

    include actions that are not allowed on the node as disabled items (default false). Set true to show the full set with not-allowed actions greyed out instead of omitted.

    onAction?: (action: Action) => void

    dispatch actions through this instead of the node's model; useful to intercept/undo actions

    Settings
    Member Visibility

    On This Page
    Properties