UNPKG

@vonage/vivid-react

Version:

Vivid wrapped for easy React usage & IDE autocomplete support & typescript typings

75 lines (74 loc) 4.46 kB
import React, { ReactNode, SyntheticEvent } from 'react'; /** VwcDateRangePicker * For more info on this Vivid element please visit https://vivid.deno.dev/components/date-range-picker * @param {string} initialStart - The initial start value. This value sets the `start` property only when the `start` property has not been explicitly set. **attribute** `start` * @param {string} initialEnd - The initial end value. This value sets the `end` property only when the `end` property has not been explicitly set. **attribute** `end` * @param {string} start - The start value of the date range. * @param {string} end - The end value of the date range. * @param {string} currentStart - The current start value of the element. This property serves as a mechanism to set the `start` property through both property assignment and the .setAttribute() method. This is useful for setting the field's value in UI libraries that bind data through the .setAttribute() API and don't support IDL attribute binding. **attribute** `current-start` * @param {string} currentEnd - The current end value of the element. This property serves as a mechanism to set the `end` property through both property assignment and the .setAttribute() method. This is useful for setting the field's value in UI libraries that bind data through the .setAttribute() API and don't support IDL attribute binding. **attribute** `current-end` * @param {string} min - The earliest accepted date. **attribute** `min` * @param {string} max - The latest accepted date. **attribute** `max` * @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 VwcDateRangePicker: { (props: { (event: SyntheticEvent): void; (event: SyntheticEvent): void; children?: ReactNode; slot?: string | undefined; id?: string | undefined; style?: React.CSSProperties | undefined; ref?: React.RefObject<HTMLDivElement> | ((instance: HTMLDivElement | null) => void) | null | undefined; onInput?: start | null; onChange?: ((event: SyntheticEvent) => void) | undefined; initialStart?: string | undefined; initialEnd?: string | undefined; start?: string | undefined; end?: string | undefined; currentStart?: string | undefined; currentEnd?: string | undefined; min?: string | undefined; max?: string | undefined; 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 VwcDateRangePicker;