Jamdesk Documentation logo

Farbe

Dokumentation der Color-Komponente, die Hex-, RGB- und RGBA-Farbfelder in kompakten Rastern oder gruppierten Tabellen mit optionalen Werten pro Theme anzeigt

Color zeigt Hex-, RGB- und RGBA-Werte als Farbfelder an, die sich per Klick kopieren lassen. Es gibt zwei Layout-Varianten: ein kompaktes Raster und eine gruppierte Tabelle. Ein Farbfeld kann für jedes Theme einen eigenen Wert erhalten.

Verwende Color, wenn du:

  • Design-Systeme dokumentierst mit Markenfarben
  • Theme-Farben zeigst, die sich mit dem Theme ändern
  • Farbskalen darstellst (primary-100 bis primary-900)
  • Markenrichtlinien mit Hex-/RGB-Werten teilst

Verwendung

<Color>
  <ColorItem name="Primary" value="#635BFF" />
</Color>

Kompakte Variante

Das Standard-Layout zeigt Farben in einem responsiven Raster an:

Primary
#3b82f6
Success
#22c55e
Warning
#f59e0b
Error
#ef4444
<Color>
  <ColorItem name="Primary" value="#3b82f6" />
  <ColorItem name="Success" value="#22c55e" />
  <ColorItem name="Warning" value="#f59e0b" />
  <ColorItem name="Error" value="#ef4444" />
</Color>

Tabellenvariante

Gruppiere Farben in beschriftete Zeilen:

Markenfarben
Primary#3b82f6
Secondary#6366f1
Feedback-Farben
Success#22c55e
Error#ef4444
<Color variant="table">
  <ColorRow title="Brand Colors">
    <ColorItem name="Primary" value="#3b82f6" />
    <ColorItem name="Secondary" value="#6366f1" />
  </ColorRow>
  <ColorRow title="Feedback Colors">
    <ColorItem name="Success" value="#22c55e" />
    <ColorItem name="Error" value="#ef4444" />
  </ColorRow>
</Color>

Konventionen für Farbnamen

MusterBeispielVerwendung für
Semantischsuccess, error, warningFeedback-Farben
Numerische Skalaprimary-500, gray-100Farbpaletten
Beschreibendbrand-blue, accent-goldMarkenfarben

Theme-abhängige Farben

Übergib ein Objekt mit den Eigenschaften light und dark, um pro Theme eine Farbe festzulegen:

Theme
Background
#ffffff
Theme
Foreground
#171717
Theme
Border
#e5e5e5
<Color>
  <ColorItem name="Background" value={{ light: "#ffffff", dark: "#0a0a0a" }} />
  <ColorItem name="Foreground" value={{ light: "#171717", dark: "#ededed" }} />
  <ColorItem name="Border" value={{ light: "#e5e5e5", dark: "#404040" }} />
</Color>

Farbformate

Die Komponente akzeptiert Hex-, RGB- und RGBA-Werte:

Hex
#3b82f6
RGB
rgb(59, 130, 246)
RGBA
rgba(59, 130, 246, 0.8)
<Color>
  <ColorItem name="Hex" value="#3b82f6" />
  <ColorItem name="RGB" value="rgb(59, 130, 246)" />
  <ColorItem name="RGBA" value="rgba(59, 130, 246, 0.8)" />
</Color>

Props

Color

stringdefault: compact

Layout-Stil: compact (Raster) oder table (gruppierte Zeilen).

node

ColorItem- oder ColorRow-Elemente.

ColorRow

string

Beschriftung über der Zeile.

node

ColorItem-Elemente.

ColorItem

string

Anzeigename für die Farbe.

string | object

Farbwert als CSS-String oder { light: string, dark: string } für theme-abhängige Farben.

Wie geht es weiter?

Komponenten-Übersicht

Alle verfügbaren Komponenten durchsuchen

MDX-Grundlagen

Erfahre, wie du Komponenten in MDX verwendest