@vonage/vivid-react
Version:
Vivid wrapped for easy React usage & IDE autocomplete support & typescript typings
642 lines (637 loc) • 15.9 kB
JavaScript
/*
* DO NOT EDIT THIS FILE. IT IS GENERATED
*/
/*
Code in this file were generated using following JSON:
{
"kind": "class",
"description": "",
"name": "Radio",
"cssProperties": [
{
"name": "--vvd-radio-cta-primary",
"default": "var(--vvd-color-cta-500)"
},
{
"name": "--vvd-radio-cta-primary-text",
"default": "var(--vvd-color-canvas)"
},
{
"name": "--vvd-radio-cta-primary-increment",
"default": "var(--vvd-color-cta-600)"
},
{
"name": "--vvd-radio-cta-intermediate",
"default": "var(--vvd-color-cta-500)"
},
{
"name": "--vvd-radio-cta-firm",
"default": "var(--vvd-color-cta-600)"
},
{
"name": "--vvd-radio-cta-fierce",
"default": "var(--vvd-color-cta-700)"
},
{
"name": "--vvd-radio-accent-primary",
"default": "var(--vvd-color-canvas-text)"
},
{
"name": "--vvd-radio-accent-primary-text",
"default": "var(--vvd-color-canvas)"
},
{
"name": "--vvd-radio-accent-primary-increment",
"default": "var(--vvd-color-neutral-800)"
},
{
"name": "--vvd-radio-accent-intermediate",
"default": "var(--vvd-color-neutral-500)"
},
{
"name": "--vvd-radio-accent-firm",
"default": "var(--vvd-color-canvas-text)"
},
{
"name": "--vvd-radio-accent-fierce",
"default": "var(--vvd-color-neutral-700)"
}
],
"members": [
{
"kind": "field",
"name": "ariaLabel",
"type": {
"text": "string | null"
},
"default": "null"
},
{
"kind": "field",
"name": "connotation",
"type": {
"text": "RadioConnotation | undefined"
},
"description": "The connotation the radioButton should have.",
"privacy": "public"
},
{
"kind": "field",
"name": "readOnly",
"type": {
"text": "boolean"
},
"description": "When true, the control will be immutable by user interaction. See https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/readonly | readonly HTML attribute for more information.",
"privacy": "public"
},
{
"kind": "method",
"name": "isInsideRadioGroup",
"privacy": "private",
"return": {
"type": {
"text": "boolean"
}
}
},
{
"kind": "field",
"name": "#radioSiblings",
"privacy": "private",
"type": {
"text": "Radio[]"
},
"readonly": true
},
{
"kind": "field",
"name": "#radioGroup",
"privacy": "private",
"type": {
"text": "RadioGroup | null"
},
"readonly": true
},
{
"kind": "field",
"name": "#validateValueMissingWithSiblings",
"privacy": "private"
},
{
"kind": "field",
"name": "#syncSiblingsRequiredValidationStatus",
"privacy": "private"
},
{
"kind": "field",
"name": "checked",
"type": {
"text": "boolean"
},
"description": "The current checkedness of the element.",
"privacy": "public",
"inheritedFrom": {
"name": "CheckableFormAssociated",
"module": "src/shared/foundation/form-associated/form-associated.ts"
}
},
{
"kind": "field",
"name": "dirtyChecked",
"type": {
"text": "boolean"
},
"default": "false"
},
{
"kind": "field",
"name": "errorText",
"type": {
"text": "string | undefined"
},
"description": "Provides a custom error message. Any current error state will be overridden.",
"privacy": "public",
"inheritedFrom": {
"name": "WithErrorText",
"module": "src/shared/patterns/form-elements/with-error-text.ts"
}
},
{
"kind": "field",
"name": "#blockValidateCalls",
"privacy": "private",
"type": {
"text": "boolean"
},
"default": "false",
"inheritedFrom": {
"name": "WithErrorText",
"module": "src/shared/patterns/form-elements/with-error-text.ts"
}
},
{
"kind": "field",
"name": "#originalValidateFn",
"privacy": "private",
"type": {
"text": "() => void"
},
"inheritedFrom": {
"name": "WithErrorText",
"module": "src/shared/patterns/form-elements/with-error-text.ts"
}
},
{
"kind": "method",
"name": "#forceCustomError",
"parameters": [
{
"name": "errorMessage",
"type": {
"text": "string"
}
}
],
"inheritedFrom": {
"name": "WithErrorText",
"module": "src/shared/patterns/form-elements/with-error-text.ts"
}
},
{
"kind": "method",
"name": "#clearCustomErrorAndRevalidate",
"inheritedFrom": {
"name": "WithErrorText",
"module": "src/shared/patterns/form-elements/with-error-text.ts"
}
},
{
"kind": "field",
"name": "validate",
"inheritedFrom": {
"name": "WithErrorText",
"module": "src/shared/patterns/form-elements/with-error-text.ts"
}
},
{
"kind": "field",
"name": "label",
"type": {
"text": "string | undefined"
},
"description": "The label for the form element.",
"inheritedFrom": {
"name": "FormElement",
"module": "src/shared/patterns/form-elements/form-element.ts"
}
},
{
"kind": "field",
"name": "#handleInvalidEvent",
"privacy": "private",
"inheritedFrom": {
"name": "FormElement",
"module": "src/shared/patterns/form-elements/form-element.ts"
}
},
{
"kind": "field",
"name": "defaultChecked",
"type": {
"text": "boolean"
},
"default": "false",
"description": "The default checkedness of the element. This value sets the `checked` property\nonly when the `checked` property has not been explicitly set.",
"privacy": "public",
"inheritedFrom": {
"name": "CheckableFormAssociated",
"module": "src/shared/foundation/form-associated/form-associated.ts"
}
},
{
"kind": "field",
"name": "checkedAttribute",
"inheritedFrom": {
"name": "CheckableFormAssociated",
"module": "src/shared/foundation/form-associated/form-associated.ts"
}
},
{
"kind": "field",
"name": "currentChecked",
"inheritedFrom": {
"name": "CheckableFormAssociated",
"module": "src/shared/foundation/form-associated/form-associated.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"
}
}
],
"events": [
{
"type": {
"text": "CustomEvent<undefined>"
},
"description": "Fires a custom 'change' event when the value changes",
"name": "change"
}
],
"attributes": [
{
"name": "aria-label",
"type": {
"text": "string | null"
},
"default": "null",
"fieldName": "ariaLabel"
},
{
"name": "connotation",
"type": {
"text": "RadioConnotation | undefined"
},
"description": "The connotation the radioButton should have.",
"fieldName": "connotation"
},
{
"name": "readonly",
"type": {
"text": "boolean"
},
"description": "When true, the control will be immutable by user interaction. See https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/readonly | readonly HTML attribute for more information.",
"fieldName": "readOnly"
},
{
"name": "error-text",
"type": {
"text": "string | undefined"
},
"description": "Provides a custom error message. Any current error state will be overridden.",
"fieldName": "errorText",
"inheritedFrom": {
"name": "WithErrorText",
"module": "src/shared/patterns/form-elements/with-error-text.ts"
}
},
{
"name": "label",
"type": {
"text": "string | undefined"
},
"description": "The label for the form element.",
"fieldName": "label",
"inheritedFrom": {
"name": "FormElement",
"module": "src/shared/patterns/form-elements/form-element.ts"
}
},
{
"name": "checked",
"type": {
"text": "boolean"
},
"default": "false",
"description": "The default checkedness of the element. This value sets the `checked` property\nonly when the `checked` property has not been explicitly set.",
"fieldName": "defaultChecked",
"inheritedFrom": {
"name": "CheckableFormAssociated",
"module": "src/shared/foundation/form-associated/form-associated.ts"
}
},
{
"name": "current-checked",
"type": {
"text": "boolean"
},
"description": "The current checkedness of the element.",
"fieldName": "checked",
"inheritedFrom": {
"name": "CheckableFormAssociated",
"module": "src/shared/foundation/form-associated/form-associated.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": "WithErrorText",
"module": "/src/shared/patterns"
},
{
"name": "FormElement",
"module": "/src/shared/patterns"
},
{
"name": "CheckableFormAssociated",
"module": "/src/shared/foundation/form-associated/form-associated"
}
],
"superclass": {
"name": "VividElement",
"module": "/src/shared/foundation/vivid-element/vivid-element"
},
"vividComponent": {
"public": true,
"name": "radio"
}
}
*/
import wrapper from '@vonage/vivid-react-wrapper'
import { registerRadio } from '@vonage/vivid'
registerRadio('vvd3')
const VwcRadio = wrapper(`vvd3-radio`, {
events: [{"name":"change","propName":"onChange"}],
attributes: [],
properties: ['ariaLabel', 'connotation', 'readOnly', 'checked', 'dirtyChecked', 'errorText', 'validate', 'label', 'defaultChecked', 'checkedAttribute', 'currentChecked', 'value', 'currentValue', 'initialValue', 'disabled', 'name', 'required', 'VIVID_VERSION', 'componentName']
})
VwcRadio.displayName = 'VwcRadio'
export default VwcRadio