@vonage/vivid-react/v3/VwcSideDrawer/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": "SideDrawer",
 "slots": [
  {
   "description": "Sets assigned nodes to the side drawer itself.",
   "name": ""
  },
  {
   "description": "Sets assigned nodes to the main application content, the side drawer is opened next to.",
   "name": "app-content"
  }
 ],
 "members": [
  {
   "kind": "field",
   "name": "alternate",
   "type": {
    "text": "boolean"
   },
   "default": "false",
   "description": "applies scheme alternate region",
   "privacy": "public"
  },
  {
   "kind": "field",
   "name": "modal",
   "type": {
    "text": "boolean"
   },
   "default": "false",
   "description": "sets the side drawer's type to modal",
   "privacy": "public"
  },
  {
   "kind": "field",
   "name": "open",
   "type": {
    "text": "boolean"
   },
   "default": "false",
   "description": "indicates whether the side drawer is open",
   "privacy": "public"
  },
  {
   "kind": "field",
   "name": "trailing",
   "type": {
    "text": "boolean"
   },
   "default": "false",
   "description": "sets the side of the side drawer",
   "privacy": "public"
  },
  {
   "kind": "method",
   "name": "#close",
   "return": {
    "type": {
     "text": "void"
    }
   }
  },
  {
   "kind": "method",
   "name": "#open",
   "return": {
    "type": {
     "text": "void"
    }
   }
  },
  {
   "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": "Fired when the side drawer is closed.",
   "name": "close"
  },
  {
   "type": {
    "text": "CustomEvent<undefined>"
   },
   "description": "Fired when the side drawer is opened.",
   "name": "open"
  },
  {
   "type": {
    "text": "CustomEvent<undefined>"
   },
   "description": "Fired when the user requests to close the side-drawer. You can prevent the side drawer from closing by calling `.preventDefault()` on the event.",
   "name": "cancel"
  }
 ],
 "attributes": [
  {
   "name": "alternate",
   "type": {
    "text": "boolean"
   },
   "default": "false",
   "description": "applies scheme alternate region",
   "fieldName": "alternate"
  },
  {
   "name": "modal",
   "type": {
    "text": "boolean"
   },
   "default": "false",
   "description": "sets the side drawer's type to modal",
   "fieldName": "modal"
  },
  {
   "name": "open",
   "type": {
    "text": "boolean"
   },
   "default": "false",
   "description": "indicates whether the side drawer is open",
   "fieldName": "open"
  },
  {
   "name": "trailing",
   "type": {
    "text": "boolean"
   },
   "default": "false",
   "description": "sets the side of the side drawer",
   "fieldName": "trailing"
  }
 ],
 "superclass": {
  "name": "VividElement",
  "module": "/src/shared/foundation/vivid-element/vivid-element"
 },
 "vividComponent": {
  "public": true,
  "name": "side-drawer"
 }
}
*/
import wrapper from '@vonage/vivid-react-wrapper'
import { registerSideDrawer } from '@vonage/vivid'

registerSideDrawer('vvd3')

const VwcSideDrawer = wrapper(`vvd3-side-drawer`,  {
    events: [{"name":"cancel","propName":"onCancel"},{"name":"open","propName":"onOpen"},{"name":"close","propName":"onClose"}],
    attributes: [],
    properties: ['alternate', 'modal', 'open', 'trailing', 'VIVID_VERSION', 'componentName']
})

VwcSideDrawer.displayName = 'VwcSideDrawer'

export default VwcSideDrawer