pivotick - v1.2.0
    Preparing search index...

    Type Alias MenuActionItemOptions<TThis>

    Options to define an action item in a menu. Can be used in contextual menus or multi-select menus.

    type MenuActionItemOptions<TThis extends UIElement = UIElement> = {
        iconClass?: IconClass;
        iconUnicode?: IconUnicode;
        imagePath?: ImagePath;
        onclick: (
            this: TThis,
            evt: PointerEvent | MouseEvent,
            element?: Node | Node[] | Edge | Edge[] | Note | Note[] | null,
        ) => void;
        shortcut?: string;
        svgIcon?: SVGIcon;
        text: string;
        title?: string;
        variant?: UIBaseVariant | UIOutlineVariant | UIOutlineSoftVariant;
        visible?: boolean | ((element: Node | Edge | Note | null) => boolean);
    }

    Type Parameters

    Index

    Properties

    iconClass? iconUnicode? imagePath? onclick shortcut? svgIcon? text title? variant? visible?

    Properties

    iconClass?: IconClass
    iconUnicode?: IconUnicode

    Unicode character for the icon (optional)

    imagePath?: ImagePath
    onclick: (
        this: TThis,
        evt: PointerEvent | MouseEvent,
        element?: Node | Node[] | Edge | Edge[] | Note | Note[] | null,
    ) => void
    shortcut?: string

    The keybinding activates this function. This is just visual. The actual binding is defined in UIManager

    svgIcon?: SVGIcon

    text

    text: string

    Text of the option.

    title?: string

    Title to be shown when hovering over the option.

    variant?: UIBaseVariant | UIOutlineVariant | UIOutlineSoftVariant
    outline-primary
    visible?: boolean | ((element: Node | Edge | Note | null) => boolean)

    Settings

    Member Visibility

    On This Page

    Properties