Checkbox

Checkbox displays a list of options where multiple can be selected at once. When a choice is made, the user can click again to deselect it.

Read more about this component in the Aksel documentation.

Choose options

["2"]

Properties

Property	Description	Default	Control
Properties
legend required	Legend of the fieldset. `string` `Snippet`	-	Value for property
description	Description of the fieldset. `string` `Snippet`	-
disabled	Disables element `boolean`	`false`
error	Error message for element. `string`	`""`
errorId	Override internal errorId. `string`	`""`
hideLegend	If enabled shows the legend and description for screen readers only. `boolean`	`false`
id	Override internal id. `string`	`"cbg-" + newUniqueId()`
size	Changes font-size, padding and gaps. `"medium"` `"small"`	`"medium"`
value bindable	Controlled state for checkboxes. `unknown[]`	`[]`
Snippets
children	List of checkboxes		-
legend	Legend of the fieldset.		-
description	Description of the fieldset.		-

Properties included from: HTMLFieldsetAttributes

Checkbox displays a list of options where multiple can be selected at once. When a choice is made, the user can click again to deselect it.

Read more about this component in the Aksel documentation.

Property	Description	Default	Control
Properties
checked bindable	Controlled state for checkboxes. `boolean`	`undefined`
description	Adds a description to extend labeling of Checkbox `string`	`""`
disabled	Disables element `boolean`	`false`
error	Adds error indication on checkbox `boolean`	`false`
hideLabel	Adds error indication on checkbox `boolean`	`false`
id	Override internal id `string`	`"cb-" + newUniqueId()`
indeterminate	Specify whether the Checkbox is in an indeterminate state Note: This is a client side only feature `boolean`	`false`
size	Changes font-size, padding and gaps `"medium"` `"small"`	-
value	The value of the HTML element. `string`	-
Snippets
children	Label text		-
Events
onchange	onchange event		-

Properties included from: Omit<HTMLInputAttributes, "size">