Warning

Nightly releases are generated automatically from the latest source code and are intended for experimental purposes only. These builds may contain incomplete or untested features, bugs, or security vulnerabilities, and as such, are not for production use. Users should be aware that nightly releases may cause unexpected behavior, data loss, or system instability. Use of these releases is at the user's own risk, and it is advised to have adequate backups before testing. The software is provided as is with no guarantees or support.

ContextMenuEntry

Type Alias ContextMenuEntry

ContextMenuEntry: {
    icon?: string;
    isSeparator?: boolean;
    isVisible?: ContextMenuVisibleCallback;
    label?: string | ContextMenuLabelCallback;
    onClick?: ContextMenuClickCallback;
    onHover?: ContextMenuHoverCallback;
    subEntries?: ContextMenuEntry[] | ContextMenuSubEntryCallback;
}

Type declaration

  • Optionalicon?: string

    Specifies the leading icon of the context menu entry. The Icon is specified as a string which references a custom Icon in the form: custom:my-icon-id

    Default

    undefined
  • OptionalisSeparator?: boolean

    Specifies if the context menu entry is handled as a simple separation line. In that case all other properties except for the visible-Callback are ignored.

    Default

    false
  • OptionalisVisible?: ContextMenuVisibleCallback

    Specifies a callback function which can be used to hide the context menu entry by a user defined logic.

    Default

    undefined
  • Optionallabel?: string | ContextMenuLabelCallback

    Specifies the label of the context menu entry. The label can be set static or dynamic via a ContextMenuLabelCallback.

  • OptionalonClick?: ContextMenuClickCallback

    Specifies a callback function which is executed when the context menu entry is clicked.

    Default

    undefined
  • OptionalonHover?: ContextMenuHoverCallback

    Specifies a callback function which is executed when the context menu entry is hovered.

    Default

    undefined
  • OptionalsubEntries?: ContextMenuEntry[] | ContextMenuSubEntryCallback

    Specifies a list of sub entries. The sub entries can be set as a static list or as a dynamic list via a ContextMenuSubEntryCallback.

    Default

    undefined