CheckboxGroup API

API documentation for CheckboxGroup component

CheckboxGroup#

Props#

Defines valid properties in CheckboxGroup component.

name	type	default	description
ref	Ref<unknown>	null	The reference to the component instance.
pIf	boolean	true	Whether the component should be rendered.
style	CSSProperties \| ((instance?: CheckboxGroupInstance) => CSSProperties)	null	The style to apply to the component.
className	string \| ((instance?: CheckboxGroupInstance) => string)	null	The class name to apply to the component.
as	string \| number \| bigint \| boolean \| ComponentClass<any, any> \| FunctionComponent<any> \| ReactElement<unknown, string \| JSXElementConstructor<any>> \| Iterable<ReactNode, any, any> \| ReactPortal \| Promise<AwaitedReactNode>	null	The component type to render.
asChild	boolean	false	Whether the component should be rendered as a child component.
pt	SafeRecord<CheckboxGroupPassThrough>	null	The pass-through props to pass to the component
ptOptions	PassThroughOptions	null	The pass-through options to pass to the component
unstyled	boolean	null	Whether the component should be rendered without classes.
dt	unknown	null	The design token to use for the component.
styles	StylesOptions<ComponentInstance>	null	The styles to use for the component.
children	ReactNode \| ((instance: CheckboxGroupInstance) => ReactNode)	null	The children to render.
name	string	null	The name of the checkboxes.
disabled	boolean	false	When present, it specifies that the checkbox group should be disabled.
invalid	boolean	false	When present, it specifies that the checkbox group is invalid.
onValueChange	(event: CheckboxGroupChangeEvent) => void	null	Callback fired when the checkboxgroup's value state changes.
value	unknown[]	null	Value of the checkbox group.
defaultValue	unknown[]	null	The default value of the checkbox group.
[key: string]	any	null
pt-{optionName}-*	-	null	Pass through attributes for customizing component. For more info, see Pass Through tab.

State#

Defines valid state in CheckboxGroup component.

name	type	default	description
value	unknown[]	null	Value of the checkbox group.

Exposes#

Defines the methods and properties exposed by CheckboxGroup component.

name	type	default	description
state	useCheckboxGroupState	null	The state of the checkbox group.
updateChange	(event: useCheckboxChangeEvent<SyntheticEvent<Element, Event>> & { value: unknown }) => void	null	Updates the value of the checkbox group.

Events#

CheckboxGroupChangeEvent

Event fired when the checkbox's checked state changes.

name	type	description
value	unknown[]	The value of the checkbox group.

Interfaces#

PassThroughOptions

Defines passthrough(pt) options of Checkbox component.

name	type	default	description
root	CheckboxGroupPassThroughType<HTMLAttributes<HTMLDivElement>>	null	Used to pass attributes to the root's DOM element.

Types#

Instance

Instance of CheckboxGroup component.

values
ComponentInstance<CheckboxGroupProps, CheckboxGroupState, CheckboxGroupExposes>

useCheckboxGroup#

Props#

Defines valid properties in useCheckboxGroup.

name	type	default	description
value	unknown[]	null	Value of the checkbox group.
defaultValue	unknown[]	null	The default value of the checkbox group.
onValueChange	(event: useCheckboxGroupChangeEvent) => void	null	Callback fired when the checkboxgroup's value state changes.

State#

Defines valid state in useCheckboxGroup.

name	type	default	description
value	unknown[]	null	Value of the checkbox group.

Exposes#

Defines the methods and properties exposed by useCheckboxGroup.

name	type	default	description
state	useCheckboxGroupState	null	The state of the checkbox group.
updateChange	(event: useCheckboxChangeEvent<SyntheticEvent<Element, Event>> & { value: unknown }) => void	null	Updates the value of the checkbox group.

Events#

useCheckboxGroupChangeEvent

Event fired when the checkbox's checked state changes.

name	type	description
value	unknown[]	The value of the checkbox group.

Types#

Instance

Instance of useCheckboxGroup headless.

values
HeadlessInstance<useCheckboxGroupProps, useCheckboxGroupState, useCheckboxGroupExposes>