@vonage/vivid-react/v3/VwcIcon/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": "Icon",
 "cssProperties": [
  {
   "name": "--vvd-icon-accent-primary",
   "default": "var(--vvd-color-canvas-text)"
  },
  {
   "name": "--vvd-icon-announcement-primary",
   "default": "var(--vvd-color-announcement-500)"
  },
  {
   "name": "--vvd-icon-cta-primary",
   "default": "var(--vvd-color-cta-500)"
  },
  {
   "name": "--vvd-icon-success-primary",
   "default": "var(--vvd-color-success-500)"
  },
  {
   "name": "--vvd-icon-warning-primary",
   "default": "var(--vvd-color-warning-300)"
  },
  {
   "name": "--vvd-icon-alert-primary",
   "default": "var(--vvd-color-alert-500)"
  },
  {
   "name": "--vvd-icon-information-primary",
   "default": "var(--vvd-color-information-500)"
  }
 ],
 "slots": [
  {
   "description": "Default slot.",
   "name": ""
  }
 ],
 "members": [
  {
   "kind": "field",
   "name": "connotation",
   "type": {
    "text": "IconConnotation | undefined"
   },
   "description": "The connotation the icon should have.",
   "privacy": "public"
  },
  {
   "kind": "field",
   "name": "size",
   "type": {
    "text": "| -6\n\t\t| -5\n\t\t| -4\n\t\t| -3\n\t\t| -2\n\t\t| -1\n\t\t| 0\n\t\t| 1\n\t\t| 2\n\t\t| 3\n\t\t| 4\n\t\t| 5 | undefined"
   }
  },
  {
   "kind": "field",
   "name": "iconLoaded",
   "type": {
    "text": "boolean"
   },
   "default": "false"
  },
  {
   "kind": "field",
   "name": "label",
   "type": {
    "text": "string | undefined"
   },
   "description": "Provides a (screen reader only) descriptive label for the icon.",
   "privacy": "public"
  },
  {
   "kind": "field",
   "name": "name",
   "type": {
    "text": "string | undefined"
   },
   "description": "Indicates which icon to resolve.",
   "privacy": "public"
  },
  {
   "kind": "field",
   "name": "iconUrl",
   "readonly": true
  },
  {
   "kind": "field",
   "name": "#abortController",
   "privacy": "private",
   "type": {
    "text": "AbortController | null"
   },
   "default": "null"
  },
  {
   "kind": "method",
   "name": "nameChanged",
   "async": true
  },
  {
   "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": "IconConnotation | undefined"
   },
   "description": "The connotation the icon should have.",
   "fieldName": "connotation"
  },
  {
   "name": "size",
   "type": {
    "text": "| -6\n\t\t| -5\n\t\t| -4\n\t\t| -3\n\t\t| -2\n\t\t| -1\n\t\t| 0\n\t\t| 1\n\t\t| 2\n\t\t| 3\n\t\t| 4\n\t\t| 5 | undefined"
   },
   "fieldName": "size"
  },
  {
   "name": "label",
   "type": {
    "text": "string | undefined"
   },
   "description": "Provides a (screen reader only) descriptive label for the icon.",
   "fieldName": "label"
  },
  {
   "name": "name",
   "type": {
    "text": "string | undefined"
   },
   "description": "Indicates which icon to resolve.",
   "fieldName": "name"
  }
 ],
 "superclass": {
  "name": "VividElement",
  "module": "/src/shared/foundation/vivid-element/vivid-element"
 },
 "vividComponent": {
  "public": true,
  "name": "icon"
 }
}
*/
import wrapper from '@vonage/vivid-react-wrapper'
import { registerIcon } from '@vonage/vivid'

registerIcon('vvd3')

const VwcIcon = wrapper(`vvd3-icon`,  {
    events: [],
    attributes: [],
    properties: ['connotation', 'size', 'iconLoaded', 'label', 'name', 'VIVID_VERSION', 'componentName']
})

VwcIcon.displayName = 'VwcIcon'

export default VwcIcon