@vonage/vivid-react
Version:
Vivid wrapped for easy React usage & IDE autocomplete support & typescript typings
69 lines (68 loc) • 4.12 kB
TypeScript
import React, { ReactNode, SyntheticEvent } from 'react';
/** Single date picker component.
* For more info on this Vivid element please visit https://vivid.deno.dev/components/date-time-picker
* @param {string} min - The earliest accepted date-time. **attribute** `min`
* @param {string} minTime - The earliest accepted time part of the date-time. **attribute** `min-time`
* @param {string} minDate - The earliest accepted date part of the date-time. **attribute** `min-date`
* @param {string} max - The latest accepted date-time. **attribute** `max`
* @param {string} maxTime - The latest accepted time part of the date-time. **attribute** `max-time`
* @param {string} maxDate - The latest accepted time date of the date-time. **attribute** `max-date`
* @param {string} type
* @param {string} step
* @param {number | null} minutesStep - Distance between presented minute options. **attribute** `minutes-step`
* @param {number | null} secondsStep - Distance between presented seconds options. If null, seconds are not presented. **attribute** `seconds-step`
* @param {'12h' | '24h' | undefined} clock - Forces a 12h or 24h clock to be used. **attribute** `clock`
* @param {string} value - The current value of the element. **attribute** `current-value`
* @param {boolean} readOnly - Whether the date-picker is readonly. **attribute** `readonly`
* @param {string | undefined} helperText - Provides additional information to help the user enter the correct information.
To add HTML to the helper text, use the helper-text slot instead. **attribute** `helper-text`
* @param {string | undefined} errorText - Provides a custom error message. Any current error state will be overridden. **attribute** `error-text`
* @param validate
* @param {string | undefined} label - The label for the form element. **attribute** `label`
* @param currentValue
* @param {string} initialValue - The default value of the element. This value sets the `value` property
only when the `value` property has not been explicitly set. **attribute** `value`
* @param {boolean} disabled - Sets the element's disabled state. A disabled element will not be included during form submission. **attribute** `disabled`
* @param {string} name - The name of the element. This element's value will be surfaced during form submission under the provided name. **attribute** `name`
* @param {boolean} required - Require the field to be completed prior to form submission. **attribute** `required`
* @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 VwcDateTimePicker: {
(props: {
children?: ReactNode;
slot?: string | undefined;
id?: string | undefined;
style?: React.CSSProperties | undefined;
ref?: React.RefObject<HTMLDivElement> | ((instance: HTMLDivElement | null) => void) | null | undefined;
onInput?: ((event: SyntheticEvent) => void) | undefined;
onChange?: ((event: SyntheticEvent) => void) | undefined;
min?: string | undefined;
minTime?: string | undefined;
minDate?: string | undefined;
max?: string | undefined;
maxTime?: string | undefined;
maxDate?: string | undefined;
type?: string | undefined;
step?: string | undefined;
minutesStep?: number | undefined;
secondsStep?: number | undefined;
clock?: any;
value?: string | undefined;
readOnly?: boolean | undefined;
helperText?: string | undefined;
errorText?: string | undefined;
validate?: any;
label?: string | undefined;
currentValue?: any;
initialValue?: string | undefined;
disabled?: boolean | undefined;
name?: string | undefined;
required?: boolean | undefined;
VIVID_VERSION?: string | undefined;
componentName?: string | undefined;
}): JSX.Element;
displayName: string;
};
export default VwcDateTimePicker;