MUISlider

MUISlider wraps the Material UI Slider for a single number or a range (number array), with label, error and helper-text handling.

Usage#

import MUISlider, { MUISliderProps } from '@nish1896/mui-components/mui/slider';

const [volume, setVolume] = useState(30);

<MUISlider
  fieldName="volume"
  value={volume}
  onValueChange={({ newValue }) => setVolume(newValue as number)}
  min={0}
  max={100}
/>

Props#

MUISliderProps also accepts most SliderProps. Pass a number array as value for a range slider. Props marked with * are required.

Name	Type	Description
`fieldName`*	`string`	Name/path of the field. Used to derive the `id`, the default label, and the `name` attribute. This prop is required for all components.
`value`	`number \| number[] \| null`	Current slider value. Pass a number array for range sliders. `undefined`/`null` are treated as `0`.
`onValueChange`*	`({ newValue, activeThumb, event }) => void`	Called on every slide with the next value, the active thumb index (for range sliders), and the original change event.
`label`	`ReactNode`	Label displayed for the field. Defaults to a human-readable label derived from `fieldName`, e.g. `firstName` becomes `First Name`
`showLabelAboveFormField`	`boolean`	Whether the field label renders above the control. This control has no built-in inline label, so it defaults to `true`; pass `false` to hide the visible label (the accessible name is still applied). Default: `true`
`formLabelProps`	FormLabelProps	FormLabelProps forwarded to the internal `FormLabel`. The `id` is managed by the component. Multiple fields can be configured using the `ConfigProvider` component.
`hideLabel`	`boolean`	When true, hides the rendered field label while preserving accessible labeling where possible.
`required`	`boolean`	Indicates that the field is mandatory by adding an asterisk symbol (*) to the form label and setting the relevant accessibility attributes.
`errorMessage`	`string \| string[]`	Validation error for the field — pass a single message `string`, or a `string[]` when the field can fail multiple rules at once (every message is shown together). A non-empty string or array puts the field in an error state; `undefined`/`''`/`[]` clear it. Normalize your form library's error shape to this at the call site (e.g. an RHF `FieldError` via its `.message`). Use `renderError` to customize how the message(s) are rendered.
`renderError`	`(errors: string[]) => ReactNode`	Custom renderer for the resolved error message(s), called only when the field is in an error state. Always receives a `string[]` — use `errors[0]` for the common single-message case, or map over `errors` when a field fails several rules. By default a single message renders as text and multiple messages render on separate lines.
`hideErrorMessage`	`boolean`	If true, hides the error message text while keeping the field in an error state.
`helperText`	`ReactNode`	Content displayed in the FormHelperText component below the field when there is no visible validation error.
`formHelperTextProps`	FormHelperTextProps	FormHelperTextProps forwarded to the internal `FormHelperText`. The `id` is managed by the component. Multiple fields can be configured using the `ConfigProvider` component.
`customIds`	`{ field, label, helperText, error }`	Overrides the default field, label, helper text, and error IDs used for accessibility.

Playground#

Driven by plain React state — a single-value slider, a range slider (number array), and SliderProps (min, max, step, marks, valueLabelDisplay).

Reference#

MUI Slider

Radio Group

Switch