CheckboxGroupInput

A group of checkboxes for choosing several values.

Installation

pnpm dlx shadcn@latest add @chelone/checkbox-group-input

Loading preview…

A group of checkboxes for choosing several values.

Props

Prop	Type	Default	Description
alwaysOn	boolean	—	As a `<FilterForm>`/`<FilterButton>` filter: always shown, never in the add-filter menu. Read off the element by the filter layer, never by the input.
choices	readonly string \| TChoice[]	—	Inline choices (`{ id, name }[]` or `string[]`). Omitted under a reference wrapper.
defaultValue	NoInfer<SourceValue<TRecord, TPath>>	—	Input-level default, ra precedence (seeds only into an untouched hole). Typed as the value at `source`; `unknown` without a record.
disabled	boolean	—	Native disabled state.
disableValue	SourcePath<TChoice>	—	The disabled-flag path. Default `disabled`.
format	(value: unknown) => unknown	—
helperText	ReactNode	—	Helper text rendered below the input; a string is translated.
id	string	—	Explicit element id; a generated `useId` value is used otherwise.
isRequired	boolean	—	Forces the required marker; ORed with `required()` detection on `validate`.
label	ReactNode	—	The input label. A string is translated; a ReactNode renders as-is; `false` (or `""`) renders no label.
labelPlacement	"end" \| "start" \| "top" \| "bottom"	—
name	string	—	Legacy field-name alias (ra parity); the wiring uses `source`.
onBlur	(event: unknown) => void	—	Chained AFTER the blur is recorded.
onChange	(eventOrValue: unknown) => void	—	Chained AFTER the parsed value is written to the form.
options	CheckboxProps & RefAttributes<HTMLButtonElement>	—
optionText	OptionText<TChoice>	—	The display path (dot/bracket) or a formatter over the whole choice. Default `name`.
optionValue	SourcePath<TChoice>	—	The value path. Default `id`.
parse	(value: unknown) => NoInfer<SourceTransformValue<TRecord, TPath>>	—	Write transform (input value → stored value). Must return the value at `source`; `unknown` without a record.
readOnly	boolean	—	Native read-only state.
resource	string	—	Override the ambient resource (used to resolve the default label key).
row	boolean	—
source	TPath	—	The field path RELATIVE to the ambient source scope.
translateChoice	boolean	—	Translate a string-path label.
type	string	—	The DOM input `type` (text inputs default to `"text"`).
validate	Validator \| readonly Validator[]	—	ra-contract validators — composed, first error wins.