Jamdesk Documentation logo

Farbe

Die Color-Komponente zeigt Farbpaletten zur Dokumentation von Designsystemen, Markenrichtlinien und Farbspezifikationen.

Color zeigt Hex-, RGB- und RGBA-Werte als anklickbare Farbfelder zum Kopieren an. Sie bietet zwei Layoutvarianten: ein kompaktes Raster und eine gruppierte Tabelle, jeweils mit integrierter Unterstützung für den hellen und dunklen Modus.

Verwenden Sie Color für:

  • Designsysteme dokumentieren mit Markenfarben
  • Theme-Farben anzeigen für den hellen und dunklen Modus
  • Farbskalen darstellen (primary-100 bis primary-900)
  • Markenrichtlinien teilen mit Hex-/RGB-Werten

Verwendung

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

Kompakte Variante

Das Standardlayout zeigt Farben in einem responsiven Raster an:

Primär
#3b82f6
Erfolg
#22c55e
Warnung
#f59e0b
Fehler
#ef4444
<Color>
  <ColorItem name="Primary" value="#3b82f6" />
  <ColorItem name="Success" value="#22c55e" />
  <ColorItem name="Warning" value="#f59e0b" />
  <ColorItem name="Error" value="#ef4444" />
</Color>

Tabellenvariante

Gruppieren Sie Farben in beschrifteten Zeilen, um organisierte Paletten zu erstellen:

Markenfarben
Primär#3b82f6
Sekundär#6366f1
Feedbackfarben
Erfolg#22c55e
Fehler#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, warningFeedbackfarben
Numerische Skalaprimary-500, gray-100Farbpaletten
Beschreibendbrand-blue, accent-goldMarkenfarben

Theme-abhängige Farben

Definieren Sie unterschiedliche Farben für den hellen und dunklen Modus, indem Sie ein Objekt mit den Eigenschaften light und dark übergeben:

Theme
Hintergrund
#ffffff
Theme
Vordergrund
#171717
Theme
Rahmen
#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 unterstützt standardmäßige CSS-Farbformate:

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

Layoutstil: compact (Raster) oder table (gruppierte Zeilen).

node

Elemente vom Typ ColorItem oder ColorRow.

ColorRow

string

Über der Zeile angezeigte Beschriftung.

node

Elemente vom Typ ColorItem.

ColorItem

string

Anzeigename der Farbe.

string | object

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

Wie geht es weiter?

Übersicht der Komponenten

Alle verfügbaren Komponenten durchsuchen

MDX-Grundlagen

Erfahren Sie, wie Sie Komponenten in MDX verwenden