Komponenten
Codeblock (CodeBlock)
StabilCode unverändert anzeigen, waagerecht scrollbar und mit Kopierknopf.
CodeBlock zeigt einen Text unverändert in Monospace: eine Abfrage, eine
Konfiguration, einen kurzen Befehl. Der Block scrollt waagerecht, statt
umzubrechen, damit Einrückung und Zeilenlänge erhalten bleiben.
Wann verwenden
- Für Code und Befehle, die genau so übernommen werden sollen, wie sie dastehen.
- Wenn der Text länger als eine Zeile ist und waagerecht scrollen darf.
- Wenn ein Kopierknopf direkt am Block sitzen soll –
showCopyist standardmäßig aktiv. - In Produktoberflächen für Konfigurationswerte und Abfragen.
Wann nicht
- Für Fließtext mit einzelnen Fachbegriffen. Dafür genügt
codeim Satz. - Für mehrzeilige Ausgaben, die zeilenweise gelesen werden müssen. Dort passt eine Liste oder eine Tabelle besser.
- Für Syntaxhervorhebung.
CodeBlockgibt den Text unverändert aus; Farben kommen nicht dazu. - Für sehr lange Dateien in einer Ansicht. Ein Block ohne Höhenbegrenzung schiebt den Rest der Seite nach unten.
Ein Codeblock
code enthält den Text, language beschriftet den Scrollbereich für
Screenreader. Ohne language lautet die Beschriftung „Code“.
const frei = betten.filter((bett) => bett.status === "frei");
console.log("Freie Betten:", frei.length);import { CodeBlock } from "@neodin-eu/ui";
const CODE = `const frei = betten.filter((bett) => bett.status === "frei");
console.log("Freie Betten:", frei.length);`;
function Beispiel() {
return (
<div className="w-full max-w-xl">
<CodeBlock code={CODE} language="ts" />
</div>
);
}Ohne Kopierknopf
Mit showCopy={false} entfällt der Knopf oben rechts. Das passt, wenn der
Block nur gelesen wird oder die Kopierfunktion an anderer Stelle sitzt.
SELECT zimmer, status
FROM betten
WHERE station = '3'
ORDER BY zimmer;import { CodeBlock } from "@neodin-eu/ui";
const CODE = `SELECT zimmer, status
FROM betten
WHERE station = '3'
ORDER BY zimmer;`;
function OhneKopieren() {
return (
<div className="w-full max-w-xl">
<CodeBlock code={CODE} language="sql" showCopy={false} />
</div>
);
}Hinweis zur Doku
Diese Dokumentationsseite zeigt Code und Beispiele in einer eigenen dunklen
Karte. Das ist eine Eigenheit der Doku. CodeBlock aus der Bibliothek ist für
Produktoberflächen gedacht und folgt dem Seiten-Theme: hell auf hellem Grund,
dunkel im Dunkelmodus. Die Beispiele oben rendern die Komponente so, wie sie
in einem Produkt erscheint.
Barrierefreiheit
- Das
pre-Element ist mittabindex="0"fokussierbar. So lässt sich der waagerechte Scrollbereich mit der Tastatur erreichen und mit den Pfeiltasten scrollen; der Fokusring ist sichtbar. - Der Scrollbereich trägt
aria-labelauslanguage, ohne Angabe „Code“. Screenreader können ihn damit benennen. Beides prüft der Komponententest. - Der Kopierknopf ist derselbe wie oben: natives
button-Element, Name „Kopieren“ beziehungsweise „Kopiert“, Symbolaria-hidden. - Ohne
showCopygibt es keinen Knopf und damit auch keinen zusätzlichen Fokuspunkt. - Im Komponententest ist der Block in hell und dunkel frei von axe-Verstößen.
Props
| Prop | Typ | Standard | Pflicht | Beschreibung |
|---|---|---|---|---|
| className | string | – | Nein | – |
| code | string | – | Ja | Code shown verbatim, without syntax highlighting. |
| language | string | – | Nein | Language name; used as the accessible label of the scroll region. |
| showCopy | boolean | true | Nein | Show the copy button in the top-right corner. |