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

    Class HTMLFormulaInputElement

    A form input element custom tailored to formula expressions.

    edit Fired when the formula editor has been requested.

    <formula-input context="default">8 + @prof + @abilities.cha.mod</formula-input>

    HTMLFormulaInputElement.create({ value: "8 + @prof + @abilities.cha.mod" });

    Hierarchy (View Summary)

    Index

    Properties

    button editor input _internals _primaryInput _value formAssociated observedAttributes tagName

    Accessors

    abortSignal context disabled editable form name value

    Methods

    _activateListeners _applyInputAttributes _buildElements _refresh _toggleDisabled adoptedCallback attributeChangedCallback connectedCallback disconnectedCallback focus formDisabledCallback _disconnect _getValue _onClick _setValue create

    Properties

    button: HTMLButtonElement

    A button to open the formula editor interface.

    editor: FormulaEditor

    A reference to the formula editor application instance spawned by this element.

    input: HTMLInputElement

    The formula input.

    Protected_internals

    _internals: ElementInternals

    Attached ElementInternals which provides form handling functionality.

    Protected_primaryInput

    _primaryInput: HTMLElement

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

    Protected_value

    _value: any

    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 = "formula-input"

    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 context(): string

      An identifier to distinguish contexts a formula might be in, which may control which auto-complete suggestions are available, or other behavior. Context configuration is available in CONFIG.formulaEditor.

      Returns string

    • 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

    Methods

    _activateListeners

    _applyInputAttributes

    • _applyInputAttributes(input: HTMLElement): void
      Internal

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

      Parameters

      • input: HTMLElement

      Returns void

    _buildElements

    _refresh

    _toggleDisabled

    Protected_disconnect

    • _disconnect(): void
      Protected

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

      Returns void

    Protected_getValue

    Protected_onClick

    • _onClick(event: PointerEvent): 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_setValue

    • _setValue(value: any): void
      Protected

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

      Parameters

      • value: any

        A new value to assign to the element

      Returns void

      An error if the provided value is invalid

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    Methods