{ "schemaVersion": "1.0.0", "readme": "", "modules": [ { "kind": "javascript-module", "path": "src/CheckboxElement.ts", "declarations": [ { "kind": "class", "description": "A checkbox that allows a user to select one or more options from a limited number of choices.", "name": "M3eCheckboxElement", "cssProperties": [ { "description": "Size of the checkbox icon inside the container.", "name": "--m3e-checkbox-icon-size" }, { "description": "Base size of the checkbox container.", "name": "--m3e-checkbox-container-size" }, { "description": "Border radius of the icon container.", "name": "--m3e-checkbox-container-shape" }, { "description": "Border thickness for unselected state.", "name": "--m3e-checkbox-unselected-outline-thickness" }, { "description": "Border color for unselected state.", "name": "--m3e-checkbox-unselected-outline-color" }, { "description": "Border color on hover when unselected.", "name": "--m3e-checkbox-unselected-hover-outline-color" }, { "description": "Base color for disabled unselected outline.", "name": "--m3e-checkbox-unselected-disabled-outline-color" }, { "description": "Opacity for disabled unselected outline.", "name": "--m3e-checkbox-unselected-disabled-outline-opacity" }, { "description": "Border color for invalid unselected state.", "name": "--m3e-checkbox-unselected-error-outline-color" }, { "description": "Background color for selected container.", "name": "--m3e-checkbox-selected-container-color" }, { "description": "Icon color for selected state.", "name": "--m3e-checkbox-selected-icon-color" }, { "description": "Base color for disabled selected container.", "name": "--m3e-checkbox-selected-disabled-container-color" }, { "description": "Opacity for disabled selected container.", "name": "--m3e-checkbox-selected-disabled-container-opacity" }, { "description": "Base color for disabled selected icon.", "name": "--m3e-checkbox-selected-disabled-icon-color" }, { "description": "Opacity for disabled selected icon.", "name": "--m3e-checkbox-selected-disabled-icon-opacity" }, { "description": "Ripple hover color for unselected state.", "name": "--m3e-checkbox-unselected-hover-color" }, { "description": "Ripple focus color for unselected state.", "name": "--m3e-checkbox-unselected-focus-color" }, { "description": "Ripple base color for unselected state.", "name": "--m3e-checkbox-unselected-ripple-color" }, { "description": "Ripple hover color for selected state.", "name": "--m3e-checkbox-selected-hover-color" }, { "description": "Ripple focus color for selected state.", "name": "--m3e-checkbox-selected-focus-color" }, { "description": "Ripple base color for selected state.", "name": "--m3e-checkbox-selected-ripple-color" }, { "description": "Ripple hover color for invalid unselected state.", "name": "--m3e-checkbox-unselected-error-hover-color" }, { "description": "Ripple focus color for invalid unselected state.", "name": "--m3e-checkbox-unselected-error-focus-color" }, { "description": "Ripple base color for invalid unselected state.", "name": "--m3e-checkbox-unselected-error-ripple-color" }, { "description": "Ripple hover color for invalid selected state.", "name": "--m3e-checkbox-selected-error-hover-color" }, { "description": "Ripple focus color for invalid selected state.", "name": "--m3e-checkbox-selected-error-focus-color" }, { "description": "Ripple base color for invalid selected state.", "name": "--m3e-checkbox-selected-error-ripple-color" } ], "members": [ { "kind": "field", "name": "_focusRing", "type": { "text": "M3eFocusRingElement | undefined" }, "privacy": "private", "readonly": true }, { "kind": "field", "name": "_stateLayer", "type": { "text": "M3eStateLayerElement | undefined" }, "privacy": "private", "readonly": true }, { "kind": "field", "name": "_ripple", "type": { "text": "M3eRippleElement | undefined" }, "privacy": "private", "readonly": true }, { "kind": "field", "name": "#clickHandler", "privacy": "private", "readonly": true }, { "kind": "field", "name": "#hoverController", "privacy": "private", "readonly": true, "default": "new HoverController(this, { target: null, callback: (hovering) => { if (this.disabled) return; if (hovering) { this._stateLayer?.show(\"hover\"); } else { this._stateLayer?.hide(\"hover\"); } }, })" }, { "kind": "field", "name": "#pressedController", "privacy": "private", "readonly": true, "default": "new PressedController(this, { target: null, minPressedDuration: 150, callback: (pressed) => { if (this.disabled) return; if (pressed) { this._ripple?.show(0, 0, true); } else { this._ripple?.hide(); } }, })" }, { "kind": "field", "name": "value", "type": { "text": "string" }, "default": "\"on\"", "description": "A string representing the value of the checkbox.", "attribute": "value" }, { "kind": "field", "name": "[formValue]", "type": { "text": "string | File | FormData | null" }, "privacy": "private", "readonly": true }, { "kind": "method", "name": "#renderIcon", "privacy": "private", "return": { "type": { "text": "unknown" } } }, { "kind": "method", "name": "#handleClick", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "e", "type": { "text": "Event" } } ] }, { "kind": "field", "name": "formAssociated", "static": true, "readonly": true, "default": "true", "description": "Indicates that this custom element participates in form submission, validation, and form state restoration.", "type": { "text": "boolean" }, "inheritedFrom": { "name": "AttachInternals", "module": "../core/src/shared/mixins/AttachInternals.ts" } }, { "kind": "field", "name": "[_eventHandler]", "privacy": "private", "readonly": true, "inheritedFrom": { "name": "Touched", "module": "../core/src/shared/mixins/Touched.ts" } }, { "kind": "field", "name": "labels", "type": { "text": "NodeListOf" }, "readonly": true, "description": "The label elements that the element is associated with.", "inheritedFrom": { "name": "FormAssociated", "module": "../core/src/shared/mixins/FormAssociated.ts" } }, { "kind": "field", "name": "dirty", "type": { "text": "boolean" }, "description": "Whether the user has modified the value of the element.", "readonly": true, "inheritedFrom": { "name": "Dirty", "module": "../core/src/shared/mixins/Dirty.ts" } }, { "kind": "field", "name": "pristine", "type": { "text": "boolean" }, "description": "Whether the user has not modified the value of the element.", "readonly": true, "inheritedFrom": { "name": "Dirty", "module": "../core/src/shared/mixins/Dirty.ts" } }, { "kind": "method", "name": "markAsPristine", "return": { "type": { "text": "void" } }, "description": "Marks the element as pristine.", "inheritedFrom": { "name": "Dirty", "module": "../core/src/shared/mixins/Dirty.ts" } }, { "kind": "method", "name": "markAsDirty", "return": { "type": { "text": "void" } }, "description": "Marks the element as dirty.", "inheritedFrom": { "name": "Dirty", "module": "../core/src/shared/mixins/Dirty.ts" } }, { "kind": "field", "name": "touched", "type": { "text": "boolean" }, "description": "Whether the user has interacted when the element.", "readonly": true, "inheritedFrom": { "name": "Touched", "module": "../core/src/shared/mixins/Touched.ts" } }, { "kind": "field", "name": "untouched", "type": { "text": "boolean" }, "description": "Whether the user has not interacted when the element.", "readonly": true, "inheritedFrom": { "name": "Touched", "module": "../core/src/shared/mixins/Touched.ts" } }, { "kind": "method", "name": "markAsTouched", "return": { "type": { "text": "void" } }, "description": "Marks the element as touched.", "inheritedFrom": { "name": "Touched", "module": "../core/src/shared/mixins/Touched.ts" } }, { "kind": "method", "name": "markAsUntouched", "return": { "type": { "text": "void" } }, "description": "Marks the element as untouched.", "inheritedFrom": { "name": "Touched", "module": "../core/src/shared/mixins/Touched.ts" } }, { "kind": "field", "name": "required", "type": { "text": "boolean" }, "default": "false", "description": "Whether a value is required for the element.", "attribute": "required", "reflects": true, "inheritedFrom": { "name": "Required", "module": "../core/src/shared/mixins/Required.ts" } }, { "kind": "field", "name": "optional", "description": "Whether a value is not required for the element.", "readonly": true, "inheritedFrom": { "name": "Required", "module": "../core/src/shared/mixins/Required.ts" } }, { "kind": "field", "name": "[_validityMessage]", "type": { "text": "string | undefined" }, "privacy": "private", "inheritedFrom": { "name": "ConstraintValidation", "module": "../core/src/shared/mixins/ConstraintValidation.ts" } }, { "kind": "field", "name": "willValidate", "type": { "text": "boolean" }, "description": "Whether the element is a submittable element that is a candidate for constraint validation.", "readonly": true, "inheritedFrom": { "name": "ConstraintValidation", "module": "../core/src/shared/mixins/ConstraintValidation.ts" } }, { "kind": "field", "name": "validity", "type": { "text": "ValidityState" }, "description": "The validity state of the element.", "readonly": true, "inheritedFrom": { "name": "ConstraintValidation", "module": "../core/src/shared/mixins/ConstraintValidation.ts" } }, { "kind": "field", "name": "validationMessage", "type": { "text": "string" }, "description": "The error message that would be displayed if the user submits the form, or an empty string if no error message.", "readonly": true, "inheritedFrom": { "name": "ConstraintValidation", "module": "../core/src/shared/mixins/ConstraintValidation.ts" } }, { "kind": "method", "name": "reportValidity", "return": { "type": { "text": "boolean" } }, "description": "Returns `true` if the element has no validity problems; otherwise, returns `false`, fires\r\nan invalid event, and (if the event isn't canceled) reports the problem to the user.", "inheritedFrom": { "name": "ConstraintValidation", "module": "../core/src/shared/mixins/ConstraintValidation.ts" } }, { "kind": "method", "name": "checkValidity", "return": { "type": { "text": "boolean" } }, "description": "Returns `true` if the element has no validity problems; otherwise,\r\nreturns `false`, fires an invalid event.", "inheritedFrom": { "name": "ConstraintValidation", "module": "../core/src/shared/mixins/ConstraintValidation.ts" } }, { "kind": "method", "name": "setCustomValidity", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "error", "type": { "text": "string" }, "description": "The message to use for validity errors." } ], "description": "Sets a custom validity message for the element.", "inheritedFrom": { "name": "ConstraintValidation", "module": "../core/src/shared/mixins/ConstraintValidation.ts" } }, { "kind": "method", "name": "[_updateValidity]", "privacy": "private", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "ConstraintValidation", "module": "../core/src/shared/mixins/ConstraintValidation.ts" } }, { "kind": "method", "name": "#getNativeMessage", "privacy": "private", "return": { "type": { "text": "string" } }, "parameters": [ { "name": "flags", "type": { "text": "ValidityStateFlags" } } ], "inheritedFrom": { "name": "ConstraintValidation", "module": "../core/src/shared/mixins/ConstraintValidation.ts" } }, { "kind": "field", "name": "indeterminate", "type": { "text": "boolean" }, "default": "false", "description": "Whether the element's checked state is indeterminate.", "attribute": "indeterminate", "reflects": true, "inheritedFrom": { "name": "CheckedIndeterminate", "module": "../core/src/shared/mixins/CheckedIndeterminate.ts" } }, { "kind": "field", "name": "checked", "type": { "text": "boolean" }, "default": "false", "description": "Whether the element is checked.", "attribute": "checked", "reflects": true, "inheritedFrom": { "name": "Checked", "module": "../core/src/shared/mixins/Checked.ts" } }, { "kind": "field", "name": "[_defaultValue]", "type": { "text": "unknown" }, "privacy": "private", "inheritedFrom": { "name": "FormAssociated", "module": "../core/src/shared/mixins/FormAssociated.ts" } }, { "kind": "field", "name": "[_defaultIndeterminate]", "type": { "text": "boolean" }, "privacy": "private", "default": "false", "inheritedFrom": { "name": "FormAssociated", "module": "../core/src/shared/mixins/FormAssociated.ts" } }, { "kind": "field", "name": "[_formDisabled]", "type": { "text": "boolean" }, "privacy": "private", "default": "false", "inheritedFrom": { "name": "FormAssociated", "module": "../core/src/shared/mixins/FormAssociated.ts" } }, { "kind": "field", "name": "form", "type": { "text": "HTMLFormElement | null" }, "description": "The `HTMLFormElement` associated with this element.", "readonly": true, "inheritedFrom": { "name": "FormAssociated", "module": "../core/src/shared/mixins/FormAssociated.ts" } }, { "kind": "field", "name": "name", "description": "The name that identifies the element when submitting the associated form.", "attribute": "name", "inheritedFrom": { "name": "FormAssociated", "module": "../core/src/shared/mixins/FormAssociated.ts" } }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Whether the element is disabled.", "attribute": "disabled", "inheritedFrom": { "name": "Disabled", "module": "../core/src/shared/mixins/Disabled.ts" } }, { "kind": "method", "name": "formDisabledCallback", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "disabled", "type": { "text": "boolean" } } ], "description": "Called when the element is disabled or enabled via its form association.", "inheritedFrom": { "name": "FormAssociated", "module": "../core/src/shared/mixins/FormAssociated.ts" } }, { "kind": "method", "name": "formResetCallback", "return": { "type": { "text": "void" } }, "description": "Called when the associated form is reset.", "inheritedFrom": { "name": "FormAssociated", "module": "../core/src/shared/mixins/FormAssociated.ts" } }, { "kind": "field", "name": "#keyPressed", "privacy": "private", "type": { "text": "boolean" }, "default": "false", "inheritedFrom": { "name": "KeyboardClick", "module": "../core/src/shared/mixins/KeyboardClick.ts" } }, { "kind": "field", "name": "#keyDownHandler", "privacy": "private", "readonly": true, "inheritedFrom": { "name": "KeyboardClick", "module": "../core/src/shared/mixins/KeyboardClick.ts" } }, { "kind": "field", "name": "#keyUpHandler", "privacy": "private", "readonly": true, "inheritedFrom": { "name": "KeyboardClick", "module": "../core/src/shared/mixins/KeyboardClick.ts" } }, { "kind": "field", "name": "#focusOutHandler", "privacy": "private", "readonly": true, "inheritedFrom": { "name": "KeyboardClick", "module": "../core/src/shared/mixins/KeyboardClick.ts" } }, { "kind": "method", "name": "#handleKeyDown", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "e", "type": { "text": "KeyboardEvent" } } ], "inheritedFrom": { "name": "KeyboardClick", "module": "../core/src/shared/mixins/KeyboardClick.ts" } }, { "kind": "method", "name": "#handleKeyUp", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "e", "type": { "text": "KeyboardEvent" } } ], "inheritedFrom": { "name": "KeyboardClick", "module": "../core/src/shared/mixins/KeyboardClick.ts" } }, { "kind": "field", "name": "[_tabindex]", "type": { "text": "number" }, "privacy": "private", "default": "0", "inheritedFrom": { "name": "Focusable", "module": "../core/src/shared/mixins/Focusable.ts" } }, { "kind": "field", "name": "[_internals]", "type": { "text": "ElementInternals | undefined" }, "privacy": "private", "inheritedFrom": { "name": "AttachInternals", "module": "../core/src/shared/mixins/AttachInternals.ts" } } ], "events": [ { "name": "input", "type": { "text": "Event" }, "description": "Emitted when the checked state changes." }, { "name": "change", "type": { "text": "Event" }, "description": "Emitted when the checked state changes." }, { "description": "Emitted when a form is submitted and the element fails constraint validation.", "name": "invalid" }, { "name": "click", "type": { "text": "MouseEvent" }, "description": "Emitted when the element is clicked.", "inheritedFrom": { "name": "KeyboardClick", "module": "../core/src/shared/mixins/KeyboardClick.ts" } } ], "attributes": [ { "name": "checked", "type": { "text": "boolean" }, "default": "false", "description": "Whether the element is checked.", "fieldName": "checked", "inheritedFrom": { "name": "Checked", "module": "../core/src/shared/mixins/Checked.ts" } }, { "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Whether the element is disabled.", "fieldName": "disabled", "inheritedFrom": { "name": "Disabled", "module": "../core/src/shared/mixins/Disabled.ts" } }, { "name": "indeterminate", "type": { "text": "boolean" }, "default": "false", "description": "Whether the element's checked state is indeterminate.", "fieldName": "indeterminate", "inheritedFrom": { "name": "CheckedIndeterminate", "module": "../core/src/shared/mixins/CheckedIndeterminate.ts" } }, { "name": "name", "description": "The name that identifies the element when submitting the associated form.", "fieldName": "name", "inheritedFrom": { "name": "FormAssociated", "module": "../core/src/shared/mixins/FormAssociated.ts" } }, { "name": "required", "type": { "text": "boolean" }, "default": "false", "description": "Whether the element is required.", "fieldName": "required", "inheritedFrom": { "name": "Required", "module": "../core/src/shared/mixins/Required.ts" } }, { "description": "A string representing the value of the checkbox.", "name": "value", "type": { "text": "string" }, "default": "\"on\"", "fieldName": "value" } ], "mixins": [ { "name": "Labelled", "package": "@m3e/core" }, { "name": "RequiredConstraintValidation", "package": "@m3e/core" }, { "name": "Dirty", "package": "@m3e/core" }, { "name": "Touched", "package": "@m3e/core" }, { "name": "Required", "package": "@m3e/core" }, { "name": "ConstraintValidation", "package": "@m3e/core" }, { "name": "CheckedIndeterminate", "package": "@m3e/core" }, { "name": "FormAssociated", "package": "@m3e/core" }, { "name": "KeyboardClick", "package": "@m3e/core" }, { "name": "Focusable", "package": "@m3e/core" }, { "name": "Disabled", "package": "@m3e/core" }, { "name": "AttachInternals", "package": "@m3e/core" }, { "name": "Role", "package": "@m3e/core" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "m3e-checkbox", "customElement": true } ], "exports": [ { "kind": "js", "name": "M3eCheckboxElement", "declaration": { "name": "M3eCheckboxElement", "module": "src/CheckboxElement.ts" } }, { "kind": "custom-element-definition", "name": "m3e-checkbox", "declaration": { "name": "M3eCheckboxElement", "module": "src/CheckboxElement.ts" } } ] }, { "kind": "javascript-module", "path": "src/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "\"./CheckboxElement\"" } } ] }, { "kind": "javascript-module", "path": "../core/src/shared/mixins/AttachInternals.ts", "declarations": [ { "kind": "variable", "name": "internals", "description": "A symbol through which to access the `ElementInternals` attached to an element." }, { "kind": "function", "name": "isAttachInternalsMixin", "return": { "type": { "text": "" } }, "parameters": [ { "name": "value", "type": { "text": "unknown" }, "description": "The value to test." } ], "description": "Determines whether a value is an `AttachInternalsMixin`." }, { "kind": "mixin", "description": "Mixin to augment an element with behavior that attaches to `ElementInternals`.", "name": "AttachInternals", "members": [ { "kind": "field", "name": "formAssociated", "static": true, "readonly": true, "default": "formAssociated", "description": "Indicates that this custom element participates in form submission, validation, and form state restoration." }, { "kind": "field", "name": "[_internals]", "type": { "text": "ElementInternals | undefined" }, "privacy": "private" } ], "parameters": [ { "name": "base", "type": { "text": "T" }, "description": "The base class." }, { "name": "formAssociated", "optional": true, "type": { "text": "boolean | undefined" }, "description": "Whether the element is \"Form Associated\"." } ] } ], "exports": [ { "kind": "js", "name": "internals", "declaration": { "name": "internals", "module": "../core/src/shared/mixins/AttachInternals.ts" } }, { "kind": "js", "name": "isAttachInternalsMixin", "declaration": { "name": "isAttachInternalsMixin", "module": "../core/src/shared/mixins/AttachInternals.ts" } }, { "kind": "js", "name": "AttachInternals", "declaration": { "name": "AttachInternals", "module": "../core/src/shared/mixins/AttachInternals.ts" } } ] }, { "kind": "javascript-module", "path": "../core/src/shared/mixins/Checked.ts", "declarations": [ { "kind": "function", "name": "isCheckedMixin", "return": { "type": { "text": "" } }, "parameters": [ { "name": "value", "type": { "text": "unknown" }, "description": "The value to test." } ], "description": "Determines whether a value is a `CheckedMixin`." }, { "kind": "mixin", "description": "Mixin to augment an element with behavior that supports a checked state.", "name": "Checked", "members": [ { "kind": "field", "name": "checked", "type": { "text": "boolean" }, "default": "false", "description": "Whether the element is checked.", "attribute": "checked", "reflects": true } ], "attributes": [ { "name": "checked", "type": { "text": "boolean" }, "default": "false", "description": "Whether the element is checked.", "fieldName": "checked" } ], "parameters": [ { "name": "base", "type": { "text": "T" }, "description": "The base class." } ] } ], "exports": [ { "kind": "js", "name": "isCheckedMixin", "declaration": { "name": "isCheckedMixin", "module": "../core/src/shared/mixins/Checked.ts" } }, { "kind": "js", "name": "Checked", "declaration": { "name": "Checked", "module": "../core/src/shared/mixins/Checked.ts" } } ] }, { "kind": "javascript-module", "path": "../core/src/shared/mixins/CheckedIndeterminate.ts", "declarations": [ { "kind": "function", "name": "isCheckedIndeterminateMixin", "return": { "type": { "text": "" } }, "parameters": [ { "name": "value", "type": { "text": "unknown" }, "description": "The value to test." } ], "description": "Determines whether a value is a `CheckedIndeterminateMixin`." }, { "kind": "mixin", "description": "Mixin to augment an element with behavior that supports a mixed checked state.", "name": "CheckedIndeterminate", "members": [ { "kind": "field", "name": "indeterminate", "type": { "text": "boolean" }, "default": "false", "description": "Whether the element's checked state is indeterminate.", "attribute": "indeterminate", "reflects": true }, { "kind": "field", "name": "checked", "type": { "text": "boolean" }, "default": "false", "description": "Whether the element is checked.", "attribute": "checked", "reflects": true, "inheritedFrom": { "name": "Checked", "module": "../core/src/shared/mixins/Checked.ts" } } ], "attributes": [ { "name": "indeterminate", "type": { "text": "boolean" }, "default": "false", "description": "Whether the element's checked state is indeterminate.", "fieldName": "indeterminate" }, { "name": "checked", "type": { "text": "boolean" }, "default": "false", "description": "Whether the element is checked.", "fieldName": "checked", "inheritedFrom": { "name": "Checked", "module": "../core/src/shared/mixins/Checked.ts" } } ], "mixins": [ { "name": "Checked", "module": "/core/src/shared/mixins/Checked" } ], "parameters": [ { "name": "base", "type": { "text": "T" }, "description": "The base class." } ] } ], "exports": [ { "kind": "js", "name": "isCheckedIndeterminateMixin", "declaration": { "name": "isCheckedIndeterminateMixin", "module": "../core/src/shared/mixins/CheckedIndeterminate.ts" } }, { "kind": "js", "name": "CheckedIndeterminate", "declaration": { "name": "CheckedIndeterminate", "module": "../core/src/shared/mixins/CheckedIndeterminate.ts" } } ] }, { "kind": "javascript-module", "path": "../core/src/shared/mixins/CheckedOrSelected.ts", "declarations": [ { "kind": "function", "name": "isCheckedOrSelectedMixin", "return": { "type": { "text": "" } }, "parameters": [ { "name": "value", "type": { "text": "unknown" }, "description": "The value to test." } ], "description": "Determines whether a value is a `CheckedOrSelectedMixin`." }, { "kind": "function", "name": "isCheckedOrSelected", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "element", "type": { "text": "CheckedOrSelectedMixin" }, "description": "The element to test." } ], "description": "Determines whether the state of an element is checked or selected." }, { "kind": "function", "name": "checkOrSelect", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "element", "type": { "text": "CheckedOrSelectedMixin" }, "description": "The element for which to set the checked or selected state." }, { "name": "checkedOrSelected", "type": { "text": "boolean" }, "description": "The checked or selected state." } ], "description": "Sets the checked or selected state of an element." } ], "exports": [ { "kind": "js", "name": "isCheckedOrSelectedMixin", "declaration": { "name": "isCheckedOrSelectedMixin", "module": "../core/src/shared/mixins/CheckedOrSelected.ts" } }, { "kind": "js", "name": "isCheckedOrSelected", "declaration": { "name": "isCheckedOrSelected", "module": "../core/src/shared/mixins/CheckedOrSelected.ts" } }, { "kind": "js", "name": "checkOrSelect", "declaration": { "name": "checkOrSelect", "module": "../core/src/shared/mixins/CheckedOrSelected.ts" } } ] }, { "kind": "javascript-module", "path": "../core/src/shared/mixins/ConstraintValidation.ts", "declarations": [ { "kind": "variable", "name": "validate", "description": "A symbol through which a \"Form Associated\" custom element validates its current state." }, { "kind": "function", "name": "isConstraintValidationMixin", "return": { "type": { "text": "" } }, "parameters": [ { "name": "value", "type": { "text": "unknown" }, "description": "The value to test." } ], "description": "Determines whether a value is a `ConstraintValidationMixin`." }, { "kind": "mixin", "description": "Mixin to augment an element with \"Form Associated\" behavior that supports constraint validation.", "name": "ConstraintValidation", "members": [ { "kind": "field", "name": "[_validityMessage]", "type": { "text": "string | undefined" }, "privacy": "private" }, { "kind": "field", "name": "willValidate", "type": { "text": "boolean" }, "description": "Whether the element is a submittable element that is a candidate for constraint validation.", "readonly": true }, { "kind": "field", "name": "validity", "type": { "text": "ValidityState" }, "description": "The validity state of the element.", "readonly": true }, { "kind": "field", "name": "validationMessage", "type": { "text": "string" }, "description": "The error message that would be displayed if the user submits the form, or an empty string if no error message.", "readonly": true }, { "kind": "method", "name": "reportValidity", "return": { "type": { "text": "boolean" } }, "description": "Returns `true` if the element has no validity problems; otherwise, returns `false`, fires\r\nan invalid event, and (if the event isn't canceled) reports the problem to the user." }, { "kind": "method", "name": "checkValidity", "return": { "type": { "text": "boolean" } }, "description": "Returns `true` if the element has no validity problems; otherwise,\r\nreturns `false`, fires an invalid event." }, { "kind": "method", "name": "setCustomValidity", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "error", "type": { "text": "string" }, "description": "The message to use for validity errors." } ], "description": "Sets a custom validity message for the element." }, { "kind": "method", "name": "[_updateValidity]", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "#getNativeMessage", "privacy": "private", "return": { "type": { "text": "string" } }, "parameters": [ { "name": "flags", "type": { "text": "ValidityStateFlags" } } ] } ], "parameters": [ { "name": "base", "type": { "text": "T" }, "description": "The base class." } ] } ], "exports": [ { "kind": "js", "name": "validate", "declaration": { "name": "validate", "module": "../core/src/shared/mixins/ConstraintValidation.ts" } }, { "kind": "js", "name": "isConstraintValidationMixin", "declaration": { "name": "isConstraintValidationMixin", "module": "../core/src/shared/mixins/ConstraintValidation.ts" } }, { "kind": "js", "name": "ConstraintValidation", "declaration": { "name": "ConstraintValidation", "module": "../core/src/shared/mixins/ConstraintValidation.ts" } } ] }, { "kind": "javascript-module", "path": "../core/src/shared/mixins/Constructor.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "../core/src/shared/mixins/Dirty.ts", "declarations": [ { "kind": "function", "name": "isDirtyMixin", "return": { "type": { "text": "" } }, "parameters": [ { "name": "value", "type": { "text": "unknown" }, "description": "The value to test." } ], "description": "Determines whether a value is a `DirtyMixin`." }, { "kind": "mixin", "description": "Mixin to augment an element with functionality used to mark it as dirty.", "name": "Dirty", "members": [ { "kind": "field", "name": "[_eventHandler]", "privacy": "private" }, { "kind": "field", "name": "dirty", "type": { "text": "boolean" }, "description": "Whether the user has modified the value of the element.", "readonly": true }, { "kind": "field", "name": "pristine", "type": { "text": "boolean" }, "description": "Whether the user has not modified the value of the element.", "readonly": true }, { "kind": "method", "name": "markAsPristine", "return": { "type": { "text": "void" } }, "description": "Marks the element as pristine." }, { "kind": "method", "name": "markAsDirty", "return": { "type": { "text": "void" } }, "description": "Marks the element as dirty." } ], "parameters": [ { "name": "base", "type": { "text": "T" }, "description": "The base class." } ] } ], "exports": [ { "kind": "js", "name": "isDirtyMixin", "declaration": { "name": "isDirtyMixin", "module": "../core/src/shared/mixins/Dirty.ts" } }, { "kind": "js", "name": "Dirty", "declaration": { "name": "Dirty", "module": "../core/src/shared/mixins/Dirty.ts" } } ] }, { "kind": "javascript-module", "path": "../core/src/shared/mixins/Disabled.ts", "declarations": [ { "kind": "function", "name": "isDisabledMixin", "return": { "type": { "text": "value is DisabledMixin" } }, "parameters": [ { "name": "value", "type": { "text": "unknown" }, "description": "The value to test." } ], "description": "Determines whether a value is a `DisabledMixin`." }, { "kind": "mixin", "description": "Mixin to augment an element with behavior that supports a disabled state.", "name": "Disabled", "members": [ { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Whether the element is disabled.", "attribute": "disabled" } ], "attributes": [ { "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Whether the element is disabled.", "fieldName": "disabled" } ], "parameters": [ { "name": "base", "type": { "text": "T" }, "description": "The base class." }, { "name": "reflect", "default": "true", "type": { "text": "boolean" }, "description": "Whether the disabled property is reflected as an attribute.", "optional": true } ] } ], "exports": [ { "kind": "js", "name": "isDisabledMixin", "declaration": { "name": "isDisabledMixin", "module": "../core/src/shared/mixins/Disabled.ts" } }, { "kind": "js", "name": "Disabled", "declaration": { "name": "Disabled", "module": "../core/src/shared/mixins/Disabled.ts" } } ] }, { "kind": "javascript-module", "path": "../core/src/shared/mixins/DisabledInteractive.ts", "declarations": [ { "kind": "function", "name": "isDisabledInteractiveMixin", "return": { "type": { "text": "value is DisabledInteractiveMixin" } }, "parameters": [ { "name": "value", "type": { "text": "unknown" }, "description": "The value to test." } ], "description": "Determines whether a value is a `DisabledInteractiveMixin`." }, { "kind": "mixin", "description": "Mixin to augment an element with behavior that supports an interactive disabled state.", "name": "DisabledInteractive", "members": [ { "kind": "field", "name": "[_suppressedEventHandler]", "privacy": "private", "readonly": true }, { "kind": "field", "name": "disabledInteractive", "type": { "text": "boolean" }, "default": "false", "description": "Whether the element is disabled and interactive.", "attribute": "disabled-interactive", "reflects": true } ], "attributes": [ { "name": "disabled-interactive", "type": { "text": "boolean" }, "default": "false", "description": "Whether the element is disabled and interactive.", "fieldName": "disabledInteractive" } ], "parameters": [ { "name": "base", "type": { "text": "T" }, "description": "The base class." } ] } ], "exports": [ { "kind": "js", "name": "isDisabledInteractiveMixin", "declaration": { "name": "isDisabledInteractiveMixin", "module": "../core/src/shared/mixins/DisabledInteractive.ts" } }, { "kind": "js", "name": "DisabledInteractive", "declaration": { "name": "DisabledInteractive", "module": "../core/src/shared/mixins/DisabledInteractive.ts" } } ] }, { "kind": "javascript-module", "path": "../core/src/shared/mixins/EventAttribute.ts", "declarations": [ { "kind": "mixin", "description": "Mixin that adds support for custom event attributes.", "name": "EventAttribute", "parameters": [ { "name": "base", "type": { "text": "T" }, "description": "The base class from which to inherit." }, { "name": "types", "type": { "text": "string[]" }, "description": "The types of event attributes." } ] } ], "exports": [ { "kind": "js", "name": "EventAttribute", "declaration": { "name": "EventAttribute", "module": "../core/src/shared/mixins/EventAttribute.ts" } } ] }, { "kind": "javascript-module", "path": "../core/src/shared/mixins/Focusable.ts", "declarations": [ { "kind": "mixin", "description": "Mixin to augment an element with behavior that supports a focused state.", "name": "Focusable", "members": [ { "kind": "field", "name": "[_tabindex]", "type": { "text": "number" }, "privacy": "private", "default": "0" } ], "parameters": [ { "name": "base", "type": { "text": "T" }, "description": "The base class." } ] } ], "exports": [ { "kind": "js", "name": "Focusable", "declaration": { "name": "Focusable", "module": "../core/src/shared/mixins/Focusable.ts" } } ] }, { "kind": "javascript-module", "path": "../core/src/shared/mixins/FormAssociated.ts", "declarations": [ { "kind": "variable", "name": "formValue", "description": "A symbol through which a \"Form Associated\" custom element provides a value for a form." }, { "kind": "variable", "name": "defaultValue", "description": "A symbol through which a \"Form Associated\" custom element provides a default value for resetting a form." }, { "kind": "function", "name": "isFormAssociatedMixin", "return": { "type": { "text": "" } }, "parameters": [ { "name": "value", "type": { "text": "unknown" }, "description": "The value to test." } ], "description": "Determines whether a value is a `FormAssociatedMixin`." }, { "kind": "mixin", "description": "Mixin to augment an element with \"Form Associated\" behavior.", "name": "FormAssociated", "members": [ { "kind": "field", "name": "formAssociated", "type": { "text": "boolean" }, "static": true, "readonly": true, "default": "true", "description": "Indicates that this custom element participates in form submission, validation, and form state restoration." }, { "kind": "field", "name": "[_defaultValue]", "type": { "text": "unknown" }, "privacy": "private" }, { "kind": "field", "name": "[_defaultIndeterminate]", "type": { "text": "boolean" }, "privacy": "private", "default": "false" }, { "kind": "field", "name": "[_formDisabled]", "type": { "text": "boolean" }, "privacy": "private", "default": "false" }, { "kind": "field", "name": "form", "type": { "text": "HTMLFormElement | null" }, "description": "The `HTMLFormElement` associated with this element.", "readonly": true }, { "kind": "field", "name": "labels", "type": { "text": "NodeListOf" }, "readonly": true }, { "kind": "field", "name": "name", "description": "The name that identifies the element when submitting the associated form.", "attribute": "name" }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "description": "Whether the element is disabled.", "default": "false", "attribute": "disabled" }, { "kind": "method", "name": "formDisabledCallback", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "disabled", "type": { "text": "boolean" } } ], "description": "Called when the element is disabled or enabled via its form association." }, { "kind": "method", "name": "formResetCallback", "return": { "type": { "text": "void" } }, "description": "Called when the associated form is reset." } ], "attributes": [ { "name": "name", "description": "The name that identifies the element when submitting the associated form.", "fieldName": "name" }, { "name": "disabled", "type": { "text": "boolean" }, "description": "Whether the element is disabled.", "default": "false", "fieldName": "disabled" } ], "parameters": [ { "name": "base", "type": { "text": "T" }, "description": "The base class." } ] } ], "exports": [ { "kind": "js", "name": "formValue", "declaration": { "name": "formValue", "module": "../core/src/shared/mixins/FormAssociated.ts" } }, { "kind": "js", "name": "defaultValue", "declaration": { "name": "defaultValue", "module": "../core/src/shared/mixins/FormAssociated.ts" } }, { "kind": "js", "name": "isFormAssociatedMixin", "declaration": { "name": "isFormAssociatedMixin", "module": "../core/src/shared/mixins/FormAssociated.ts" } }, { "kind": "js", "name": "FormAssociated", "declaration": { "name": "FormAssociated", "module": "../core/src/shared/mixins/FormAssociated.ts" } } ] }, { "kind": "javascript-module", "path": "../core/src/shared/mixins/FormSubmitter.ts", "declarations": [ { "kind": "function", "name": "isFormSubmitterMixin", "return": { "type": { "text": "value is FormSubmitterMixin" } }, "parameters": [ { "name": "value", "type": { "text": "unknown" }, "description": "The value to test." } ], "description": "Determines whether a value is a `FormSubmitterMixin`." }, { "kind": "mixin", "description": "Mixin to augment an element with behavior used to submit a form.", "name": "FormSubmitter", "members": [ { "kind": "field", "name": "formAssociated", "type": { "text": "boolean" }, "static": true, "readonly": true, "default": "true", "description": "Indicates that this custom element participates in form submission, validation, and form state restoration." }, { "kind": "field", "name": "name", "description": "The name of the element, submitted as a pair with the element's `value`\r\nas part of form data, when the element is used to submit a form.", "attribute": "name" }, { "kind": "field", "name": "value", "description": "The value associated with the element's name when it's submitted with form data.", "attribute": "value" }, { "kind": "field", "name": "type", "type": { "text": "FormSubmitterType" }, "default": "\"button\"", "description": "The type of the element.", "attribute": "type" }, { "kind": "field", "name": "[_clickHandler]", "privacy": "private" } ], "attributes": [ { "name": "name", "description": "The name of the element, submitted as a pair with the element's `value`\r\nas part of form data, when the element is used to submit a form.", "fieldName": "name" }, { "name": "value", "description": "The value associated with the element's name when it's submitted with form data.", "fieldName": "value" }, { "name": "type", "type": { "text": "FormSubmitterType" }, "default": "\"button\"", "description": "The type of the element.", "fieldName": "type" } ], "parameters": [ { "name": "base", "type": { "text": "T" }, "description": "The base class." } ] } ], "exports": [ { "kind": "js", "name": "isFormSubmitterMixin", "declaration": { "name": "isFormSubmitterMixin", "module": "../core/src/shared/mixins/FormSubmitter.ts" } }, { "kind": "js", "name": "FormSubmitter", "declaration": { "name": "FormSubmitter", "module": "../core/src/shared/mixins/FormSubmitter.ts" } } ] }, { "kind": "javascript-module", "path": "../core/src/shared/mixins/hasKeys.ts", "declarations": [ { "kind": "function", "name": "hasKeys", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "value", "type": { "text": "unknown" }, "description": "The value to test." }, { "name": "keys", "type": { "text": "Array" } }, { "description": ": Array} keys The keys of `T` to test.", "name": "", "type": { "text": "...keys" } } ], "description": "Determines whether an object has keys for a given type." } ], "exports": [ { "kind": "js", "name": "hasKeys", "declaration": { "name": "hasKeys", "module": "../core/src/shared/mixins/hasKeys.ts" } } ] }, { "kind": "javascript-module", "path": "../core/src/shared/mixins/HtmlFor.ts", "declarations": [ { "kind": "function", "name": "isHtmlForMixin", "return": { "type": { "text": "value is HtmlForMixin" } }, "parameters": [ { "name": "value", "type": { "text": "unknown" }, "description": "The value to test." } ], "description": "Determines whether a value is a `HtmlForMixin`." }, { "kind": "mixin", "description": "Mixin that creates an attached element associated with an interactive control.", "name": "HtmlFor", "members": [ { "kind": "field", "name": "[_control]", "type": { "text": "HTMLElement | null" }, "privacy": "private", "default": "null" }, { "kind": "field", "name": "[_firstUpdated]", "type": { "text": "boolean" }, "privacy": "private", "default": "false" }, { "kind": "field", "name": "htmlFor", "type": { "text": "string | null" }, "default": "null", "description": "The identifier of the interactive control to which this element is attached.", "attribute": "for" }, { "kind": "field", "name": "control", "description": "The interactive element to which this element is attached.", "readonly": true }, { "kind": "method", "name": "attach", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "control", "type": { "text": "HTMLElement" }, "description": "The element that controls the attachable element." } ], "description": "Attaches the element to an interactive control." }, { "kind": "method", "name": "detach", "return": { "type": { "text": "void" } }, "description": "Detaches the element from its current interactive control." } ], "attributes": [ { "name": "for", "type": { "text": "string | null" }, "default": "null", "description": "The identifier of the interactive control to which this element is attached.", "fieldName": "htmlFor" } ], "parameters": [ { "name": "base", "type": { "text": "T" }, "description": "The base class." } ] } ], "exports": [ { "kind": "js", "name": "isHtmlForMixin", "declaration": { "name": "isHtmlForMixin", "module": "../core/src/shared/mixins/HtmlFor.ts" } }, { "kind": "js", "name": "HtmlFor", "declaration": { "name": "HtmlFor", "module": "../core/src/shared/mixins/HtmlFor.ts" } } ] }, { "kind": "javascript-module", "path": "../core/src/shared/mixins/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "\"./AttachInternals\"" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "\"./Checked\"" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "\"./CheckedIndeterminate\"" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "\"./CheckedOrSelected\"" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "\"./ConstraintValidation\"" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "\"./Dirty\"" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "\"./Disabled\"" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "\"./DisabledInteractive\"" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "\"./EventAttribute\"" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "\"./Focusable\"" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "\"./FormAssociated\"" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "\"./FormSubmitter\"" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "\"./hasKeys\"" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "\"./HtmlFor\"" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "\"./KeyboardClick\"" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "\"./Labelled\"" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "\"./LinkButton\"" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "\"./ReadOnly\"" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "\"./Required\"" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "\"./RequiredConstraintValidation\"" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "\"./Role\"" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "\"./Selected\"" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "\"./Touched\"" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "\"./Vertical\"" } } ] }, { "kind": "javascript-module", "path": "../core/src/shared/mixins/KeyboardClick.ts", "declarations": [ { "kind": "mixin", "description": "Mixin to augment an element with behavior emits a click event on keyboard events.", "name": "KeyboardClick", "members": [ { "kind": "field", "name": "#keyPressed", "privacy": "private", "type": { "text": "boolean" }, "default": "false" }, { "kind": "field", "name": "#keyDownHandler", "privacy": "private", "readonly": true }, { "kind": "field", "name": "#keyUpHandler", "privacy": "private", "readonly": true }, { "kind": "field", "name": "#focusOutHandler", "privacy": "private", "readonly": true }, { "kind": "method", "name": "#handleKeyDown", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "e", "type": { "text": "KeyboardEvent" } } ] }, { "kind": "method", "name": "#handleKeyUp", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "e", "type": { "text": "KeyboardEvent" } } ] } ], "events": [ { "name": "click", "type": { "text": "MouseEvent" } } ], "parameters": [ { "name": "base", "type": { "text": "T" }, "description": "The base class." }, { "name": "allowEnter", "default": "true", "type": { "text": "boolean" }, "description": "Whether the `ENTER` key emits a click event.", "optional": true } ] } ], "exports": [ { "kind": "js", "name": "KeyboardClick", "declaration": { "name": "KeyboardClick", "module": "../core/src/shared/mixins/KeyboardClick.ts" } } ] }, { "kind": "javascript-module", "path": "../core/src/shared/mixins/Labelled.ts", "declarations": [ { "kind": "variable", "name": "updateLabels", "description": "A symbol through which to update labels to reflect a control's current state." }, { "kind": "function", "name": "isLabelledMixin", "return": { "type": { "text": "" } }, "parameters": [ { "name": "value", "type": { "text": "unknown" }, "description": "The value to test." } ], "description": "Determines whether a value is a `LabelledMixin`." }, { "kind": "mixin", "description": "Mixin to augment an element with support for labelling.", "name": "Labelled", "members": [ { "kind": "field", "name": "formAssociated", "type": { "text": "boolean" }, "static": true, "readonly": true, "default": "true", "description": "Indicates that this custom element participates in form submission, validation, and form state restoration." }, { "kind": "field", "name": "[_eventHandler]", "privacy": "private", "readonly": true }, { "kind": "field", "name": "labels", "type": { "text": "NodeListOf" }, "description": "The label elements that the element is associated with.", "readonly": true } ], "parameters": [ { "name": "base", "type": { "text": "T" }, "description": "The base class." } ] } ], "exports": [ { "kind": "js", "name": "updateLabels", "declaration": { "name": "updateLabels", "module": "../core/src/shared/mixins/Labelled.ts" } }, { "kind": "js", "name": "isLabelledMixin", "declaration": { "name": "isLabelledMixin", "module": "../core/src/shared/mixins/Labelled.ts" } }, { "kind": "js", "name": "Labelled", "declaration": { "name": "Labelled", "module": "../core/src/shared/mixins/Labelled.ts" } } ] }, { "kind": "javascript-module", "path": "../core/src/shared/mixins/LinkButton.ts", "declarations": [ { "kind": "variable", "name": "renderPseudoLink", "description": "A symbol through which to access a function used to render a pseudo link." }, { "kind": "function", "name": "isLinkButtonMixin", "return": { "type": { "text": "value is LinkButtonMixin" } }, "parameters": [ { "name": "value", "type": { "text": "unknown" }, "description": "The value to test." } ], "description": "Determines whether a value is a `LinkButtonMixin`." }, { "kind": "mixin", "description": "Mixin to augment an element with behavior that supports functioning as a link.", "name": "LinkButton", "members": [ { "kind": "field", "name": "[_clickHandler]", "privacy": "private" }, { "kind": "field", "name": "href", "type": { "text": "string" }, "default": "\"\"", "description": "The URL to which the link button points.", "attribute": "href" }, { "kind": "field", "name": "target", "type": { "text": "LinkTarget" }, "default": "\"\"", "description": "The target of the link button.", "attribute": "target" }, { "kind": "field", "name": "rel", "type": { "text": "string" }, "default": "\"\"", "description": "The relationship between the `target` of the link button and the document.", "attribute": "rel" }, { "kind": "field", "name": "download", "type": { "text": "string | null" }, "description": "A value indicating whether the `target` of the link button will be downloaded,\r\noptionally specifying the new name of the file.", "default": "null", "attribute": "download" }, { "kind": "method", "name": "#handleLinkPointerDown", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "e", "type": { "text": "PointerEvent" } } ] }, { "kind": "method", "name": "#handleLinkFocus", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "e", "type": { "text": "Event" } } ] }, { "kind": "method", "name": "#handleLinkBlur", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "e", "type": { "text": "Event" } } ] } ], "events": [ { "name": "click", "type": { "text": "MouseEvent" } } ], "attributes": [ { "name": "href", "type": { "text": "string" }, "default": "\"\"", "description": "The URL to which the link button points.", "fieldName": "href" }, { "name": "target", "type": { "text": "LinkTarget" }, "default": "\"\"", "description": "The target of the link button.", "fieldName": "target" }, { "name": "rel", "type": { "text": "string" }, "default": "\"\"", "description": "The relationship between the `target` of the link button and the document.", "fieldName": "rel" }, { "name": "download", "type": { "text": "string | null" }, "description": "A value indicating whether the `target` of the link button will be downloaded,\r\noptionally specifying the new name of the file.", "default": "null", "fieldName": "download" } ], "parameters": [ { "name": "base", "type": { "text": "T" }, "description": "The base class." } ] } ], "exports": [ { "kind": "js", "name": "renderPseudoLink", "declaration": { "name": "renderPseudoLink", "module": "../core/src/shared/mixins/LinkButton.ts" } }, { "kind": "js", "name": "isLinkButtonMixin", "declaration": { "name": "isLinkButtonMixin", "module": "../core/src/shared/mixins/LinkButton.ts" } }, { "kind": "js", "name": "LinkButton", "declaration": { "name": "LinkButton", "module": "../core/src/shared/mixins/LinkButton.ts" } } ] }, { "kind": "javascript-module", "path": "../core/src/shared/mixins/ReadOnly.ts", "declarations": [ { "kind": "function", "name": "isReadOnlyMixin", "return": { "type": { "text": "" } }, "parameters": [ { "name": "value", "type": { "text": "unknown" }, "description": "The value to test." } ], "description": "Determines whether a value is a `ReadOnlyMixin`." }, { "kind": "mixin", "description": "Mixin to augment an element with behavior that supports a read-only state.", "name": "ReadOnly", "members": [ { "kind": "field", "name": "readOnly", "type": { "text": "boolean" }, "default": "false", "description": "A value indicating whether the element is read-only.", "attribute": "readonly" } ], "attributes": [ { "name": "readonly", "type": { "text": "boolean" }, "default": "false", "description": "A value indicating whether the element is read-only.", "fieldName": "readOnly" } ], "parameters": [ { "name": "base", "type": { "text": "T" }, "description": "The base class." }, { "name": "reflect", "default": "true", "type": { "text": "boolean" }, "description": "A value indicating whether the read-only state is reflected as an attribute. The default value is `true`." } ] } ], "exports": [ { "kind": "js", "name": "isReadOnlyMixin", "declaration": { "name": "isReadOnlyMixin", "module": "../core/src/shared/mixins/ReadOnly.ts" } }, { "kind": "js", "name": "ReadOnly", "declaration": { "name": "ReadOnly", "module": "../core/src/shared/mixins/ReadOnly.ts" } } ] }, { "kind": "javascript-module", "path": "../core/src/shared/mixins/Required.ts", "declarations": [ { "kind": "function", "name": "isRequiredMixin", "return": { "type": { "text": "" } }, "parameters": [ { "name": "value", "type": { "text": "unknown" }, "description": "The value to test." } ], "description": "Determines whether a value is a `RequiredMixin`." }, { "kind": "mixin", "description": "Mixin to augment an element with behavior that supports a required state.", "name": "Required", "members": [ { "kind": "field", "name": "required", "type": { "text": "boolean" }, "default": "false", "description": "Whether a value is required for the element.", "attribute": "required", "reflects": true }, { "kind": "field", "name": "optional", "description": "Whether a value is not required for the element.", "readonly": true } ], "attributes": [ { "name": "required", "type": { "text": "boolean" }, "default": "false", "description": "Whether a value is required for the element.", "fieldName": "required" } ], "parameters": [ { "name": "base", "type": { "text": "T" }, "description": "The base class." } ] } ], "exports": [ { "kind": "js", "name": "isRequiredMixin", "declaration": { "name": "isRequiredMixin", "module": "../core/src/shared/mixins/Required.ts" } }, { "kind": "js", "name": "Required", "declaration": { "name": "Required", "module": "../core/src/shared/mixins/Required.ts" } } ] }, { "kind": "javascript-module", "path": "../core/src/shared/mixins/RequiredConstraintValidation.ts", "declarations": [ { "kind": "function", "name": "isRequiredConstraintValidationMixin", "return": { "type": { "text": "" } }, "parameters": [ { "name": "value", "type": { "text": "unknown" }, "description": "The value to test." } ], "description": "Determines whether a value is a `RequiredConstraintValidationMixin`." }, { "kind": "mixin", "description": "Mixin to augment an element with behavior that supports a required state.", "name": "RequiredConstraintValidation", "parameters": [ { "name": "base", "type": { "text": "T" }, "description": "The base class." } ] } ], "exports": [ { "kind": "js", "name": "isRequiredConstraintValidationMixin", "declaration": { "name": "isRequiredConstraintValidationMixin", "module": "../core/src/shared/mixins/RequiredConstraintValidation.ts" } }, { "kind": "js", "name": "RequiredConstraintValidation", "declaration": { "name": "RequiredConstraintValidation", "module": "../core/src/shared/mixins/RequiredConstraintValidation.ts" } } ] }, { "kind": "javascript-module", "path": "../core/src/shared/mixins/Role.ts", "declarations": [ { "kind": "mixin", "description": "Mixin to augment an element with an ARIA role.", "name": "Role", "parameters": [ { "name": "base", "type": { "text": "T" }, "description": "The base class." }, { "name": "role", "type": { "text": "ARIARole" }, "description": "The ARIA role." } ] } ], "exports": [ { "kind": "js", "name": "Role", "declaration": { "name": "Role", "module": "../core/src/shared/mixins/Role.ts" } } ] }, { "kind": "javascript-module", "path": "../core/src/shared/mixins/Selected.ts", "declarations": [ { "kind": "function", "name": "isSelectedMixin", "return": { "type": { "text": "" } }, "parameters": [ { "name": "value", "type": { "text": "unknown" }, "description": "The value to test." } ], "description": "Determines whether a value is a `SelectedMixin`." }, { "kind": "mixin", "description": "Mixin to augment an element with behavior that supports a selected state.", "name": "Selected", "members": [ { "kind": "field", "name": "selected", "type": { "text": "boolean" }, "default": "false", "description": "Whether the element is selected.", "attribute": "selected", "reflects": true } ], "attributes": [ { "name": "selected", "type": { "text": "boolean" }, "default": "false", "description": "Whether the element is selected.", "fieldName": "selected" } ], "parameters": [ { "name": "base", "type": { "text": "T" }, "description": "The base class." } ] } ], "exports": [ { "kind": "js", "name": "isSelectedMixin", "declaration": { "name": "isSelectedMixin", "module": "../core/src/shared/mixins/Selected.ts" } }, { "kind": "js", "name": "Selected", "declaration": { "name": "Selected", "module": "../core/src/shared/mixins/Selected.ts" } } ] }, { "kind": "javascript-module", "path": "../core/src/shared/mixins/Touched.ts", "declarations": [ { "kind": "function", "name": "isTouchedMixin", "return": { "type": { "text": "" } }, "parameters": [ { "name": "value", "type": { "text": "unknown" }, "description": "The value to test." } ], "description": "Determines whether a value is a `TouchedMixin`." }, { "kind": "mixin", "description": "Mixin to augment an element with functionality used to mark it as touched.", "name": "Touched", "members": [ { "kind": "field", "name": "[_eventHandler]", "privacy": "private" }, { "kind": "field", "name": "touched", "type": { "text": "boolean" }, "description": "Whether the user has interacted when the element.", "readonly": true }, { "kind": "field", "name": "untouched", "type": { "text": "boolean" }, "description": "Whether the user has not interacted when the element.", "readonly": true }, { "kind": "method", "name": "markAsTouched", "return": { "type": { "text": "void" } }, "description": "Marks the element as touched." }, { "kind": "method", "name": "markAsUntouched", "return": { "type": { "text": "void" } }, "description": "Marks the element as untouched." } ], "parameters": [ { "name": "base", "type": { "text": "T" }, "description": "The base class." } ] } ], "exports": [ { "kind": "js", "name": "isTouchedMixin", "declaration": { "name": "isTouchedMixin", "module": "../core/src/shared/mixins/Touched.ts" } }, { "kind": "js", "name": "Touched", "declaration": { "name": "Touched", "module": "../core/src/shared/mixins/Touched.ts" } } ] }, { "kind": "javascript-module", "path": "../core/src/shared/mixins/Vertical.ts", "declarations": [ { "kind": "function", "name": "isVerticalMixin", "return": { "type": { "text": "" } }, "parameters": [ { "name": "value", "type": { "text": "unknown" }, "description": "The value to test." } ], "description": "Determines whether a value is a `VerticalMixin`." }, { "kind": "mixin", "description": "Mixin to augment an element with behavior that supports a vertical orientation.", "name": "Vertical", "members": [ { "kind": "field", "name": "vertical", "type": { "text": "boolean" }, "default": "false", "description": "Whether the element is oriented vertically.", "attribute": "vertical", "reflects": true } ], "attributes": [ { "name": "vertical", "type": { "text": "boolean" }, "default": "false", "description": "Whether the element is oriented vertically.", "fieldName": "vertical" } ], "parameters": [ { "name": "base", "type": { "text": "T" }, "description": "The base class." } ] } ], "exports": [ { "kind": "js", "name": "isVerticalMixin", "declaration": { "name": "isVerticalMixin", "module": "../core/src/shared/mixins/Vertical.ts" } }, { "kind": "js", "name": "Vertical", "declaration": { "name": "Vertical", "module": "../core/src/shared/mixins/Vertical.ts" } } ] } ] }