Zum Inhalt springen
Dokumentation

Komponenten

Kopierknopf (CopyButton)

Stabil

Einen Wert in die Zwischenablage legen – mit kurzer Bestätigung statt einer Meldung.

Der Kopierknopf legt einen festen Text in die Zwischenablage: einen Befehl, eine Kennung, einen Link. Nach dem Klick zeigt er für zwei Sekunden ein Häkchen und die Beschriftung „Kopiert“, danach steht wieder „Kopieren“ da.

Wann verwenden

  • Bei Kennungen und Nummern, die abgetippt fehleranfällig sind – etwa eine Ticket- oder Stationskennung.
  • Bei Befehlen und Codezeilen, die in ein Terminal gehören.
  • Wenn der Wert daneben sichtbar bleibt. Der Knopf ergänzt die Anzeige, er ersetzt sie nicht.
  • Für genau einen Wert pro Knopf. Der Text steht in der Prop value fest.

Wann nicht

  • Für längere Fließtexte. Dafür ist die Auswahl mit der Maus gedacht.
  • Als einzige Aktion einer Zeile, wenn auch etwas geändert werden soll – dann braucht es beschriftete Schaltflächen.
  • Wenn ein Link das Ziel selbst erreichbar macht. Ein Link lässt sich öffnen und kopieren, ohne dass die Seite etwas tun muss.
  • Für Werte, die nicht kopiert werden dürfen, etwa personenbezogene Daten.

Neben einem Wert

Der Knopf steht rechts neben dem Wert, den er kopiert. value und der sichtbare Text müssen übereinstimmen, sonst kopiert der Knopf etwas anderes, als daneben steht.

pnpm add @neodin-eu/ui
Beispiel und Quelltext
befehl.tsx
import { CopyButton } from "@neodin-eu/ui";

const BEFEHL = "pnpm add @neodin-eu/ui";

function Befehl() {
  return (
    <div className="flex w-full max-w-md items-center justify-between gap-3 rounded-md border border-border bg-background px-3 py-2">
      <code className="font-mono text-sm text-foreground">{BEFEHL}</code>
      <CopyButton value={BEFEHL} />
    </div>
  );
}

In einer Zeile

In einer Liste aus Kennungen trägt jede Zeile ihren eigenen Knopf. Der zugängliche Name bleibt „Kopieren“; was kopiert wird, sagt der Text daneben.

TicketTICKET-2048
StationSTATION-3
Beispiel und Quelltext
zeile.tsx
import { CopyButton } from "@neodin-eu/ui";

const KENNUNG = "TICKET-2048";

function Zeile() {
  return (
    <div className="w-full max-w-md rounded-md border border-border bg-background">
      <div className="flex items-center justify-between gap-3 border-b border-border px-3 py-2">
        <span className="text-sm text-muted-foreground">Ticket</span>
        <span className="flex items-center gap-2">
          <span className="font-mono text-sm text-foreground">{KENNUNG}</span>
          <CopyButton value={KENNUNG} />
        </span>
      </div>
      <div className="flex items-center justify-between gap-3 px-3 py-2">
        <span className="text-sm text-muted-foreground">Station</span>
        <span className="flex items-center gap-2">
          <span className="font-mono text-sm text-foreground">STATION-3</span>
          <CopyButton value="STATION-3" />
        </span>
      </div>
    </div>
  );
}

Barrierefreiheit

  • CopyButton rendert ein natives button-Element mit type="button". Tab fokussiert, Enter und die Leertaste lösen das Kopieren aus.
  • Die Schaltfläche zeigt nur ein Symbol. Der zugängliche Name kommt aus aria-label und wechselt mit dem Zustand: „Kopieren“ vor dem Klick, „Kopiert“ für zwei Sekunden danach. Das Symbol selbst ist aria-hidden.
  • Die Bestätigung ist am Knopf sichtbar und über den Namen auch für Screenreader erkennbar; eine zusätzliche Meldung braucht es nicht.
  • Der Fokus ist über focus-visible sichtbar. Ein gesperrter Knopf trägt disabled und ist nicht fokussierbar.
  • Schlägt der Zugriff auf die Zwischenablage fehl, bleibt der Knopf ruhig und zeigt keine falsche Bestätigung. Das ist im Komponententest abgesichert.
  • Der Komponententest prüft außerdem den Wechsel nach zwei Sekunden, die englische Beschriftung und axe in hell und dunkel.

Props

Props von CopyButton
PropTypStandardPflichtBeschreibung
classNamestring–Nein–
disabledboolean–Nein–
valuestring–JaText written to the clipboard when the button is activated.

Siehe auch