@vonage/vivid-react/v3/VwcFab/index.js

Vivid wrapped for easy React usage & IDE autocomplete support & typescript typings

/*
* DO NOT EDIT THIS FILE. IT IS GENERATED
*/
/*
Code in this file were generated using following JSON:
{
 "kind": "class",
 "description": "",
 "name": "Fab",
 "cssProperties": [
  {
   "name": "--vvd-fab-accent-primary",
   "default": "var(--vvd-color-canvas-text)"
  },
  {
   "name": "--vvd-fab-accent-primary-text",
   "default": "var(--vvd-color-canvas)"
  },
  {
   "name": "--vvd-fab-accent-primary-increment",
   "default": "var(--vvd-color-neutral-800)"
  },
  {
   "name": "--vvd-fab-accent-contrast",
   "default": "var(--vvd-color-neutral-800)"
  },
  {
   "name": "--vvd-fab-accent-fierce",
   "default": "var(--vvd-color-neutral-700)"
  },
  {
   "name": "--vvd-fab-accent-firm",
   "default": "var(--vvd-color-canvas-text)"
  },
  {
   "name": "--vvd-fab-cta-primary",
   "default": "var(--vvd-color-cta-500)"
  },
  {
   "name": "--vvd-fab-cta-primary-text",
   "default": "var(--vvd-color-canvas)"
  },
  {
   "name": "--vvd-fab-cta-primary-increment",
   "default": "var(--vvd-color-cta-600)"
  },
  {
   "name": "--vvd-fab-cta-contrast",
   "default": "var(--vvd-color-cta-800)"
  },
  {
   "name": "--vvd-fab-cta-fierce",
   "default": "var(--vvd-color-cta-700)"
  },
  {
   "name": "--vvd-fab-cta-firm",
   "default": "var(--vvd-color-cta-600)"
  },
  {
   "name": "--vvd-fab-announcement-primary",
   "default": "var(--vvd-color-announcement-500)"
  },
  {
   "name": "--vvd-fab-announcement-primary-text",
   "default": "var(--vvd-color-canvas)"
  },
  {
   "name": "--vvd-fab-announcement-primary-increment",
   "default": "var(--vvd-color-announcement-600)"
  },
  {
   "name": "--vvd-fab-announcement-contrast",
   "default": "var(--vvd-color-announcement-800)"
  },
  {
   "name": "--vvd-fab-announcement-fierce",
   "default": "var(--vvd-color-announcement-700)"
  },
  {
   "name": "--vvd-fab-announcement-firm",
   "default": "var(--vvd-color-announcement-600)"
  }
 ],
 "slots": [
  {
   "description": "The preferred way to add an icon to the component.",
   "name": "icon"
  }
 ],
 "members": [
  {
   "kind": "field",
   "name": "connotation",
   "type": {
    "text": "FabConnotation | undefined"
   },
   "description": "The connotation the fab should have.",
   "privacy": "public"
  },
  {
   "kind": "field",
   "name": "size",
   "type": {
    "text": "FABSize | undefined"
   },
   "description": "The size the FAB should have.",
   "privacy": "public"
  },
  {
   "kind": "field",
   "name": "label",
   "type": {
    "text": "string | undefined"
   },
   "description": "Indicates the fab'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": "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": "field",
   "name": "type",
   "type": {
    "text": "'submit' | 'reset' | 'button'"
   },
   "privacy": "public",
   "description": "The button type.",
   "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": "control",
   "type": {
    "text": "HTMLButtonElement"
   },
   "privacy": "public",
   "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": "_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": "connotation",
   "type": {
    "text": "FabConnotation | undefined"
   },
   "description": "The connotation the fab should have.",
   "fieldName": "connotation"
  },
  {
   "name": "size",
   "type": {
    "text": "FABSize | undefined"
   },
   "description": "The size the FAB should have.",
   "fieldName": "size"
  },
  {
   "name": "label",
   "type": {
    "text": "string | undefined"
   },
   "description": "Indicates the fab'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": "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": "type",
   "type": {
    "text": "'submit' | 'reset' | 'button'"
   },
   "description": "The button type.",
   "fieldName": "type",
   "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/affix"
  }
 ],
 "superclass": {
  "name": "VividFoundationButton",
  "module": "/src/shared/foundation/button"
 },
 "vividComponent": {
  "public": true,
  "name": "fab"
 }
}
*/
import wrapper from '@vonage/vivid-react-wrapper'
import { registerFab } from '@vonage/vivid'

registerFab('vvd3')

const VwcFab = wrapper(`vvd3-fab`,  {
    events: [],
    attributes: [],
    properties: ['connotation', 'size', 'label', 'iconTrailing', 'icon', 'autofocus', 'formId', 'formaction', 'formenctype', 'formmethod', 'formnovalidate', 'formtarget', 'type', 'control', '_vividAriaBehaviour', 'value', 'currentValue', 'initialValue', 'disabled', 'name', 'required', 'VIVID_VERSION', 'componentName']
})

VwcFab.displayName = 'VwcFab'

export default VwcFab