Jamdesk Documentation logo

Cor

Documentação do componente Color, que exibe amostras de cores hex, RGB e RGBA em grades compactas ou tabelas agrupadas, com valores opcionais por tema

Color exibe valores hex, RGB e RGBA como amostras de cor que podem ser copiadas com um clique. Ele tem duas variantes de layout: uma grade compacta e uma tabela agrupada. Cada amostra pode receber um valor separado para cada tema.

Use Color quando:

  • Documentar sistemas de design com cores de marca
  • Mostrar cores de tema que mudam conforme o tema
  • Exibir escalas de cor (primary-100 até primary-900)
  • Compartilhar diretrizes de marca com valores hex/RGB

Uso

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

Variante compacta

O layout padrão exibe as cores em uma grade responsiva:

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>

Variante de tabela

Agrupe as cores em linhas rotuladas:

Brand Colors
Primary#3b82f6
Secondary#6366f1
Feedback Colors
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>

Convenções de nomenclatura de cores

PadrãoExemploUso
Semânticosuccess, error, warningCores de feedback
Escala numéricaprimary-500, gray-100Paletas de cor
Descritivobrand-blue, accent-goldCores de marca

Cores adaptadas ao tema

Passe um objeto com as propriedades light e dark para definir uma cor por tema:

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>

Formatos de cor

O componente aceita valores hex, RGB e RGBA:

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>

Propriedades

Color

stringdefault: compact

Estilo de layout: compact (grade) ou table (linhas agrupadas).

node

Elementos ColorItem ou ColorRow.

ColorRow

string

Rótulo exibido acima da linha.

node

Elementos ColorItem.

ColorItem

string

Nome de exibição da cor.

string | object

Valor da cor como string CSS, ou { light: string, dark: string } para cores sensíveis ao tema.

O que vem a seguir?

Visão geral dos componentes

Veja todos os componentes disponíveis

Fundamentos de MDX

Aprenda a usar componentes em MDX