@vonage/vivid-react
Version:
Vivid wrapped for easy React usage & IDE autocomplete support & typescript typings
1,266 lines (1,261 loc) • 32.1 kB
JavaScript
/*
* DO NOT EDIT THIS FILE. IT IS GENERATED
*/
/*
Code in this file were generated using following JSON:
{
"kind": "class",
"description": "",
"name": "Button",
"cssProperties": [
{
"name": "--vvd-button-cta-primary",
"default": "var(--vvd-color-cta-500)"
},
{
"name": "--vvd-button-cta-primary-text",
"default": "var(--vvd-color-canvas)"
},
{
"name": "--vvd-button-cta-primary-increment",
"default": "var(--vvd-color-cta-600)"
},
{
"name": "--vvd-button-cta-contrast",
"default": "var(--vvd-color-cta-800)"
},
{
"name": "--vvd-button-cta-fierce",
"default": "var(--vvd-color-cta-700)"
},
{
"name": "--vvd-button-cta-firm",
"default": "var(--vvd-color-cta-600)"
},
{
"name": "--vvd-button-cta-soft",
"default": "var(--vvd-color-cta-100)"
},
{
"name": "--vvd-button-cta-faint",
"default": "var(--vvd-color-cta-50)"
},
{
"name": "--vvd-button-cta-fierce-primary",
"default": "var(--vvd-color-cta-700)"
},
{
"name": "--vvd-button-success-primary",
"default": "var(--vvd-color-success-500)"
},
{
"name": "--vvd-button-success-primary-text",
"default": "var(--vvd-color-canvas)"
},
{
"name": "--vvd-button-success-primary-increment",
"default": "var(--vvd-color-success-600)"
},
{
"name": "--vvd-button-success-contrast",
"default": "var(--vvd-color-success-800)"
},
{
"name": "--vvd-button-success-fierce",
"default": "var(--vvd-color-success-700)"
},
{
"name": "--vvd-button-success-firm",
"default": "var(--vvd-color-success-600)"
},
{
"name": "--vvd-button-success-soft",
"default": "var(--vvd-color-success-100)"
},
{
"name": "--vvd-button-success-faint",
"default": "var(--vvd-color-success-50)"
},
{
"name": "--vvd-button-success-fierce-primary",
"default": "var(--vvd-color-success-700)"
},
{
"name": "--vvd-button-alert-primary",
"default": "var(--vvd-color-alert-500)"
},
{
"name": "--vvd-button-alert-primary-text",
"default": "var(--vvd-color-canvas)"
},
{
"name": "--vvd-button-alert-primary-increment",
"default": "var(--vvd-color-alert-600)"
},
{
"name": "--vvd-button-alert-contrast",
"default": "var(--vvd-color-alert-800)"
},
{
"name": "--vvd-button-alert-fierce",
"default": "var(--vvd-color-alert-700)"
},
{
"name": "--vvd-button-alert-firm",
"default": "var(--vvd-color-alert-600)"
},
{
"name": "--vvd-button-alert-soft",
"default": "var(--vvd-color-alert-100)"
},
{
"name": "--vvd-button-alert-faint",
"default": "var(--vvd-color-alert-50)"
},
{
"name": "--vvd-button-alert-fierce-primary",
"default": "var(--vvd-color-alert-700)"
},
{
"name": "--vvd-button-announcement-primary",
"default": "var(--vvd-color-announcement-500)"
},
{
"name": "--vvd-button-announcement-primary-text",
"default": "var(--vvd-color-canvas)"
},
{
"name": "--vvd-button-announcement-primary-increment",
"default": "var(--vvd-color-announcement-600)"
},
{
"name": "--vvd-button-announcement-contrast",
"default": "var(--vvd-color-announcement-800)"
},
{
"name": "--vvd-button-announcement-fierce",
"default": "var(--vvd-color-announcement-700)"
},
{
"name": "--vvd-button-announcement-firm",
"default": "var(--vvd-color-announcement-600)"
},
{
"name": "--vvd-button-announcement-soft",
"default": "var(--vvd-color-announcement-100)"
},
{
"name": "--vvd-button-announcement-faint",
"default": "var(--vvd-color-announcement-50)"
},
{
"name": "--vvd-button-announcement-fierce-primary",
"default": "var(--vvd-color-announcement-700)"
},
{
"name": "--vvd-button-accent-primary",
"default": "var(--vvd-color-canvas-text)"
},
{
"name": "--vvd-button-accent-primary-text",
"default": "var(--vvd-color-canvas)"
},
{
"name": "--vvd-button-accent-primary-increment",
"default": "var(--vvd-color-neutral-800)"
},
{
"name": "--vvd-button-accent-contrast",
"default": "var(--vvd-color-neutral-800)"
},
{
"name": "--vvd-button-accent-fierce",
"default": "var(--vvd-color-neutral-700)"
},
{
"name": "--vvd-button-accent-firm",
"default": "var(--vvd-color-canvas-text)"
},
{
"name": "--vvd-button-accent-soft",
"default": "var(--vvd-color-neutral-100)"
},
{
"name": "--vvd-button-accent-faint",
"default": "var(--vvd-color-neutral-50)"
},
{
"name": "--vvd-button-accent-fierce-primary",
"default": "var(--vvd-color-canvas-text)"
}
],
"slots": [
{
"description": "The preferred way to add an icon to the component.",
"name": "icon"
}
],
"members": [
{
"kind": "field",
"name": "title",
"type": {
"text": "string"
},
"description": "Specifies extra information about the button. This information is typically used by browsers to display a tooltip.",
"default": "''"
},
{
"kind": "field",
"name": "connotation",
"type": {
"text": "ButtonConnotation | undefined"
},
"description": "The connotation the button should have.",
"privacy": "public"
},
{
"kind": "field",
"name": "shape",
"type": {
"text": "ButtonShape | undefined"
},
"description": "The shape the button should have.",
"privacy": "public"
},
{
"kind": "field",
"name": "appearance",
"type": {
"text": "ButtonAppearance | undefined"
},
"description": "The appearance the button should have.",
"privacy": "public"
},
{
"kind": "field",
"name": "size",
"type": {
"text": "ButtonSize | undefined"
},
"description": "The size the button should have.",
"privacy": "public"
},
{
"kind": "field",
"name": "stacked",
"type": {
"text": "boolean"
},
"default": "false",
"description": "Indicates the icon is stacked.",
"privacy": "public"
},
{
"kind": "field",
"name": "pending",
"type": {
"text": "boolean"
},
"default": "false",
"description": "Displays the button in pending state.",
"privacy": "public"
},
{
"kind": "field",
"name": "dropdownIndicator",
"type": {
"text": "boolean"
},
"default": "false",
"description": "Display a chevron to indicate that the button opens a dropdown.",
"privacy": "public"
},
{
"kind": "field",
"name": "active",
"type": {
"text": "boolean"
},
"default": "false",
"description": "Displays the button in active state.",
"privacy": "public"
},
{
"kind": "field",
"name": "label",
"type": {
"text": "string | undefined"
},
"description": "Indicates the button's label.",
"privacy": "public"
},
{
"kind": "field",
"name": "iconTrailing",
"type": {
"text": "boolean"
},
"default": "false",
"description": "Indicates the icon affix alignment.",
"privacy": "public",
"inheritedFrom": {
"name": "AffixIconWithTrailing",
"module": "src/shared/patterns/affix.ts"
}
},
{
"kind": "field",
"name": "icon",
"type": {
"text": "string | undefined"
},
"description": "A decorative icon the custom element should have.",
"privacy": "public",
"inheritedFrom": {
"name": "AffixIcon",
"module": "src/shared/patterns/affix.ts"
}
},
{
"kind": "field",
"name": "download",
"type": {
"text": "string | undefined"
},
"description": "Prompts the user to save the linked URL. See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element for more information.",
"privacy": "public",
"inheritedFrom": {
"name": "Linkable",
"module": "src/shared/patterns/linkable.ts"
}
},
{
"kind": "field",
"name": "href",
"type": {
"text": "string | undefined"
},
"description": "The URL the hyperlink references. See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element for more information.",
"privacy": "public",
"inheritedFrom": {
"name": "Linkable",
"module": "src/shared/patterns/linkable.ts"
}
},
{
"kind": "field",
"name": "hreflang",
"type": {
"text": "string | undefined"
},
"description": "Hints at the language of the referenced resource. See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element for more information.",
"privacy": "public",
"inheritedFrom": {
"name": "Linkable",
"module": "src/shared/patterns/linkable.ts"
}
},
{
"kind": "field",
"name": "ping",
"type": {
"text": "string | undefined"
},
"description": "See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element for more information.",
"privacy": "public",
"inheritedFrom": {
"name": "Linkable",
"module": "src/shared/patterns/linkable.ts"
}
},
{
"kind": "field",
"name": "referrerpolicy",
"type": {
"text": "string | undefined"
},
"description": "See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element for more information.",
"privacy": "public",
"inheritedFrom": {
"name": "Linkable",
"module": "src/shared/patterns/linkable.ts"
}
},
{
"kind": "field",
"name": "rel",
"type": {
"text": "string | undefined"
},
"description": "See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element for more information.",
"privacy": "public",
"inheritedFrom": {
"name": "Linkable",
"module": "src/shared/patterns/linkable.ts"
}
},
{
"kind": "field",
"name": "target",
"type": {
"text": "'_self' | '_blank' | '_parent' | '_top' | undefined"
},
"description": "See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element for more information.",
"privacy": "public",
"inheritedFrom": {
"name": "Linkable",
"module": "src/shared/patterns/linkable.ts"
}
},
{
"kind": "field",
"name": "type",
"type": {
"text": "'submit' | 'reset' | 'button'"
},
"privacy": "public",
"description": "See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element for more information.",
"inheritedFrom": {
"name": "VividFoundationButton",
"module": "src/shared/foundation/button/button.ts"
}
},
{
"kind": "field",
"name": "control",
"type": {
"text": "HTMLButtonElement"
},
"privacy": "public",
"description": "References the root element",
"inheritedFrom": {
"name": "VividFoundationButton",
"module": "src/shared/foundation/button/button.ts"
}
},
{
"kind": "field",
"name": "_vividAriaBehaviour",
"default": "'delegate'",
"type": {
"text": "'delegate'"
},
"inheritedFrom": {
"name": "DelegatesAria",
"module": "src/shared/aria/delegates-aria.ts"
}
},
{
"kind": "field",
"name": "autofocus",
"type": {
"text": "boolean"
},
"privacy": "public",
"description": "Determines if the element should receive document focus on page load.",
"inheritedFrom": {
"name": "VividFoundationButton",
"module": "src/shared/foundation/button/button.ts"
}
},
{
"kind": "field",
"name": "formId",
"type": {
"text": "string"
},
"privacy": "public",
"description": "The id of a form to associate the element to.",
"inheritedFrom": {
"name": "VividFoundationButton",
"module": "src/shared/foundation/button/button.ts"
}
},
{
"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.",
"inheritedFrom": {
"name": "VividFoundationButton",
"module": "src/shared/foundation/button/button.ts"
}
},
{
"kind": "method",
"name": "formactionChanged",
"privacy": "private",
"return": {
"type": {
"text": "void"
}
},
"inheritedFrom": {
"name": "VividFoundationButton",
"module": "src/shared/foundation/button/button.ts"
}
},
{
"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.",
"inheritedFrom": {
"name": "VividFoundationButton",
"module": "src/shared/foundation/button/button.ts"
}
},
{
"kind": "method",
"name": "formenctypeChanged",
"privacy": "private",
"return": {
"type": {
"text": "void"
}
},
"inheritedFrom": {
"name": "VividFoundationButton",
"module": "src/shared/foundation/button/button.ts"
}
},
{
"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.",
"inheritedFrom": {
"name": "VividFoundationButton",
"module": "src/shared/foundation/button/button.ts"
}
},
{
"kind": "method",
"name": "formmethodChanged",
"privacy": "private",
"return": {
"type": {
"text": "void"
}
},
"inheritedFrom": {
"name": "VividFoundationButton",
"module": "src/shared/foundation/button/button.ts"
}
},
{
"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.",
"inheritedFrom": {
"name": "VividFoundationButton",
"module": "src/shared/foundation/button/button.ts"
}
},
{
"kind": "method",
"name": "formnovalidateChanged",
"privacy": "private",
"return": {
"type": {
"text": "void"
}
},
"inheritedFrom": {
"name": "VividFoundationButton",
"module": "src/shared/foundation/button/button.ts"
}
},
{
"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.",
"inheritedFrom": {
"name": "VividFoundationButton",
"module": "src/shared/foundation/button/button.ts"
}
},
{
"kind": "method",
"name": "formtargetChanged",
"privacy": "private",
"return": {
"type": {
"text": "void"
}
},
"inheritedFrom": {
"name": "VividFoundationButton",
"module": "src/shared/foundation/button/button.ts"
}
},
{
"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'"
}
}
],
"inheritedFrom": {
"name": "VividFoundationButton",
"module": "src/shared/foundation/button/button.ts"
}
},
{
"kind": "method",
"name": "validate",
"privacy": "public",
"return": {
"type": {
"text": "void"
}
},
"description": "{@inheritDoc (FormAssociated:interface).validate}",
"inheritedFrom": {
"name": "VividFoundationButton",
"module": "src/shared/foundation/button/button.ts"
}
},
{
"kind": "field",
"name": "handleSubmission",
"privacy": "private",
"description": "Submits the parent form",
"inheritedFrom": {
"name": "VividFoundationButton",
"module": "src/shared/foundation/button/button.ts"
}
},
{
"kind": "field",
"name": "handleFormReset",
"privacy": "private",
"description": "Resets the parent form",
"inheritedFrom": {
"name": "VividFoundationButton",
"module": "src/shared/foundation/button/button.ts"
}
},
{
"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",
"inheritedFrom": {
"name": "VividFoundationButton",
"module": "src/shared/foundation/button/button.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": "title",
"type": {
"text": "string"
},
"description": "Specifies extra information about the button. This information is typically used by browsers to display a tooltip.",
"default": "''",
"fieldName": "title"
},
{
"name": "connotation",
"type": {
"text": "ButtonConnotation | undefined"
},
"description": "The connotation the button should have.",
"fieldName": "connotation"
},
{
"name": "shape",
"type": {
"text": "ButtonShape | undefined"
},
"description": "The shape the button should have.",
"fieldName": "shape"
},
{
"name": "appearance",
"type": {
"text": "ButtonAppearance | undefined"
},
"description": "The appearance the button should have.",
"fieldName": "appearance"
},
{
"name": "size",
"type": {
"text": "ButtonSize | undefined"
},
"description": "The size the button should have.",
"fieldName": "size"
},
{
"name": "stacked",
"type": {
"text": "boolean"
},
"default": "false",
"description": "Indicates the icon is stacked.",
"fieldName": "stacked"
},
{
"name": "pending",
"type": {
"text": "boolean"
},
"default": "false",
"description": "Displays the button in pending state.",
"fieldName": "pending"
},
{
"name": "dropdown-indicator",
"type": {
"text": "boolean"
},
"default": "false",
"description": "Display a chevron to indicate that the button opens a dropdown.",
"fieldName": "dropdownIndicator"
},
{
"name": "active",
"type": {
"text": "boolean"
},
"default": "false",
"description": "Displays the button in active state.",
"fieldName": "active"
},
{
"name": "label",
"type": {
"text": "string | undefined"
},
"description": "Indicates the button's label.",
"fieldName": "label"
},
{
"name": "icon-trailing",
"type": {
"text": "boolean"
},
"default": "false",
"description": "Indicates the icon affix alignment.",
"fieldName": "iconTrailing",
"inheritedFrom": {
"name": "AffixIconWithTrailing",
"module": "src/shared/patterns/affix.ts"
}
},
{
"name": "icon",
"type": {
"text": "string | undefined"
},
"description": "A decorative icon the custom element should have.",
"fieldName": "icon",
"inheritedFrom": {
"name": "AffixIcon",
"module": "src/shared/patterns/affix.ts"
}
},
{
"name": "download",
"type": {
"text": "string | undefined"
},
"description": "Prompts the user to save the linked URL. See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element for more information.",
"fieldName": "download",
"inheritedFrom": {
"name": "Linkable",
"module": "src/shared/patterns/linkable.ts"
}
},
{
"name": "href",
"type": {
"text": "string | undefined"
},
"description": "The URL the hyperlink references. See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element for more information.",
"fieldName": "href",
"inheritedFrom": {
"name": "Linkable",
"module": "src/shared/patterns/linkable.ts"
}
},
{
"name": "hreflang",
"type": {
"text": "string | undefined"
},
"description": "Hints at the language of the referenced resource. See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element for more information.",
"fieldName": "hreflang",
"inheritedFrom": {
"name": "Linkable",
"module": "src/shared/patterns/linkable.ts"
}
},
{
"name": "ping",
"type": {
"text": "string | undefined"
},
"description": "See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element for more information.",
"fieldName": "ping",
"inheritedFrom": {
"name": "Linkable",
"module": "src/shared/patterns/linkable.ts"
}
},
{
"name": "referrerpolicy",
"type": {
"text": "string | undefined"
},
"description": "See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element for more information.",
"fieldName": "referrerpolicy",
"inheritedFrom": {
"name": "Linkable",
"module": "src/shared/patterns/linkable.ts"
}
},
{
"name": "rel",
"type": {
"text": "string | undefined"
},
"description": "See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element for more information.",
"fieldName": "rel",
"inheritedFrom": {
"name": "Linkable",
"module": "src/shared/patterns/linkable.ts"
}
},
{
"name": "target",
"type": {
"text": "'_self' | '_blank' | '_parent' | '_top' | undefined"
},
"description": "See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element for more information.",
"fieldName": "target",
"inheritedFrom": {
"name": "Linkable",
"module": "src/shared/patterns/linkable.ts"
}
},
{
"name": "type",
"type": {
"text": "'submit' | 'reset' | 'button'"
},
"description": "See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element for more information.",
"fieldName": "type",
"inheritedFrom": {
"name": "VividFoundationButton",
"module": "src/shared/foundation/button/button.ts"
}
},
{
"name": "autofocus",
"type": {
"text": "boolean"
},
"description": "Determines if the element should receive document focus on page load.",
"fieldName": "autofocus",
"inheritedFrom": {
"name": "VividFoundationButton",
"module": "src/shared/foundation/button/button.ts"
}
},
{
"name": "form",
"type": {
"text": "string"
},
"description": "The id of a form to associate the element to.",
"fieldName": "formId",
"inheritedFrom": {
"name": "VividFoundationButton",
"module": "src/shared/foundation/button/button.ts"
}
},
{
"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",
"inheritedFrom": {
"name": "VividFoundationButton",
"module": "src/shared/foundation/button/button.ts"
}
},
{
"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",
"inheritedFrom": {
"name": "VividFoundationButton",
"module": "src/shared/foundation/button/button.ts"
}
},
{
"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",
"inheritedFrom": {
"name": "VividFoundationButton",
"module": "src/shared/foundation/button/button.ts"
}
},
{
"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",
"inheritedFrom": {
"name": "VividFoundationButton",
"module": "src/shared/foundation/button/button.ts"
}
},
{
"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",
"inheritedFrom": {
"name": "VividFoundationButton",
"module": "src/shared/foundation/button/button.ts"
}
},
{
"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": "AffixIconWithTrailing",
"module": "/src/shared/patterns"
},
{
"name": "Localized",
"module": "/src/shared/patterns"
},
{
"name": "Linkable",
"module": "/src/shared/patterns"
}
],
"superclass": {
"name": "VividFoundationButton",
"module": "/src/shared/foundation/button/button.js"
},
"vividComponent": {
"public": true,
"name": "button"
}
}
*/
import wrapper from '@vonage/vivid-react-wrapper'
import { registerButton } from '@vonage/vivid'
registerButton('vvd3')
const VwcButton = wrapper(`vvd3-button`, {
events: [{"name":"click","propName":"onClick"}],
attributes: [],
properties: ['icon', 'disabled', 'type', 'icon-trailing', 'title', 'connotation', 'shape', 'appearance', 'size', 'stacked', 'pending', 'dropdownIndicator', 'active', 'label', 'iconTrailing', 'icon', 'download', 'href', 'hreflang', 'ping', 'referrerpolicy', 'rel', 'target', 'type', 'control', '_vividAriaBehaviour', 'autofocus', 'formId', 'formaction', 'formenctype', 'formmethod', 'formnovalidate', 'formtarget', 'value', 'currentValue', 'initialValue', 'disabled', 'name', 'required', 'VIVID_VERSION', 'componentName']
})
VwcButton.displayName = 'VwcButton'
export default VwcButton