Class HTMLColorPickerElement

A custom HTMLElement used to select a color using a linked pair of input fields.

Hierarchy (view full)

Properties

_primaryInput _internals _value #colorSelector #colorString tagName formAssociated

Accessors

value form name disabled editable

Methods

_buildElements _refresh _activateListeners _toggleDisabled connectedCallback _applyInputAttributes _getValue _setValue _onClick #onChangeInput create

Properties

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.

Protected _value

_value: string

The underlying value of the element.

Private #colorSelector

#colorSelector: HTMLInputElement

The button element to add a new document.

Private #colorString

#colorString: HTMLInputElement

The input element to define a Document UUID.

Static tagName

tagName: string = "color-picker"

Static formAssociated

formAssociated: boolean = true

Declare that this custom element provides form element functionality.

Accessors

value

form

  • get form(): HTMLFormElement

  • The form this element belongs to.

    Returns HTMLFormElement

name

  • get name(): string

  • The input element name.

    Returns string

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

_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 _getValue

  • _getValue(): string
  • Protected

    Return the value of the input element which should be submitted to the form.

    Returns string

Protected _setValue

  • _setValue(value): 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

    Throws

    An error if the provided value is invalid

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 #onChangeInput

  • #onChangeInput(event): void

  • Handle changes to one of the inputs of the color picker element.

    Parameters

    • event: InputEvent

      The originating input change event

    Returns void

Static create

Settings

Member Visibility

Theme

On This Page

_primaryInput_internals_value#colorSelector#colorStringtagNameformAssociatedvalueformnamedisablededitable_buildElements_refresh_activateListeners_toggleDisabledconnectedCallback_applyInputAttributes_getValue_setValue_onClick#onChangeInputcreate