Hero Hook Form API / SliderFieldProps

Type Alias: SliderFieldProps<TFieldValues>

SliderFieldProps<TFieldValues> = FieldBaseProps<TFieldValues, number> & WithControl<TFieldValues> & object

Defined in: fields/SliderField.tsx:35

Props for the SliderField component.

Type Declaration

sliderProps?

optional sliderProps: Omit<React.ComponentProps<typeof Slider>, "value" | "onValueChange" | "label" | "isInvalid" | "errorMessage" | "isDisabled">

Additional props to pass to the underlying Slider component

transform()?

optional transform: (value) => number

Transform function to modify the slider value before it’s set

Parameters

value

number

Returns

number

Type Parameters

TFieldValues

TFieldValues extends FieldValues

The form data type

Example


import { SliderField } from "@rachelallyson/hero-hook-form";
import { useForm } from "react-hook-form";
 
const form = useForm({
  defaultValues: { volume: 50 },
});
 
<SliderField
  control={form.control}
  name="volume"
  label="Volume"
  description="Adjust the volume level"
/>