Monster.DOM. CustomControl

To define a new HTML control we need the power of CustomElement

IMPORTANT: after defining a CustomElement, the registerCustomElement method must be called with the new class name. only then will the tag defined via the getTag method be made known to the DOM.

This control uses attachInternals() to integrate the control into a form. If the target environment does not support this method, the polyfill can be used.

You can create the object via the function document.createElement().

Constructor

new CustomControl()

A base class for customcontrols based on CustomElement

IMPORTANT: CustomControls instances are not created via the constructor, but either via a tag in the HTML or via document.createElement().

Since
  • 1.14.0
Copyright
  • schukai GmbH
License
  • AGPLv3
See
Throws:

the ElementInternals is not supported and a polyfill is necessary

Type
Error

Members

defaults

Derived classes can override and extend this method as follows.

Derived classes can override and extend this method as follows.

get defaults() {
   return extends{}, super.defaults, {
       myValue:true
   });
}
Since
  • 1.14.0
See

form

This is a method of internal api

.

This is a method of internal api

Since
  • 1.14.0
See

labels

This is a method of internal api

.

This is a method of internal api

Since
  • 1.14.0
See

name

This is a method of internal api

.

This is a method of internal api

states

This is a method of internal api

.

This is a method of internal api

Since
  • 1.14.0
See

type

This is a method of internal api

.

This is a method of internal api

validationMessage

This is a method of internal api

.

This is a method of internal api

Since
  • 1.14.0
See

validity

This is a method of internal api

.

This is a method of internal api

See

value

Must be overridden by a derived class and return the value of the control.

Must be overridden by a derived class and return the value of the control.

This is a method of internal api

Since
  • 1.14.0

value

Must be overridden by a derived class and return the value of the control.

Must be overridden by a derived class and return the value of the control.

This is a method of internal api

Since
  • 1.14.0

willValidate

This is a method of internal api

.

This is a method of internal api

Since
  • 1.14.0
See

(static) formAssociated

Since
  • 1.14.0
See

(static) instanceSymbol

This method is called by the instanceof operator.

This method is called by the instanceof operator.

Since
  • 2.1.0

(static) observedAttributes

This method determines which attributes are to be monitored by attributeChangedCallback().

This method determines which attributes are to be monitored by attributeChangedCallback().

Since
  • 1.15.0

Methods

checkValidity() → {boolean}

This is a method of internal api

.

This is a method of internal api

Since
  • 1.14.0
See
Throws:

  • NotSupportedError

    Type
    DOMException

  • the ElementInternals is not supported and a polyfill is necessary

    Type
    Error
Returns:
Type: 
boolean

reportValidity() → {boolean}

This is a method of internal api

.

This is a method of internal api

Since
  • 1.14.0
See
Throws:

  • the ElementInternals is not supported and a polyfill is necessary

    Type
    Error

  • NotSupportedError

    Type
    DOMException
Returns:
Type: 
boolean

setFormValue(value, state) → {undefined}

This is a method of internal api

// Use the control's name as the base name for submitted data
const n = this.getAttribute('name');
const entries = new FormData();
entries.append(n + '-first-name', this.firstName_);
entries.append(n + '-last-name', this.lastName_);
this.setFormValue(entries);
.

This is a method of internal api

// Use the control's name as the base name for submitted data
const n = this.getAttribute('name');
const entries = new FormData();
entries.append(n + '-first-name', this.firstName_);
entries.append(n + '-last-name', this.lastName_);
this.setFormValue(entries);
Parameters:
NameTypeDescription
valueFile | string | FormData
stateFile | string | FormData
Since
  • 1.14.0
See
Throws:

  • NotSupportedError

    Type
    DOMException

  • the ElementInternals is not supported and a polyfill is necessary

    Type
    Error
Returns:
Type: 
undefined

setValidity(flags, message, anchor) → {undefined}

Parameters:
NameTypeDescription
flagsobject
messagestring | undefined
anchorHTMLElement
Since
  • 1.14.0
See
Throws:

  • NotSupportedError

    Type
    DOMException

  • the ElementInternals is not supported and a polyfill is necessary

    Type
    Error
Returns:
Type: 
undefined