@vonage/vivid-react/v3/VwcBanner/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": "Banner",
 "cssProperties": [
  {
   "name": "--vvd-banner-success-primary",
   "default": "var(--vvd-color-success-500)"
  },
  {
   "name": "--vvd-banner-success-primary-text",
   "default": "var(--vvd-color-canvas)"
  },
  {
   "name": "--vvd-banner-alert-primary",
   "default": "var(--vvd-color-alert-500)"
  },
  {
   "name": "--vvd-banner-alert-primary-text",
   "default": "var(--vvd-color-canvas)"
  },
  {
   "name": "--vvd-banner-announcement-primary",
   "default": "var(--vvd-color-announcement-500)"
  },
  {
   "name": "--vvd-banner-announcement-primary-text",
   "default": "var(--vvd-color-canvas)"
  },
  {
   "name": "--vvd-banner-warning-primary",
   "default": "var(--vvd-color-warning-300)"
  },
  {
   "name": "--vvd-banner-warning-primary-text",
   "default": "var(--vvd-color-canvas-text)"
  },
  {
   "name": "--vvd-banner-information-primary",
   "default": "var(--vvd-color-information-500)"
  },
  {
   "name": "--vvd-banner-information-primary-text",
   "default": "var(--vvd-color-canvas)"
  }
 ],
 "slots": [
  {
   "description": "Add action items to banner using this slot.",
   "name": "action-items"
  },
  {
   "description": "The preferred way to add an icon to the component.",
   "name": "icon"
  }
 ],
 "members": [
  {
   "kind": "field",
   "name": "dismissButtonAriaLabel",
   "type": {
    "text": "| string\n\t\t| null"
   },
   "default": "null"
  },
  {
   "kind": "field",
   "name": "actionHref",
   "type": {
    "text": "string | undefined"
   }
  },
  {
   "kind": "field",
   "name": "actionText",
   "type": {
    "text": "string | undefined"
   }
  },
  {
   "kind": "field",
   "name": "removable",
   "type": {
    "text": "boolean"
   },
   "default": "false"
  },
  {
   "kind": "field",
   "name": "text",
   "type": {
    "text": "string | undefined"
   }
  },
  {
   "kind": "field",
   "name": "connotation",
   "type": {
    "text": "BannerConnotation | undefined"
   }
  },
  {
   "kind": "field",
   "name": "conditionedIcon",
   "readonly": true
  },
  {
   "kind": "method",
   "name": "remove",
   "return": {
    "type": {
     "text": "void"
    }
   }
  },
  {
   "kind": "field",
   "name": "#handleRemoveEnd",
   "privacy": "private"
  },
  {
   "kind": "field",
   "name": "#closeOnKeyDown",
   "privacy": "private"
  },
  {
   "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": "_vividAriaBehaviour",
   "default": "'delegate'",
   "type": {
    "text": "'delegate'"
   },
   "inheritedFrom": {
    "name": "DelegatesAria",
    "module": "src/shared/aria/delegates-aria.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": "dismiss-aria-label",
   "type": {
    "text": "| string\n\t\t| null"
   },
   "default": "null",
   "fieldName": "dismissButtonAriaLabel"
  },
  {
   "name": "action-href",
   "type": {
    "text": "string | undefined"
   },
   "fieldName": "actionHref"
  },
  {
   "name": "action-text",
   "type": {
    "text": "string | undefined"
   },
   "fieldName": "actionText"
  },
  {
   "name": "removable",
   "type": {
    "text": "boolean"
   },
   "default": "false",
   "fieldName": "removable"
  },
  {
   "name": "text",
   "type": {
    "text": "string | undefined"
   },
   "fieldName": "text"
  },
  {
   "name": "connotation",
   "type": {
    "text": "BannerConnotation | undefined"
   },
   "fieldName": "connotation"
  },
  {
   "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": "AffixIcon",
   "module": "/src/shared/patterns"
  },
  {
   "name": "Localized",
   "module": "/src/shared/patterns"
  },
  {
   "name": "DelegatesAria",
   "module": "/src/shared/aria/delegates-aria"
  }
 ],
 "superclass": {
  "name": "VividElement",
  "module": "/src/shared/foundation/vivid-element/vivid-element"
 },
 "vividComponent": {
  "public": true,
  "name": "banner"
 }
}
*/
import wrapper from '@vonage/vivid-react-wrapper'
import { registerBanner } from '@vonage/vivid'

registerBanner('vvd3')

const VwcBanner = wrapper(`vvd3-banner`,  {
    events: [],
    attributes: [],
    properties: ['dismissButtonAriaLabel', 'actionHref', 'actionText', 'removable', 'text', 'connotation', 'icon', '_vividAriaBehaviour', 'VIVID_VERSION', 'componentName']
})

VwcBanner.displayName = 'VwcBanner'

export default VwcBanner