@vonage/vivid-react/v3/VwcTab/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": "Tab",
 "cssProperties": [
  {
   "name": "--vvd-tab-cta-primary-text",
   "default": "var(--vvd-color-canvas)"
  },
  {
   "name": "--vvd-tab-cta-firm",
   "default": "var(--vvd-color-cta-600)"
  },
  {
   "name": "--vvd-tab-cta-faint",
   "default": "var(--vvd-color-cta-50)"
  },
  {
   "name": "--vvd-tab-cta-fierce",
   "default": "var(--vvd-color-cta-700)"
  },
  {
   "name": "--vvd-tab-cta-pale",
   "default": "var(--vvd-color-cta-300)"
  },
  {
   "name": "--vvd-tab-cta-soft",
   "default": "var(--vvd-color-cta-100)"
  },
  {
   "name": "--vvd-tab-accent-primary-text",
   "default": "var(--vvd-color-canvas)"
  },
  {
   "name": "--vvd-tab-accent-firm",
   "default": "var(--vvd-color-canvas-text)"
  },
  {
   "name": "--vvd-tab-accent-faint",
   "default": "var(--vvd-color-neutral-50)"
  },
  {
   "name": "--vvd-tab-accent-fierce",
   "default": "var(--vvd-color-neutral-700)"
  },
  {
   "name": "--vvd-tab-accent-pale",
   "default": "var(--vvd-color-neutral-300)"
  },
  {
   "name": "--vvd-tab-accent-soft",
   "default": "var(--vvd-color-neutral-100)"
  }
 ],
 "slots": [
  {
   "description": "The preferred way to add an icon to the component.",
   "name": "icon"
  }
 ],
 "members": [
  {
   "kind": "field",
   "name": "disabled",
   "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/disabled | disabled HTML attribute for more information.",
   "privacy": "public"
  },
  {
   "kind": "field",
   "name": "connotation",
   "type": {
    "text": "TabConnotation | undefined"
   },
   "description": "The connotation the tab should have.",
   "privacy": "public"
  },
  {
   "kind": "field",
   "name": "shape",
   "type": {
    "text": "TabShape | undefined"
   },
   "description": "The shape the tab should have.",
   "privacy": "public"
  },
  {
   "kind": "field",
   "name": "label",
   "type": {
    "text": "string | undefined"
   },
   "description": "Indicates the tab's label.",
   "privacy": "public"
  },
  {
   "kind": "field",
   "name": "removable",
   "type": {
    "text": "boolean"
   },
   "default": "false",
   "description": "Adds a close button",
   "privacy": "public"
  },
  {
   "kind": "field",
   "name": "tabIndex",
   "type": {
    "text": "number"
   },
   "default": "'-1' as unknown"
  },
  {
   "kind": "method",
   "name": "_handleCloseClick",
   "parameters": [
    {
     "name": "e",
     "type": {
      "text": "Event"
     }
    }
   ]
  },
  {
   "kind": "method",
   "name": "_onKeyDown",
   "parameters": [
    {
     "name": "e",
     "type": {
      "text": "KeyboardEvent"
     }
    }
   ]
  },
  {
   "kind": "field",
   "name": "_vividAriaBehaviour",
   "default": "'host'",
   "type": {
    "text": "'host'"
   },
   "inheritedFrom": {
    "name": "HostSemantics",
    "module": "src/shared/aria/host-semantics.ts"
   }
  },
  {
   "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": "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": "disabled",
   "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/disabled | disabled HTML attribute for more information.",
   "fieldName": "disabled"
  },
  {
   "name": "connotation",
   "type": {
    "text": "TabConnotation | undefined"
   },
   "description": "The connotation the tab should have.",
   "fieldName": "connotation"
  },
  {
   "name": "shape",
   "type": {
    "text": "TabShape | undefined"
   },
   "description": "The shape the tab should have.",
   "fieldName": "shape"
  },
  {
   "name": "label",
   "type": {
    "text": "string | undefined"
   },
   "description": "Indicates the tab's label.",
   "fieldName": "label"
  },
  {
   "name": "removable",
   "type": {
    "text": "boolean"
   },
   "default": "false",
   "description": "Adds a close button",
   "fieldName": "removable"
  },
  {
   "name": "tabIndex",
   "type": {
    "text": "number"
   },
   "default": "'-1' as unknown",
   "fieldName": "tabIndex"
  },
  {
   "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"
   }
  }
 ],
 "mixins": [
  {
   "name": "HostSemantics",
   "module": "/src/shared/aria/host-semantics"
  },
  {
   "name": "AffixIconWithTrailing",
   "module": "/src/shared/patterns/affix"
  },
  {
   "name": "Localized",
   "module": "/src/shared/patterns"
  }
 ],
 "superclass": {
  "name": "VividElement",
  "module": "/src/shared/foundation/vivid-element/vivid-element"
 },
 "vividComponent": {
  "public": true,
  "name": "tab"
 }
}
*/
import wrapper from '@vonage/vivid-react-wrapper'
import { registerTab } from '@vonage/vivid'

registerTab('vvd3')

const VwcTab = wrapper(`vvd3-tab`,  {
    events: [{"name":"click","propName":"onClick"}],
    attributes: [],
    properties: ['disabled', 'connotation', 'shape', 'label', 'removable', 'tabIndex', '_vividAriaBehaviour', 'iconTrailing', 'icon', 'VIVID_VERSION', 'componentName']
})

VwcTab.displayName = 'VwcTab'

export default VwcTab