Class ProseMirrorMenu

Protected Static_MENU_ITEM_SCOPES

Protected_clearFormatting

• _clearFormatting(): void
  Protected

  Clear any marks from the current selection.

  Returns void

Protected_clearMark

• _clearMark(markType: MarkType): void
  Protected

  Clear a specific mark from the selection.

  Parameters

  • markType: MarkType

    The mark to remove.

  Returns void

Protected_createDropDowns

• _createDropDowns(): void
  Protected

  Instantiate the ProseMirrorDropDown instances and configure them with the defined menu items.

  Returns void

Protected_fontColorPrompt

• _fontColorPrompt(): Promise<void>
  Protected

  Display a prompt for font color.

  Returns Promise<void>

Protected_fontSizePrompt

• _fontSizePrompt(): Promise<void>
  Protected

  Display a prompt for a custom font size.

  Returns Promise<void>

Protected_getDropDownMenus

• _getDropDownMenus(): Record<string, ProseMirrorDropDownConfig>
  Protected

  Configure dropdowns for this menu. Each entry in the top-level array corresponds to a separate drop-down.

  Returns Record<string, ProseMirrorDropDownConfig>

Protected_getMenuItems

• _getMenuItems(): ProseMirrorMenuItem[]
  Protected

  Configure the items for this menu.

  Returns ProseMirrorMenuItem[]

Protected_handleSave

• _handleSave(): any
  Protected

  Handle requests to save the editor contents

  Returns any

Protected_insertImagePrompt

• _insertImagePrompt(): Promise<void>
  Protected

  Display the insert image prompt.

  Returns Promise<void>

Protected_insertLinkPrompt

• _insertLinkPrompt(): Promise<void>
  Protected

  Display the insert link prompt.

  Returns Promise<void>

Protected_insertTablePrompt

• _insertTablePrompt(): Promise<void>
  Protected

  Display the insert table prompt.

  Returns Promise<void>

Protected_isItemActive

• _isItemActive(item: ProseMirrorMenuItem): boolean
  Protected

  Determine whether the given menu item is currently active or not.

  Parameters

  • item: ProseMirrorMenuItem

    The menu item.

  Returns boolean

  Whether the cursor or selection is in a state represented by the given menu item.

Protected_isMarkActive

• _isMarkActive(item: ProseMirrorMenuItem): boolean
  Protected

  Determine whether the given menu item representing a mark is active or not.

  Parameters

  • item: ProseMirrorMenuItem

    The menu item representing a MarkType.

  Returns boolean

  Whether the cursor or selection is in a state represented by the given mark.

Protected_isNodeActive

• _isNodeActive(item: ProseMirrorMenuItem): boolean
  Protected

  Determine whether the given menu item representing a node is active or not.

  Parameters

  • item: ProseMirrorMenuItem

    The menu item representing a NodeType.

  Returns boolean

  Whether the cursor or selection is currently within a block of this menu item's node type.

Protected_onAction

• _onAction(event: MouseEvent): void
  Protected

  Handle a button press.

  Parameters

  • event: MouseEvent

    The click event.

  Returns void

Protected_onResize

• _onResize(entries: ResizeObserverEntry[]): void
  Protected

  Handle collapsing various menu items to accommodate the menu's available width.

  Parameters

  • entries: ResizeObserverEntry[]

  Returns void

Protected_placeInsert

• _placeInsert(
      state: EditorState,
      dispatch: Function,
      view: EditorView,
      html: string,
      options?: { inline?: boolean },
  ): void
  Protected

  Place the given insert into the ProseMirror Document.

  Parameters

  • state: EditorState

    The editor state.

  • dispatch: Function

    Dispatch changes to the editor state.

  • view: EditorView

    The editor view.

  • html: string

    The insert's markup.

  • Optionaloptions: { inline?: boolean } = {}

    • Optionalinline?: boolean

      Whether the insert contains inline content, otherwise block content is assumed.

  Returns void

Protected_showDialog

• _showDialog(
      action: string,
      template: string,
      options?: { data?: object },
  ): HTMLDialogElement
  Protected

  Create a dialog for a menu button.

  Parameters

  • action: string

    The unique menu button action.

  • template: string

    The dialog's template.

  • Optionaloptions: { data?: object } = {}

    Additional options to configure the dialog's behaviour.

    • Optionaldata?: object

      Data to pass to the template.

  Returns HTMLDialogElement

Protected_toggleBlock

• _toggleBlock(
      node: NodeType,
      wrap: MenuToggleBlockWrapCommand,
      options?: { attrs?: object },
  ): void
  Protected

  Toggle the given selection by wrapping it in a given block or lifting it out of one.

  Parameters

  • node: NodeType

    The type of node being interacted with.

  • wrap: MenuToggleBlockWrapCommand

    The wrap command specific to the given node.

  • Optionaloptions: { attrs?: object } = {}

    Additional options to configure behaviour.

    • Optionalattrs?: object

      Attributes for the node.

  Returns void

Protected_toggleMark

• _toggleMark(markType: MarkType, attrs?: any): void
  Protected

  Toggle a mark in the selection. Unlike the built-in toggleMark command, this will check for exact attribute matches to determine toggling behavior.

  Parameters

  • markType: MarkType

    The mark to apply.

  • attrs: any = null

    The mark's attributes.

  Returns void

Protected_toggleMatches

• _toggleMatches(): Promise<void>
  Protected

  Toggle link recommendations

  Returns Promise<void>

Protected_toggleTextBlock

• _toggleTextBlock(node: NodeType, options?: { attrs?: object }): void
  Protected

  Toggle the given selection by wrapping it in a given text block, or reverting to a paragraph block.

  Parameters

  • node: NodeType

    The type of node being interacted with.

  • Optionaloptions: { attrs?: object } = {}

    Additional options to configure behaviour.

    • Optionalattrs?: object

      Attributes for the node.

  Returns void

Protected_wrapEditor

• _wrapEditor(): void
  Protected

  Wrap the editor view element and inject our template ready to be rendered into.

  Returns void

ProtectedgetActionElement

• getActionElement(action: string): HTMLElement
  Protected

  Get the visible element from its action.

  Parameters

  • action: string

    The action.

  Returns HTMLElement