Interface ProseMirrorMenuItem

interface ProseMirrorMenuItem {
    action: string;
    active?: boolean;
    attrs?: object;
    class?: string;
    cmd?: ProseMirrorCommand;
    group?: number;
    icon?: string;
    mark?: MarkType;
    node?: NodeType;
    priority?: number;
    style?: string;
    title: string;
}

Properties

action active? attrs? class? cmd? group? icon? mark? node? priority? style? title

Properties

action

action: string

A string identifier for this menu item.

Optionalactive

active?: boolean

Whether the current item is active under the given selection or cursor.

Optionalattrs

attrs?: object

An object of attributes for the node or mark.

Optionalclass

class?: string

An optional class to apply to the menu item.

Optionalcmd

cmd?: ProseMirrorCommand

The command to run when the menu item is clicked.

Optionalgroup

group?: number

Entries with the same group number will be grouped together in the drop-down. Lower-numbered groups appear higher in the list.

Optionalicon

icon?: string

The menu item's icon HTML.

Optionalmark

mark?: MarkType

The mark to apply to the selected text.

Optionalnode

node?: NodeType

The node to wrap the selected text in.

Optionalpriority

priority?: number

A numeric priority which determines whether this item is displayed as the dropdown title. Lower priority takes precedence.

Optionalstyle

style?: string

An optional style to apply to the title text.

title

title: string

The description of the menu item.

Settings

Member Visibility

On This Page

Properties