CopyButton

Mit dem CopyButton können Informationen mit einem Klick in die Zwischenablage kopiert werden.
import { CopyButton } from "@mittwald/flow-react-components";

<CopyButton text="Kopierter Inhalt" />

Best Practices

  • Platziere den CopyButton unmittelbar neben dem zu kopierenden Text. Die Combine-Component hilft bei der Anordnung.
  • Nutze standardmäßig die Secondary Color. So bleibt der CopyButton trotz häufiger Nutzung in der Oberfläche optisch zurückhaltend.

Kombiniere mit …

Combine

Benutze die Combine-Component, um einen CopyButton neben dem zu kopierenden Text zu platzieren.

mail.agenturserver.de

Properties

PropertyTypeDescription
autoFocus
boolean
Whether the element should receive focus on render.
children
ReactNode
The children of the component. A function may be provided to alter the children based on component 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.
color
dark | light | dark-static | light-static | success | danger | primary (default) | secondary | accent
The color of the button.
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 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).
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.
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
isDisabled
boolean
Whether the button is disabled.
isFailed
boolean
Whether the button is in a failed state.
isPending
boolean
Whether the button is in a pending state.
isReadOnly
boolean
Whether the button is in a read only state.
isSucceeded
boolean
Whether the button is in a succeeded state.
lang
string
name
string
Submitted as a pair with the button's value as part of the form data.
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.
size
s | m (default)
The size of the button.
slot
string
Slot for button placement in action groups.
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.
text
string
The text to copy.
translate
yes | no
type
button (default) | submit | reset
The behavior of the button when used in an HTML form.
value
string
The value associated with the button's name when it's submitted with the form data.
variant
solid (default) | plain | soft | outline
The visual variant of the button.
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

PropertyTypeDescription
onBlur
((e: FocusEvent<Element, Element>) => void)
Handler that is called when the element loses focus.
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.
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

PropertyTypeDescription
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-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-disabled
boolean
Disables button but keeps it focusable.
aria-expanded
boolean | false | true
Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.
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-labelledby
string
Identifies the element (or elements) that labels the current element.
aria-pressed
boolean | false | true | mixed
Indicates the current "pressed" state of toggle buttons.

Auf dieser Seite