RadioGroup

Eine RadioGroup ermöglicht die Auswahl genau einer Option aus einer Gruppe.

Täglicher Kaffeekonsum(optional)

import {
  Label,
  Radio,
  RadioGroup,
} from "@mittwald/flow-react-components";

<RadioGroup defaultValue="more">
  <Label>Täglicher Kaffeekonsum</Label>
  <Radio value="more">Mehr als 6 Tassen</Radio>
  <Radio value="5-6">5-6 Tassen</Radio>
  <Radio value="3-4">3-4 Tassen</Radio>
  <Radio value="1-2">1-2 Tassen</Radio>
  <Radio value="none">Trinke keinen Kaffee</Radio>
</RadioGroup>

Best Practices

Beschrifte die RadioGroup mit einem Label‍. Übernimmt ein nahes Element wie eine Heading‍ diese Rolle, setze stattdessen aria-label bzw. aria-labelledby.
Nutze bei vielen Optionen ein Select‍, um die Oberfläche aufgeräumt zu halten. Als Faustregel ab etwa sieben Optionen.
Wähle zu Beginn eine sinnvolle Option vor. Das vermeidet unnötige Fehlermeldungen.
Ordne die Optionen nach Wichtigkeit. Die wichtigste steht oben; eine Option mit weitreichenden Folgen gehört nach unten und ist nie vorausgewählt.
Formuliere die Optionen klar unterscheidbar. So erkennt der User die passende Wahl auf einen Blick.
Folge in einem Formular dem Form-Pattern‍. Dort sind Aufbau, Validierung und Fehlerbehandlung geregelt.

States

In einer RadioGroup sollte immer eine sinnvolle Option vorausgewählt (Selected) sein.

Disabled

Um Optionen in der RadioGroup zu deaktivieren, lässt sich der Disabled-State für die gesamte RadioGroup oder gezielt für einzelne Radios bzw. RadioButtons setzen.

Error

Ein Error-State wird angezeigt, wenn etwas schiefgelaufen ist (siehe Fehlermeldungen‍). Da meist eine Option vorselektiert ist, wird er nur selten benötigt.

Datenbank-Typ(optional)Bitte wähle eine Option aus

RadioButtons

Um Inhalte stärker hervorzuheben und die Klickfläche zu vergrößern, lassen sich statt <Radio /> auch <RadioButton /> nutzen.

Datenbank-Typ(optional)

Weiterer Inhalt

Anstelle einer einfachen Bezeichnung kann der <RadioButton /> auch mit zusätzlichem Inhalt gefüllt werden. Verwende dazu innerhalb des <RadioButton /> Text‍ für eine Überschrift und <Content /> für Fließtext.

Benutzerdefinierte Spalten

Die RadioGroup verwendet das ColumnLayout‍, um eine Anpassung der Spalten zu ermöglichen. Bei der Verwendung von RadioButtons entspricht der Default dem des ColumnLayouts, während Radios im Default untereinander angezeigt werden.

Benutzerdefinierte Spalten(optional)

FieldDescription

Für eine kurze Hilfestellung zu den Optionen kann unterhalb der <Radio /> oder <RadioButton /> eine <FieldDescription /> eingebaut werden.

Wie viele Pflanzen besitzt du?(optional)Mehrere identische Pflanzen in einem Topf gelten als eine Pflanze.

Kombiniere mit …

ContextualHelp

Benutze die ContextualHelp‍ Component, wenn du weitere Informationen bereitstellen möchtest, und diese zu lang für die FieldDescription sind.

Täglicher Kaffeekonsum(optional)

React Hook Form

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

Properties

Property	Type	Description
`id`	string	The element's unique identifier. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/id).
`translate`	yes \| no
`className`	ClassNameOrFunction<RadioGroupRenderProps>default: 'react-aria-RadioGroup'	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.
`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.
`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.
`dir`	string
`lang`	string
`hidden`	boolean
`inert`	boolean
`validationBehavior`	native (default) \| aria	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.
`isDisabled`	boolean	Whether the input is disabled.
`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.
`isInvalid`	boolean	Whether the input value is invalid.
`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.
`value`	TimeValue	The current value (controlled).
`defaultValue`	TimeValue	The default value (uncontrolled).
`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).
`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).
`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.
`orientation`	Orientationdefault: 'vertical'	The axis the Radio Button(s) should align with.
`children`	ReactNode
`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.
`ref`	Ref<HTMLSpanElement>	Allows getting a ref to the component instance. Once the component unmounts, React will set `ref.current` to `null` (or call the ref with `null` if you passed a callback ref). @see React Docs
`key`	Key
`s`	(number)[]	Column layout for container size s.
`m`	(number)[]	Column layout for container size m.
`l`	(number)[]	Column layout for container size l.

Events

