@vonage/vivid-react
Version:
Vivid wrapped for easy React usage & IDE autocomplete support & typescript typings
44 lines (42 loc) • 2.43 kB
TypeScript
import React, { ReactNode } from 'react';
/** VwcCalendar
* For more info on this Vivid element please visit https://vivid.deno.dev/components/calendar
* @param {Date | string | undefined} datetime - The date within a week of choice.
Accepts any parameter acceptable by the `Date()` constructor. **attribute** `datetime`
* @param {'sunday' | 'monday' | undefined} startDay - The day to show as the first within a work week.
Accepts either Sunday or Monday
Calendar will - programmatically - default to Monday if not specified
(only applicable for views of more than a single day) **attribute** `start-day`
* @param {string | string[] | undefined | undefined} locales - A locale string or array of locale strings that contain one or more language or locale tags.
If you include more than one locale string,
list them in descending order of priority so that the first entry is the preferred locale.
If you omit this parameter, the default locale of the JavaScript runtime is used.
This parameter must conform to BCP 47 standards; see the Intl.Collator object for details.
e.g. en-US | en-US, he-IL **attribute** `locales`
* @param {boolean} hour12 - The convention of displayed time in which the day runs from midnight to midnight and is divided into 24 or 12 hours.
Unless provided, choice will be set according to local time preference (e.g. US = 12, IL = 24) **attribute** `hour12`
* @param {CalendarSticky} stickyMode - Sticky header and sticky column options **attribute** `sticky-mode`
* @param getEventContext - Fire an event
* @param {string} VIVID_VERSION - The current version of the Vivid library, which is useful for debugging.
It can be accessed from any Vivid element via `<el>.constructor.VIVID_VERSION`.
* @param {string} componentName - Core component name, without prefix
*/
declare const VwcCalendar: {
(props: {
children?: ReactNode;
slot?: string | undefined;
id?: string | undefined;
style?: React.CSSProperties | undefined;
ref?: React.RefObject<HTMLDivElement> | ((instance: HTMLDivElement | null) => void) | null | undefined;
datetime?: any;
startDay?: any;
locales?: any;
hour12?: boolean | undefined;
stickyMode?: any;
getEventContext?: any;
VIVID_VERSION?: string | undefined;
componentName?: string | undefined;
}): JSX.Element;
displayName: string;
};
export default VwcCalendar;