Foundry Virtual Tabletop - API Documentation - Version 14
    Preparing search index...

    A custom HTML element responsible displaying a ProseMirror rich text editor.

    open Fired when an editor is initialized in the DOM and ready.

    close Fired when a toggled editor is deactivated.

    save Fired when the editor is saved.

    plugins Fired when an editor's plugins are being configured.

    Hierarchy (View Summary)

    Index

    Properties

    _internals: ElementInternals

    Attached ElementInternals which provides form handling functionality.

    _primaryInput: HTMLElement

    The primary input (if any). Used to determine what element should receive focus when an associated label is clicked on.

    _value: string

    The underlying value of the element.

    formAssociated: boolean = true

    Declare that this custom element provides form element functionality.

    observedAttributes: string[] = ...

    Attributes requiring change notifications

    tagName: string = "prose-mirror"

    Accessors

    • get abortSignal(): AbortSignal

      An AbortSignal that can be passed to event listeners registered in subclasses. The signal will ensure that the listener is removed when the element is disconnected from the DOM. Not available in the constructor.

      Returns AbortSignal

    • get disabled(): boolean

      Is this element disabled?

      Returns boolean

    • get editable(): boolean

      Is this field editable? The field can be neither disabled nor readonly.

      Returns boolean

    • get form(): HTMLFormElement

      The form this element belongs to.

      Returns HTMLFormElement

    • get name(): string

      The input element name.

      Returns string

    • get open(): boolean

      Whether the editor is currently open. Always true for non-toggled editors.

      Returns boolean

    Methods

    • Internal

      Apply key attributes on the containing custom HTML element to input elements contained within it.

      Parameters

      • input: HTMLElement

      Returns void

    • Determine if the editor has unsaved changes.

      Returns boolean

    • Handle saving the editor content. Store new parsed HTML into the _value attribute of the element. If the editor is toggled, also deactivate editing mode.

      Returns void

    • Protected

      Configure ProseMirror editor plugins.

      Returns Record<string, Plugin<any>>

    • Protected

      A method provided for subclasses to perform tear-down workflows as an alternative to overriding disconnectedCallback.

      Returns void

    • Protected

      Special handling when the custom element is clicked. This should be implemented to transfer focus to an appropriate internal element.

      Parameters

      • event: PointerEvent

      Returns void

    • Protected

      Translate user-provided input value into the format that should be stored.

      Parameters

      • value: string

        A new value to assign to the element

      Returns void

      An error if the provided value is invalid