Property	Type	Description
`onClick`	MouseEventHandler<HTMLDivElement>
`onClickCapture`	MouseEventHandler<HTMLDivElement>
`onAuxClick`	MouseEventHandler<HTMLDivElement>
`onAuxClickCapture`	MouseEventHandler<HTMLDivElement>
`onContextMenu`	MouseEventHandler<HTMLDivElement>
`onContextMenuCapture`	MouseEventHandler<HTMLDivElement>
`onDoubleClick`	MouseEventHandler<HTMLDivElement>
`onDoubleClickCapture`	MouseEventHandler<HTMLDivElement>
`onMouseDown`	MouseEventHandler<HTMLDivElement>
`onMouseDownCapture`	MouseEventHandler<HTMLDivElement>
`onMouseEnter`	MouseEventHandler<HTMLDivElement>
`onMouseLeave`	MouseEventHandler<HTMLDivElement>
`onMouseMove`	MouseEventHandler<HTMLDivElement>
`onMouseMoveCapture`	MouseEventHandler<HTMLDivElement>
`onMouseOut`	MouseEventHandler<HTMLDivElement>
`onMouseOutCapture`	MouseEventHandler<HTMLDivElement>
`onMouseOver`	MouseEventHandler<HTMLDivElement>
`onMouseOverCapture`	MouseEventHandler<HTMLDivElement>
`onMouseUp`	MouseEventHandler<HTMLDivElement>
`onMouseUpCapture`	MouseEventHandler<HTMLDivElement>
`onTouchCancel`	TouchEventHandler<HTMLDivElement>
`onTouchCancelCapture`	TouchEventHandler<HTMLDivElement>
`onTouchEnd`	TouchEventHandler<HTMLDivElement>
`onTouchEndCapture`	TouchEventHandler<HTMLDivElement>
`onTouchMove`	TouchEventHandler<HTMLDivElement>
`onTouchMoveCapture`	TouchEventHandler<HTMLDivElement>
`onTouchStart`	TouchEventHandler<HTMLDivElement>
`onTouchStartCapture`	TouchEventHandler<HTMLDivElement>
`onPointerDown`	PointerEventHandler<HTMLDivElement>
`onPointerDownCapture`	PointerEventHandler<HTMLDivElement>
`onPointerMove`	PointerEventHandler<HTMLDivElement>
`onPointerMoveCapture`	PointerEventHandler<HTMLDivElement>
`onPointerUp`	PointerEventHandler<HTMLDivElement>
`onPointerUpCapture`	PointerEventHandler<HTMLDivElement>
`onPointerCancel`	PointerEventHandler<HTMLDivElement>
`onPointerCancelCapture`	PointerEventHandler<HTMLDivElement>
`onPointerEnter`	PointerEventHandler<HTMLDivElement>
`onPointerLeave`	PointerEventHandler<HTMLDivElement>
`onPointerOver`	PointerEventHandler<HTMLDivElement>
`onPointerOverCapture`	PointerEventHandler<HTMLDivElement>
`onPointerOut`	PointerEventHandler<HTMLDivElement>
`onPointerOutCapture`	PointerEventHandler<HTMLDivElement>
`onGotPointerCapture`	PointerEventHandler<HTMLDivElement>
`onGotPointerCaptureCapture`	PointerEventHandler<HTMLDivElement>
`onLostPointerCapture`	PointerEventHandler<HTMLDivElement>
`onLostPointerCaptureCapture`	PointerEventHandler<HTMLDivElement>
`onScroll`	UIEventHandler<HTMLDivElement>
`onScrollCapture`	UIEventHandler<HTMLDivElement>
`onWheel`	WheelEventHandler<HTMLDivElement>
`onWheelCapture`	WheelEventHandler<HTMLDivElement>
`onAnimationStart`	AnimationEventHandler<HTMLDivElement>
`onAnimationStartCapture`	AnimationEventHandler<HTMLDivElement>
`onAnimationEnd`	AnimationEventHandler<HTMLDivElement>
`onAnimationEndCapture`	AnimationEventHandler<HTMLDivElement>
`onAnimationIteration`	AnimationEventHandler<HTMLDivElement>
`onAnimationIterationCapture`	AnimationEventHandler<HTMLDivElement>
`onTransitionCancel`	TransitionEventHandler<HTMLDivElement>
`onTransitionCancelCapture`	TransitionEventHandler<HTMLDivElement>
`onTransitionEnd`	TransitionEventHandler<HTMLDivElement>
`onTransitionEndCapture`	TransitionEventHandler<HTMLDivElement>
`onTransitionRun`	TransitionEventHandler<HTMLDivElement>
`onTransitionRunCapture`	TransitionEventHandler<HTMLDivElement>
`onTransitionStart`	TransitionEventHandler<HTMLDivElement>
`onTransitionStartCapture`	TransitionEventHandler<HTMLDivElement>
`onFocus`	((e: FocusEvent<Element, Element>) => void)	Handler that is called when the element receives focus.
`onBlur`	((e: FocusEvent<Element, Element>) => void)	Handler that is called when the element loses focus.
`onFocusChange`	((isFocused: boolean) => void)	Handler that is called when the element's focus status changes.
`onChange`	((value: TimeValue) => void)	Handler that is called when the value changes.

Accessibility

Property	Type	Description
`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.
`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.

Components

Integrations