Skip to main content

RHFSlider

Sliders reflect a range of values along a bar, from which users may select a single value. They are ideal for adjusting settings such as volume or brightness. RHFSlider extends Slider and can be customized in a similar way.

Usage

import { RHFSlider, RHFSliderProps } from '@nish1896/rhf-mui-components';
<RHFSlider
fieldName="score"
register={register}
defaultValue={40}
errorMessage={errors?.score?.message}
/>

Examples

API

RHFSliderProps extends SliderProps and accepts the following additional props:

NameTypeRequiredDescription
fieldNamestringReact Hook Form requires name as a key for the registration process.
registerUseFormRegisterThe register option yielded on calling the useForm hook.
registerOptionsRegisterOptionsRegister options if using react-hook-form without any validation libraries like yup or Joi.
defaultValuenumber OR number[]Initial value set for RHFSlider component on render.
onValueChange(event: Event, value: number OR number[], activeThumb: number) => voidOptional callback function returning the selected value of RHFSlider.
labelReactNodeThe text to render in FormLabel component. By default, the value of fieldName such as firstName will be transformed to display "First Name".
showLabelAboveFormFieldbooleanRender form label above the form field in FormLabel component.
formLabelPropsFormLabelPropsFormLabelProps to customise FormLabel component for a field. Multiple fields can be configured using the ConfigProvider component.
helperTextReactNodeOptional helperText to render under RHFSelect or RHFNativeSelect field.
errorMessageReactNodeError message to be shown for a field in FormHelperText component.
hideErrorMessagebooleanPrevent replacing of form HelperText by error message during validation trigger.
formHelperTextPropsFormHelperTextPropsFormHelperTextProps to customise FormHelperText component for a field. Multiple fields can be configured using the ConfigProvider component.