Button

Buttons werden verwendet, um Aktionen auf einer Seite oder in einem Formular auszulösen.

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

<Button
  onPress={() => {
    alert("Button gedrückt");
  }}
>
  Button
</Button>

Best Practices

Beschrifte den Button kurz und eindeutig. Ergänze ein aria-label, wenn der Kontext nicht klar ist, etwa bei einem reinen Icon-Button oder wenn der Text allein nicht ausreicht.
Richte die visuelle Hierarchie nach der Wichtigkeit der Aktion. Nutze dafür die verschiedenen Varianten und Colors.
Gib dem User nach der Aktion ein visuelles Feedback. Über die Action‍ lässt sich dieses Feedback steuern.

Button vs. Link

Verwende für Navigation bevorzugt Links und für Aktionen Buttons. Eine Ausnahme können hervorgehobene Call-to-Actions‍ sein, bei denen ein Button-ähnliches Erscheinungsbild für eine Navigation sinnvoll ist.

Verwende Buttons, um z. B. ...

eine Aktion auszuführen oder ein Event zu starten, ohne die Seite zu verlassen.
Formulare zu speichern oder zurückzusetzen.
in einem Modal‍ Aktionen auszuwählen.

Verwende Links, um z. B. ...

zu einer anderen Seite zu navigieren.
zu einem Anker auf der Seite zu scrollen.
eine externe Seite zu öffnen.
einen Download zu starten.

Variants

Verwende die unterschiedlichen Varianten, um Buttons in einer Oberfläche eine visuelle Hierarchie zu geben:

Solid, um Hauptaktionen hevrozuheben, die eine hohe Aufmerksamkeit erfordern.
Soft, um Nebenaktionen abzuschwächen, die visuell keine hohe Aufmerksamkeit erfordern.
Outline, um eine Aktion darzustellen, die klar als solche erkennbar sein soll, aber weniger Aufmerksamkeit als ein gefüllter Button beansprucht.
Plain, um weniger wichtige oder zurückhaltende Aktionen darzustellen.

Color

Farben unterstützen die visuelle Hierarchie zusätzlich. Verwende:

Primary, um Hauptaktionen standardmäßig visuell hervorzuheben.
Secondary, um Nebenaktionen abzuschwächen und neutral darzustellen.
Success, um die positive Bedeutung einer Aktion zu stärken. Diese Farbe wird daher vor allem im Kontext von Erstellungs-, Speicher- oder Bestellvorgängen verwendet.
Danger, um negative Konsequenzen einer Aktion zu verdeutlichen. Sie wird beispielsweise für Lösch- oder Kündigungsaktionen verwendet.

Light und Dark

Um auf farbigen Hintergründen ausreichend Kontrast zu erreichen, können Buttons auch in Light und Dark eingesetzt werden. Mehr zur richtigen Verwendung von Light und Dark findest du in den Foundations unter Color‍.

Sizes

Medium ist die Standardgröße und wird für die meisten Buttons verwendet. Small kann genutzt werden, wenn weniger Platz vorhanden ist. Vermeide es, unterschiedliche Button-Größen direkt nebeneinander zu verwenden.

States

Disabled zeigt an, dass eine Aktion nicht ausgeführt werden kann. Achte darauf, dass aus dem Kontext klar wird, warum die Aktion nicht zur Verfügung steht.

Die States Pending, Succeeded und Failed geben dem User zusätzliches visuelles Feedback darüber, dass im Hintergrund eine Aktion läuft, erfolgreich abgeschlossen wurde oder fehlgeschlagen ist. Um diese States zu steuern, kann die Action‍-Komponente genutzt werden.

Content

Der Content-Bereich eines Buttons kann entweder Text, ein Icon oder Text mit einem Icon am Ende enthalten. Achte in allen Fällen darauf, dass Text und Icon die Aktion eindeutig beschreiben.

Icon

Wenn ausschließlich ein Icon verwendet wird, sollte das aria-label den Verwendungszweck beschreiben. Ein Tooltip kann zusätzlich verdeutlichen, wofür die Aktion gedacht ist.

Text + Icon

Der Default ist Text ohne Icon, das hält die Oberfläche ruhig. Ein Icon kommt nur dazu, wenn es etwas beiträgt, das der Text allein nicht abdeckt:

