UNPKG

@vonage/vivid-react

Version:

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

68 lines (67 loc) 3.99 kB
import React, { ReactNode, SyntheticEvent } from 'react'; /** VwcSlider * For more info on this Vivid element please visit https://vivid.deno.dev/components/slider * @param {number} min **attribute** `min` * @param {number} max **attribute** `max` * @param {number} step **attribute** `step` * @param {string} orientation **attribute** `orientation` * @param {boolean} markers **attribute** `markers` * @param {string} connotation **attribute** `connotation` * @param {boolean} pin **attribute** `pin` * @param {boolean} disabled **attribute** `disabled` * @param {string} value **attribute** `current-value` * @param {boolean} readOnly - When true, the control will be immutable by user interaction. See https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/readonly | readonly HTML attribute for more information. **attribute** `readonly` * @param {number} valueAsNumber - The value property, typed as a number. * @param {(value: string) => string} valueTextFormatter - Custom function that generates a string for the component's "aria-valuetext" attribute based on the current value. * @param {number} min - The minimum allowed value. **attribute** `min` * @param {number} max - The maximum allowed value. **attribute** `max` * @param {number} step - Value to increment or decrement via arrow keys, mouse click or drag. **attribute** `step` * @param {Orientation} orientation - The orientation of the slider. **attribute** `orientation` * @param {SliderMode} mode - The selection mode. **attribute** `mode` * @param {boolean} markers - Display markers on/off **attribute** `markers` * @param {boolean} pin - Show current value on the thumb. **attribute** `pin` * @param {SliderConnotation | undefined} connotation - slider connotation **attribute** `connotation` * @param {'delegate'} _vividAriaBehaviour * @param {string} value - The current value of the element. **attribute** `current-value` * @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 VwcSlider: { (props: { children?: ReactNode; slot?: string | undefined; id?: string | undefined; style?: React.CSSProperties | undefined; ref?: React.RefObject<HTMLDivElement> | ((instance: HTMLDivElement | null) => void) | null | undefined; onChange?: ((event: SyntheticEvent) => void) | undefined; min?: number | undefined; max?: number | undefined; step?: number | undefined; orientation?: string | undefined; markers?: boolean | undefined; connotation?: string | undefined; pin?: boolean | undefined; disabled?: boolean | undefined; value?: string | undefined; readOnly?: boolean | undefined; valueAsNumber?: number | undefined; valueTextFormatter?: any; mode?: any; _vividAriaBehaviour?: any; currentValue?: any; initialValue?: string | undefined; name?: string | undefined; required?: boolean | undefined; VIVID_VERSION?: string | undefined; componentName?: string | undefined; }): JSX.Element; displayName: string; }; export default VwcSlider;