Class HTMLDocumentTagsElement

A custom HTMLElement used to render a set of associated Documents referenced by UUID.

Hierarchy (view full)

Properties

_value _primaryInput _internals #button #input #tags tagName formAssociated

Accessors

type single max form name value disabled editable

Methods

_buildElements _refresh _activateListeners _validateDocument _getValue _setValue _toggleDisabled connectedCallback _applyInputAttributes _initializeTags _onClick #onClickTag #onKeydown #onDrop #tryAdd #add renderTag create

Properties

Protected _value

_value: Record<string, string> = {}

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 _internals

_internals: ElementInternals

Attached ElementInternals which provides form handling functionality.

Private #button

#button: HTMLButtonElement

The button element to add a new document.

Private #input

#input: HTMLInputElement

The input element to define a Document UUID.

Private #tags

#tags: HTMLDivElement

The list of tagged documents.

Static tagName

tagName: string = "document-tags"

Static formAssociated

formAssociated: boolean = true

Declare that this custom element provides form element functionality.

Accessors

type

  • get type(): string

  • Restrict this element to documents of a particular type.

    Returns string

single

  • get single(): boolean

  • Restrict to only allow referencing a single Document instead of an array of documents.

    Returns boolean

max

  • get max(): number

  • Allow a maximum number of documents to be tagged to the element.

    Returns number

form

  • get form(): HTMLFormElement

  • The form this element belongs to.

    Returns HTMLFormElement

name

  • get name(): string

  • The input element name.

    Returns string

value

disabled

  • get disabled(): boolean

  • Is this element disabled?

    Returns boolean

editable

  • get editable(): boolean

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

    Returns boolean

Methods

_buildElements

_refresh

_activateListeners

_validateDocument

  • _validateDocument(document): void

  • Validate that the tagged document is allowed to be added to this field. Subclasses may impose more strict validation as to which types of documents are allowed.

    Parameters

    • document: any

      A candidate document or compendium index entry to tag

    Returns void

    Throws

    An error if the candidate document is not allowed

_getValue

_setValue

_toggleDisabled

connectedCallback

_applyInputAttributes

  • _applyInputAttributes(input): void
  • Internal

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

    Parameters

    • input: any

    Returns void

Protected _initializeTags

  • _initializeTags(): void
  • Protected

    Initialize innerText or an initial value attribute of the element as a serialized JSON array.

    Returns void

Protected _onClick

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

Private #onClickTag

  • #onClickTag(event): void

  • Remove a single coefficient by clicking on its tag.

    Parameters

    • event: PointerEvent

    Returns void

Private #onKeydown

  • #onKeydown(event): void

  • Add a new document tag by pressing the ENTER key in the UUID input field.

    Parameters

    • event: KeyboardEvent

    Returns void

Private #onDrop

  • #onDrop(event): void

  • Handle data dropped onto the form element.

    Parameters

    • event: DragEvent

    Returns void

Private #tryAdd

  • #tryAdd(uuid): void

  • Add a Document to the tagged set using the value of the input field.

    Parameters

    • uuid: string

      The UUID to attempt to add

    Returns void

Private #add

  • #add(uuid): void

  • Add a new UUID to the tagged set, throwing an error if the UUID is not valid.

    Parameters

    • uuid: string

      The UUID to add

    Returns void

    Throws

    If the UUID is not valid

Static renderTag

  • renderTag(uuid, name, editable?): HTMLDivElement

  • Create an HTML string fragment for a single document tag.

    Parameters

    • uuid: string

      The document UUID

    • name: string

      The document name

    • Optional editable: boolean = true

      Is the tag editable?

    Returns HTMLDivElement

Static create

Settings

Member Visibility

Theme

On This Page

_value_primaryInput_internals#button#input#tagstagNameformAssociatedtypesinglemaxformnamevaluedisablededitable_buildElements_refresh_activateListeners_validateDocument_getValue_setValue_toggleDisabledconnectedCallback_applyInputAttributes_initializeTags_onClick#onClickTag#onKeydown#onDrop#tryAdd#addrenderTagcreate