@vonage/vivid-react
Version:
Vivid wrapped for easy React usage & IDE autocomplete support & typescript typings
565 lines (560 loc) • 14 kB
JavaScript
/*
* DO NOT EDIT THIS FILE. IT IS GENERATED
*/
/*
Code in this file were generated using following JSON:
{
"kind": "class",
"description": "A Button Custom HTML Element.\nBased largely on the https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button | <button> element .",
"name": "VividFoundationButton",
"cssParts": [
{
"description": "The button element",
"name": "control"
},
{
"description": "The element wrapping button content",
"name": "content"
}
],
"members": [
{
"kind": "field",
"name": "autofocus",
"type": {
"text": "boolean"
},
"privacy": "public",
"description": "Determines if the element should receive document focus on page load."
},
{
"kind": "field",
"name": "formId",
"type": {
"text": "string"
},
"privacy": "public",
"description": "The id of a form to associate the element to."
},
{
"kind": "field",
"name": "formaction",
"type": {
"text": "string"
},
"privacy": "public",
"description": "See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button | <button> element for more details."
},
{
"kind": "method",
"name": "formactionChanged",
"privacy": "private",
"return": {
"type": {
"text": "void"
}
}
},
{
"kind": "field",
"name": "formenctype",
"type": {
"text": "string"
},
"privacy": "public",
"description": "See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button | <button> element for more details."
},
{
"kind": "method",
"name": "formenctypeChanged",
"privacy": "private",
"return": {
"type": {
"text": "void"
}
}
},
{
"kind": "field",
"name": "formmethod",
"type": {
"text": "string"
},
"privacy": "public",
"description": "See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button | <button> element for more details."
},
{
"kind": "method",
"name": "formmethodChanged",
"privacy": "private",
"return": {
"type": {
"text": "void"
}
}
},
{
"kind": "field",
"name": "formnovalidate",
"type": {
"text": "boolean"
},
"privacy": "public",
"description": "See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button | <button> element for more details."
},
{
"kind": "method",
"name": "formnovalidateChanged",
"privacy": "private",
"return": {
"type": {
"text": "void"
}
}
},
{
"kind": "field",
"name": "formtarget",
"type": {
"text": "'_self' | '_blank' | '_parent' | '_top'"
},
"privacy": "public",
"description": "See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button | <button> element for more details."
},
{
"kind": "method",
"name": "formtargetChanged",
"privacy": "private",
"return": {
"type": {
"text": "void"
}
}
},
{
"kind": "field",
"name": "type",
"type": {
"text": "'submit' | 'reset' | 'button'"
},
"privacy": "public",
"description": "The button type."
},
{
"kind": "method",
"name": "typeChanged",
"privacy": "private",
"return": {
"type": {
"text": "void"
}
},
"parameters": [
{
"name": "previous",
"type": {
"text": "'submit' | 'reset' | 'button' | void"
}
},
{
"name": "next",
"type": {
"text": "'submit' | 'reset' | 'button'"
}
}
]
},
{
"kind": "method",
"name": "validate",
"privacy": "public",
"return": {
"type": {
"text": "void"
}
},
"description": "{@inheritDoc (FormAssociated:interface).validate}"
},
{
"kind": "field",
"name": "handleSubmission",
"privacy": "private",
"description": "Submits the parent form"
},
{
"kind": "field",
"name": "handleFormReset",
"privacy": "private",
"description": "Resets the parent form"
},
{
"kind": "field",
"name": "control",
"type": {
"text": "HTMLButtonElement"
},
"privacy": "public"
},
{
"kind": "field",
"name": "handleUnsupportedDelegatesFocus",
"privacy": "private",
"description": "Overrides the focus call for where delegatesFocus is unsupported.\nThis check works for Chrome, Edge Chromium, FireFox, and Safari\nRelevant PR on the Firefox browser: https://phabricator.services.mozilla.com/D123858"
},
{
"kind": "field",
"name": "_vividAriaBehaviour",
"default": "'delegate'",
"type": {
"text": "'delegate'"
},
"inheritedFrom": {
"name": "DelegatesAria",
"module": "src/shared/aria/delegates-aria.ts"
}
},
{
"kind": "field",
"name": "validity",
"type": {
"text": "ValidityState"
},
"description": "Returns the validity state of the element",
"readonly": true,
"inheritedFrom": {
"name": "FormAssociated",
"module": "src/shared/foundation/form-associated/form-associated.ts"
}
},
{
"kind": "field",
"name": "form",
"type": {
"text": "HTMLFormElement | null"
},
"description": "Retrieve a reference to the associated form.\nReturns null if not associated to any form.",
"readonly": true,
"inheritedFrom": {
"name": "FormAssociated",
"module": "src/shared/foundation/form-associated/form-associated.ts"
}
},
{
"kind": "field",
"name": "validationMessage",
"type": {
"text": "string"
},
"description": "Retrieve the localized validation message,\nor custom validation message if set.",
"readonly": true,
"inheritedFrom": {
"name": "FormAssociated",
"module": "src/shared/foundation/form-associated/form-associated.ts"
}
},
{
"kind": "field",
"name": "willValidate",
"type": {
"text": "boolean"
},
"description": "Whether the element will be validated when the\nform is submitted",
"readonly": true,
"inheritedFrom": {
"name": "FormAssociated",
"module": "src/shared/foundation/form-associated/form-associated.ts"
}
},
{
"kind": "field",
"name": "labels",
"type": {
"text": "ReadonlyArray<Node>"
},
"description": "A reference to all associated label elements",
"readonly": true,
"inheritedFrom": {
"name": "FormAssociated",
"module": "src/shared/foundation/form-associated/form-associated.ts"
}
},
{
"kind": "field",
"name": "value",
"type": {
"text": "string"
},
"description": "The current value of the element.",
"inheritedFrom": {
"name": "FormAssociated",
"module": "src/shared/foundation/form-associated/form-associated.ts"
}
},
{
"kind": "field",
"name": "currentValue",
"inheritedFrom": {
"name": "FormAssociated",
"module": "src/shared/foundation/form-associated/form-associated.ts"
}
},
{
"kind": "field",
"name": "initialValue",
"type": {
"text": "string"
},
"description": "The default value of the element. This value sets the `value` property\nonly when the `value` property has not been explicitly set.",
"inheritedFrom": {
"name": "FormAssociated",
"module": "src/shared/foundation/form-associated/form-associated.ts"
}
},
{
"kind": "field",
"name": "disabled",
"type": {
"text": "boolean"
},
"default": "false",
"description": "Sets the element's disabled state. A disabled element will not be included during form submission.",
"inheritedFrom": {
"name": "FormAssociated",
"module": "src/shared/foundation/form-associated/form-associated.ts"
}
},
{
"kind": "field",
"name": "name",
"type": {
"text": "string"
},
"description": "The name of the element. This element's value will be surfaced during form submission under the provided name.",
"inheritedFrom": {
"name": "FormAssociated",
"module": "src/shared/foundation/form-associated/form-associated.ts"
}
},
{
"kind": "field",
"name": "required",
"type": {
"text": "boolean"
},
"description": "Require the field to be completed prior to form submission.",
"default": "false",
"inheritedFrom": {
"name": "FormAssociated",
"module": "src/shared/foundation/form-associated/form-associated.ts"
}
},
{
"kind": "method",
"name": "checkValidity",
"return": {
"type": {
"text": "boolean"
}
},
"description": "Return the current validity of the element.",
"inheritedFrom": {
"name": "FormAssociated",
"module": "src/shared/foundation/form-associated/form-associated.ts"
}
},
{
"kind": "method",
"name": "reportValidity",
"return": {
"type": {
"text": "boolean"
}
},
"description": "Return the current validity of the element.\nIf false, fires an invalid event at the element.",
"inheritedFrom": {
"name": "FormAssociated",
"module": "src/shared/foundation/form-associated/form-associated.ts"
}
},
{
"kind": "field",
"name": "VIVID_VERSION",
"static": true,
"default": "__PACKAGE_VERSION__",
"description": "The current version of the Vivid library, which is useful for debugging.\nIt can be accessed from any Vivid element via `<el>.constructor.VIVID_VERSION`.",
"type": {
"text": "string"
},
"inheritedFrom": {
"name": "VividElement",
"module": "src/shared/foundation/vivid-element/vivid-element.ts"
}
},
{
"kind": "field",
"name": "componentName",
"type": {
"text": "string"
},
"static": true,
"description": "Core component name, without prefix",
"inheritedFrom": {
"name": "VividElement",
"module": "src/shared/foundation/vivid-element/vivid-element.ts"
}
}
],
"attributes": [
{
"name": "autofocus",
"type": {
"text": "boolean"
},
"description": "Determines if the element should receive document focus on page load.",
"fieldName": "autofocus"
},
{
"name": "form",
"type": {
"text": "string"
},
"description": "The id of a form to associate the element to.",
"fieldName": "formId"
},
{
"name": "formaction",
"type": {
"text": "string"
},
"description": "See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button | <button> element for more details.",
"fieldName": "formaction"
},
{
"name": "formenctype",
"type": {
"text": "string"
},
"description": "See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button | <button> element for more details.",
"fieldName": "formenctype"
},
{
"name": "formmethod",
"type": {
"text": "string"
},
"description": "See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button | <button> element for more details.",
"fieldName": "formmethod"
},
{
"name": "formnovalidate",
"type": {
"text": "boolean"
},
"description": "See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button | <button> element for more details.",
"fieldName": "formnovalidate"
},
{
"name": "formtarget",
"type": {
"text": "'_self' | '_blank' | '_parent' | '_top'"
},
"description": "See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button | <button> element for more details.",
"fieldName": "formtarget"
},
{
"name": "type",
"type": {
"text": "'submit' | 'reset' | 'button'"
},
"description": "The button type.",
"fieldName": "type"
},
{
"name": "current-value",
"type": {
"text": "string"
},
"description": "The current value of the element.",
"fieldName": "value",
"inheritedFrom": {
"name": "FormAssociated",
"module": "src/shared/foundation/form-associated/form-associated.ts"
}
},
{
"name": "value",
"type": {
"text": "string"
},
"description": "The default value of the element. This value sets the `value` property\nonly when the `value` property has not been explicitly set.",
"fieldName": "initialValue",
"inheritedFrom": {
"name": "FormAssociated",
"module": "src/shared/foundation/form-associated/form-associated.ts"
}
},
{
"name": "disabled",
"type": {
"text": "boolean"
},
"default": "false",
"description": "Sets the element's disabled state. A disabled element will not be included during form submission.",
"fieldName": "disabled",
"inheritedFrom": {
"name": "FormAssociated",
"module": "src/shared/foundation/form-associated/form-associated.ts"
}
},
{
"name": "name",
"type": {
"text": "string"
},
"description": "The name of the element. This element's value will be surfaced during form submission under the provided name.",
"fieldName": "name",
"inheritedFrom": {
"name": "FormAssociated",
"module": "src/shared/foundation/form-associated/form-associated.ts"
}
},
{
"name": "required",
"type": {
"text": "boolean"
},
"description": "Require the field to be completed prior to form submission.",
"default": "false",
"fieldName": "required",
"inheritedFrom": {
"name": "FormAssociated",
"module": "src/shared/foundation/form-associated/form-associated.ts"
}
}
],
"mixins": [
{
"name": "DelegatesAria",
"module": "/src/shared/aria/delegates-aria"
},
{
"name": "FormAssociated",
"module": "/src/shared/foundation/form-associated/form-associated"
}
],
"superclass": {
"name": "VividElement",
"module": "/src/shared/foundation/vivid-element/vivid-element"
}
}
*/
import wrapper from '@vonage/vivid-react-wrapper'
import { registerVividFoundationButton } from '@vonage/vivid'
registerVividFoundationButton('vvd3')
const VwcVividFoundationButton = wrapper(`vvd3-vivid-foundation-button`, {
events: [],
attributes: [],
properties: ['autofocus', 'formId', 'formaction', 'formenctype', 'formmethod', 'formnovalidate', 'formtarget', 'type', 'control', '_vividAriaBehaviour', 'value', 'currentValue', 'initialValue', 'disabled', 'name', 'required', 'VIVID_VERSION', 'componentName']
})
VwcVividFoundationButton.displayName = 'VwcVividFoundationButton'
export default VwcVividFoundationButton