@vonage/vivid-react/v3/VwcCalendar/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": "Calendar",
 "slots": [
  {
   "description": "Default slot.",
   "name": ""
  },
  {
   "description": "Assign elements to corresponding day column using this slot.",
   "name": "day-0"
  },
  {
   "description": "Assign elements to corresponding day column using this slot.",
   "name": "day-1"
  },
  {
   "description": "Assign elements to corresponding day column using this slot.",
   "name": "day-2"
  },
  {
   "description": "Assign elements to corresponding day column using this slot.",
   "name": "day-3"
  },
  {
   "description": "Assign elements to corresponding day column using this slot.",
   "name": "day-4"
  },
  {
   "description": "Assign elements to corresponding day column using this slot.",
   "name": "day-5"
  },
  {
   "description": "Assign elements to corresponding day column using this slot.",
   "name": "day-6"
  }
 ],
 "members": [
  {
   "kind": "field",
   "name": "datetime",
   "type": {
    "text": "Date | string | undefined"
   },
   "description": "The date within a week of choice.\nAccepts any parameter acceptable by the `Date()` constructor.",
   "privacy": "public"
  },
  {
   "kind": "field",
   "name": "startDay",
   "type": {
    "text": "'sunday' | 'monday' | undefined"
   },
   "description": "The day to show as the first within a work week.\nAccepts either Sunday or Monday\nCalendar will - programmatically - default to Monday if not specified\n\n(only applicable for views of more than a single day)",
   "privacy": "public"
  },
  {
   "kind": "field",
   "name": "locales",
   "type": {
    "text": "string | string[] | undefined | undefined"
   },
   "description": "A locale string or array of locale strings that contain one or more language or locale tags.\nIf you include more than one locale string,\nlist them in descending order of priority so that the first entry is the preferred locale.\nIf you omit this parameter, the default locale of the JavaScript runtime is used.\nThis parameter must conform to BCP 47 standards; see the Intl.Collator object for details.\ne.g. en-US | en-US, he-IL",
   "privacy": "public"
  },
  {
   "kind": "field",
   "name": "hour12",
   "type": {
    "text": "boolean"
   },
   "default": "false",
   "description": "The convention of displayed time in which the day runs from midnight to midnight and is divided into 24 or 12 hours.\nUnless provided, choice will be set according to local time preference (e.g. US = 12, IL = 24)",
   "privacy": "public"
  },
  {
   "kind": "field",
   "name": "stickyMode",
   "type": {
    "text": "CalendarSticky"
   },
   "description": "Sticky header and sticky column options",
   "privacy": "public"
  },
  {
   "kind": "field",
   "name": "#activeCalendarEvent",
   "privacy": "private",
   "type": {
    "text": "CalendarEvent | null"
   },
   "readonly": true
  },
  {
   "kind": "field",
   "name": "getEventContext",
   "default": "getEventContext",
   "description": "Fire an event",
   "parameters": [
    {
     "description": "event name",
     "name": "calendarEvent"
    }
   ],
   "return": {
    "type": {
     "text": ""
    }
   }
  },
  {
   "kind": "method",
   "name": "getCalendarEventContainingCell",
   "privacy": "private",
   "parameters": [
    {
     "name": "calendarEvent",
     "type": {
      "text": "CalendarEvent"
     }
    }
   ]
  },
  {
   "kind": "method",
   "name": "arrowKeysInteractions",
   "privacy": "private",
   "parameters": [
    {
     "name": "key",
     "type": {
      "text": "PredefindKeys"
     }
    }
   ]
  },
  {
   "kind": "method",
   "name": "activateElement",
   "privacy": "private",
   "parameters": [
    {
     "name": "el",
     "type": {
      "text": "HTMLElement | null | undefined"
     }
    }
   ]
  },
  {
   "kind": "method",
   "name": "onKeydown",
   "parameters": [
    {
     "name": "{ key }",
     "type": {
      "text": "KeyboardEvent"
     }
    }
   ]
  },
  {
   "kind": "method",
   "name": "initializeScrollPosition",
   "privacy": "private"
  },
  {
   "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": "datetime",
   "type": {
    "text": "Date | string | undefined"
   },
   "description": "The date within a week of choice.\nAccepts any parameter acceptable by the `Date()` constructor.",
   "fieldName": "datetime"
  },
  {
   "name": "start-day",
   "type": {
    "text": "'sunday' | 'monday' | undefined"
   },
   "description": "The day to show as the first within a work week.\nAccepts either Sunday or Monday\nCalendar will - programmatically - default to Monday if not specified\n\n(only applicable for views of more than a single day)",
   "fieldName": "startDay"
  },
  {
   "name": "locales",
   "type": {
    "text": "string | string[] | undefined | undefined"
   },
   "description": "A locale string or array of locale strings that contain one or more language or locale tags.\nIf you include more than one locale string,\nlist them in descending order of priority so that the first entry is the preferred locale.\nIf you omit this parameter, the default locale of the JavaScript runtime is used.\nThis parameter must conform to BCP 47 standards; see the Intl.Collator object for details.\ne.g. en-US | en-US, he-IL",
   "fieldName": "locales"
  },
  {
   "name": "hour12",
   "type": {
    "text": "boolean"
   },
   "default": "false",
   "description": "The convention of displayed time in which the day runs from midnight to midnight and is divided into 24 or 12 hours.\nUnless provided, choice will be set according to local time preference (e.g. US = 12, IL = 24)",
   "fieldName": "hour12"
  },
  {
   "name": "sticky-mode",
   "type": {
    "text": "CalendarSticky"
   },
   "description": "Sticky header and sticky column options",
   "fieldName": "stickyMode"
  }
 ],
 "superclass": {
  "name": "VividElement",
  "module": "/src/shared/foundation/vivid-element/vivid-element"
 },
 "vividComponent": {
  "public": true,
  "name": "calendar"
 }
}
*/
import wrapper from '@vonage/vivid-react-wrapper'
import { registerCalendar } from '@vonage/vivid'

registerCalendar('vvd3')

const VwcCalendar = wrapper(`vvd3-calendar`,  {
    events: [],
    attributes: [],
    properties: ['datetime', 'startDay', 'locales', 'hour12', 'stickyMode', 'getEventContext', 'VIVID_VERSION', 'componentName']
})

VwcCalendar.displayName = 'VwcCalendar'

export default VwcCalendar