Verhalten: Das Icon zeigt, wie sich der Button verhält. Ein Chevron-Icon zeigt zum Beispiel an, dass sich dahinter ein ContextMenu‍ verbirgt.
Erkennung: Das Icon steht produktweit und ausschließlich für eine Feature-Familie, nach der User scannen, z. B. das AI-Icon neben „AI Agent verbinden".

Wiederholt das Icon nur das Wort (etwa eine Diskette neben „Speichern"), bringt es nur Unruhe. Im Zweifel weglassen.

Kombiniere mit …

Combine

Benutze die Combine‍-Component, um deinen Button neben Input-Feldern zu platzieren.

Weiterleitungsziel(optional)

ActionGroup

Benutze die ActionGroup‍-Component, um zusammengehörige Aktionen zu gruppieren und automatisch in eine konsistente Hierarchie (Haupt- und Nebenaktion) zu bringen.

Action

Benutze die Action‍-Component, um die States eines Buttons zu steuern.

Properties

Property	Type	Description
`slot`	string	Slot for button placement in action groups.
`color`	dark \| light \| dark-static \| light-static \| success \| danger \| primary (default) \| secondary \| accent	The color of the button.
`variant`	solid (default) \| plain \| soft \| outline	The visual variant of the button.
`size`	s \| m (default)	The size of the button.
`isPending`	boolean	Whether the button is in a pending state.
`isSucceeded`	boolean	Whether the button is in a succeeded state.
`isFailed`	boolean	Whether the button is in a failed state.
`isReadOnly`	boolean	Whether the button is in a read only state.
`className`	ClassNameOrFunction<ButtonRenderProps>default: 'react-aria-Button'	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.
`id`	string	The element's unique identifier. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/id).
`isDisabled`	boolean	Whether the button is disabled.
`autoFocus`	boolean	Whether the element should receive focus on render.
`value`	string	The value associated with the button's name when it's submitted with the form data.
`name`	string	Submitted as a pair with the button's value as part of the form data.
`form`	string	The `<form>` element to associate the button 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/button#form).
`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.
`type`	button (default) \| submit \| reset	The behavior of the button when used in an HTML form.
`formAction`	string \| ((formData: FormData) => void \| Promise<void>)	The URL that processes the information submitted by the button. Overrides the action attribute of the button's form owner.
`formEncType`	string	Indicates how to encode the form data that is submitted.
`formMethod`	string	Indicates the HTTP method used to submit the form.
`formNoValidate`	boolean	Indicates that the form is not to be validated when it is submitted.
`formTarget`	string	Overrides the target attribute of the button's form owner.
`preventFocusOnPress`	boolean	Whether to prevent focus from moving to the button when pressing it. Caution, this can make the button inaccessible and should only be used when alternative keyboard interaction is provided, such as ComboBox's MenuTrigger or a NumberField's increment/decrement control.
`children`	ReactNode	The children of the component. A function may be provided to alter the children 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.
`translate`	yes \| no
`dir`	string
`lang`	string
`hidden`	boolean
`inert`	boolean
`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

Events

Property	Type	Description
`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.
`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.
`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.
`onPressStart`	((e: PressEvent) => void)	Handler that is called when a press interaction starts.
`onPressEnd`	((e: PressEvent) => void)	Handler that is called when a press interaction ends, either over the target or when the pointer leaves the target.
`onPressChange`	((isPressed: boolean) => void)	Handler that is called when the press state changes.
`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.
`onHoverStart`	((e: HoverEvent) => void)	Handler that is called when a hover interaction starts.
`onHoverEnd`	((e: HoverEvent) => void)	Handler that is called when a hover interaction ends.
`onHoverChange`	((isHovering: boolean) => void)	Handler that is called when the hover state changes.
`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>

Accessibility

Property	Type	Description
`aria-disabled`	boolean	Disables button but keeps it focusable.
`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-haspopup`	boolean \| false \| true \| menu \| listbox \| tree \| grid \| dialog	Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.
`aria-controls`	string	Identifies the element (or elements) whose contents or presence are controlled by the current element.
`aria-current`	boolean \| step \| false \| true \| page \| location \| date \| time	Indicates whether this element represents the current item within a container or set of related elements.
`aria-expanded`	boolean \| false \| true	Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.
`aria-pressed`	boolean \| false \| true \| mixed	Indicates the current "pressed" state of toggle buttons.

Components

Integrations