CheckboxButton

Der CheckboxButton ist eine auffälligere Variante der Checkbox.

Ich stimme den AGBs zu und bestätige, dass ich die Datenschutzhinweise zur Kenntnis genommen habe.

import { CheckboxButton } from "@mittwald/flow-react-components";

<CheckboxButton>
  Ich stimme den AGBs zu und bestätige, dass ich die
  Datenschutzhinweise zur Kenntnis genommen habe.
</CheckboxButton>

Best Practices

Wähle den initialen Zustand nachvollziehbar und sinnvoll.
Ordne mehrere CheckboxButtons logisch und nachvollziehbar an. Mehr dazu unter CheckboxGroup‍.
Nutze für eine kompaktere, unauffälligere Auswahl alternativ die Checkbox‍.

CheckboxButton vs. Switch

Mit den Components CheckboxButton und Switch‍ können Optionen aktiviert/ausgewählt werden.

Verwende einen CheckboxButton, um z. B. ...

dem User eine Auswahloption zur Bestätigung zu geben.
Auswahlmöglichkeiten in einem Formular anzubieten, die gespeichert werden müssen.

Verwende einen Switch, um z. B. ...

eine Funktion direkt zu aktivieren oder zu deaktivieren.
eine Einstellung sofort zu ändern, ohne sie separat speichern zu müssen.

Kombiniere mit …

React Hook Form

Weitere Details zur Formularlogik und -validierung findest du in der Component Form (React Hook Form)‍.

Properties

Property	Type	Default	Description
`autoFocus`	`boolean`	-	Whether the element should receive focus on render.
`children`	`ReactNode`	-
`className`	`ClassNameOrFunction<CheckboxGroupRenderProps>`	'react-aria-CheckboxGroup'	The CSS [className](https://developer.mozilla.org/en-US/docs/Web/API/Element/className) for the element. A function may be provided to compute the class based on component state.
`defaultSelected`	`boolean`	-	Whether the element should be selected (uncontrolled).
`dir`	`string`	-
`excludeFromTabOrder`	`boolean`	-	Whether to exclude the element from the sequential tab order. If true, the element will not be focusable via the keyboard by tabbing. This should be avoided except in rare scenarios where an alternative means of accessing the element or its functionality via the keyboard is available.
`form`	`string`	-	The `<form>` element to associate the input with. The value of this attribute must be the id of a `<form>` in the same document. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#form).
`hidden`	`boolean`	-
`id`	`string`	-	The element's unique identifier. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/id).
`inert`	`boolean`	-
`inputClassName`	`string`	-	The class name of the underlying input element.
`isDisabled`	`boolean`	-	Whether the input is disabled.
`isIndeterminate`	`boolean`	-	Indeterminism is presentational only. The indeterminate visual representation remains regardless of user interaction.
`isInvalid`	`boolean`	-	Whether the input value is invalid.
`isReadOnly`	`boolean`	-	Whether the input can be selected but not changed by the user.
`isRequired`	`boolean`	-	Whether user input is required on the input before form submission.
`isSelected`	`boolean`	-	Whether the element should be selected (controlled).
`lang`	`string`	-
`name`	`string`	-	The name of the input element, used when submitting an HTML form. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#htmlattrdefname).
`render`	`DOMRenderFunction<"div", TooltipRenderProps>`	-	Overrides the default DOM element with a custom render function. This allows rendering existing components with built-in styles and behaviors such as router links, animation libraries, and pre-styled components. Requirements: - You must render the expected element type (e.g. if `<button>` is expected, you cannot render an `<a>`). - Only a single root DOM element can be rendered (no fragments). - You must pass through props and ref to the underlying DOM element, merging with your own prop as appropriate.
`slot`	`string`	-	A slot name for the component. Slots allow the component to receive props from a parent component. An explicit `null` value indicates that the local props completely override all props received from a parent.
`style`	`StyleOrFunction<TooltipRenderProps>`	-	The inline [style](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/style) for the element. A function may be provided to compute the style based on component state.
`translate`	`"yes" \| "no"`	-
`validate`	`((value: TimeValue) => true \| ValidationError)`	-	A function that returns an error message if a given value is invalid. Validation errors are displayed to the user when the form is submitted if `validationBehavior="native"`. For realtime validation, use the `isInvalid` prop instead.
`validationBehavior`	`"native" \| "aria"`	'native'	Whether to use native HTML form validation to prevent form submission when the value is missing or invalid, or mark the field as required or invalid via ARIA.
`value`	`string`	-	The value of the input element, used when submitting an HTML form. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#htmlattrdefvalue).
`wrapWith`	`ReactElement<unknown, string \| JSXElementConstructor<any>>`	-	A React element the component is wrapped with. The element is cloned and receives the component as its only child — useful to render the component inside a link, a tooltip trigger or any other wrapper without changing the surrounding markup.

Events

Property	Type	Default	Description
`onBlur`	`((e: FocusEvent<Element, Element>) => void)`	-	Handler that is called when the element loses focus.
`onChange`	`((isSelected: boolean) => void)`	-	Handler that is called when the element's selection state changes.
`onClick`	`((e: MouseEvent<FocusableElement, MouseEvent>) => void)`	-	Not recommended – use `onPress` instead. `onClick` is an alias for `onPress` provided for compatibility with other libraries. `onPress` provides additional event details for non-mouse interactions.
`onFocus`	`((e: FocusEvent<Element, Element>) => void)`	-	Handler that is called when the element receives focus.
`onFocusChange`	`((isFocused: boolean) => void)`	-	Handler that is called when the element's focus status changes.
`onHoverChange`	`((isHovering: boolean) => void)`	-	Handler that is called when the hover state changes.
`onHoverEnd`	`((e: HoverEvent) => void)`	-	Handler that is called when a hover interaction ends.
`onHoverStart`	`((e: HoverEvent) => void)`	-	Handler that is called when a hover interaction starts.
`onKeyDown`	`((e: KeyboardEvent) => void)`	-	Handler that is called when a key is pressed.
`onKeyUp`	`((e: KeyboardEvent) => void)`	-	Handler that is called when a key is released.
`onPress`	`((e: PressEvent) => void)`	-	Handler that is called when the press is released over the target.
`onPressChange`	`((isPressed: boolean) => void)`	-	Handler that is called when the press state changes.
`onPressEnd`	`((e: PressEvent) => void)`	-	Handler that is called when a press interaction ends, either over the target or when the pointer leaves the target.
`onPressStart`	`((e: PressEvent) => void)`	-	Handler that is called when a press interaction starts.
`onPressUp`	`((e: PressEvent) => void)`	-	Handler that is called when a press is released over the target, regardless of whether it started on the target or not.

Accessibility

Property	Type	Default	Description
`aria-controls`	`string`	-	Identifies the element (or elements) whose contents or presence are controlled by the current element.
`aria-describedby`	`string`	-	Identifies the element (or elements) that describes the object.
`aria-details`	`string`	-	Identifies the element (or elements) that provide a detailed, extended description for the object.
`aria-errormessage`	`string`	-	Identifies the element that provides an error message for the object.
`aria-label`	`string`	-	Defines a string value that labels the current element.
`aria-labelledby`	`string`	-	Identifies the element (or elements) that labels the current element.

Components

Integrations