@veracity/vui/dist/range/range.types.d.ts

Veracity UI is a React component library crafted for use within Veracity applications and pages. Based on Styled Components and @xstyled.

import { ThemingProps } from "../theme/types.js";
import "../theme/index.js";
import { SystemProps } from "../system/system.js";
import "../system/index.js";
//#region src/range/range.types.d.ts
type RangeValue = number | readonly number[];
type RangeProps = SystemProps & ThemingProps<'Range'> & {
  /** The default value of the range slider, number or [number, number]. @default 0 */
  defaultValue?: RangeValue;
  /** The current value of the range slider, number or [number, number]. */
  value?: RangeValue;
  /** Disables the range slider with the right styling */
  disabled?: boolean;
  /** The minimum value of the range slider. @default 0 */
  min?: number;
  /** The minimum value of the range slider. @default 100 */
  max?: number;
  /** The minimum distance between two values in the range slider. @default 0 */
  minDistance?: number;
  /** The step increment of the range slider. @default 1 */
  step?: number;
  /** Controls tooltip visibility. Omit to show on hover (default), `true` to always show, `false` to hide. When `showValue` is `true`, the tooltip is hidden by default. */
  showTooltip?: boolean;
  /** Whether to show the current value bellow the thumb. @default false */
  showValue?: boolean;
  /** Function used to format the display value. */
  formatter?: (value: string) => string;
  /** Callback function that is called when the value changes. */
  onChange?: (value: RangeValue) => void;
};
//#endregion
export { RangeProps, RangeValue };

//# sourceMappingURL=range.types.d.ts.map