mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
skeptrune
9200586a3a
* docs: boost search ranking for single-word title pages Apply `boost: 3` to English pages whose H1 / frontmatter title is a single word (e.g. "Assistant", "Quickstart", "Cards"). Short titles tend to be canonical landing pages for a topic, so users searching the exact term should land on them first. * docs: drop boost on websocket-playground stub to keep canonical Playground ranking `api-playground/websocket-playground.mdx` is an auto-generated AsyncAPI stub with no body content but shares the title "Playground" with `api-playground/overview.mdx`. Boosting both equally diluted the canonical overview page in search for the query "playground". Drop the boost on the stub.
131 lines
4.1 KiB
Plaintext
131 lines
4.1 KiB
Plaintext
---
|
|
title: "Color"
|
|
description: "Display color swatches with hex values and click-to-copy capability using the color component for design system and branding documentation."
|
|
keywords: ["color", "palette", "colors", "design system", "hex", "rgb", "rgba", "hsl", "oklch"]
|
|
boost: 3
|
|
---
|
|
|
|
Use the Color component to showcase color palettes in your documentation. Display colors in a compact grid or organize them in a table with labeled rows.
|
|
|
|
## Compact variant
|
|
|
|
Display colors in a simple grid layout with color names and values.
|
|
|
|
<Color variant="compact">
|
|
<Color.Item name="blue-500" value="#3B82F6" />
|
|
<Color.Item name="blue-600" value="#2563EB" />
|
|
<Color.Item name="blue-700" value="#1D4ED8" />
|
|
<Color.Item name="blue-800" value="#1E40AF" />
|
|
</Color>
|
|
|
|
```mdx Compact example
|
|
<Color variant="compact">
|
|
<Color.Item name="blue-500" value="#3B82F6" />
|
|
<Color.Item name="blue-600" value="#2563EB" />
|
|
<Color.Item name="blue-700" value="#1D4ED8" />
|
|
<Color.Item name="blue-800" value="#1E40AF" />
|
|
</Color>
|
|
```
|
|
|
|
## Table variant
|
|
|
|
Organize colors into labeled rows for design system documentation.
|
|
|
|
<Color variant="table">
|
|
<Color.Row title="Primary">
|
|
<Color.Item name="primary-500" value="#3B82F6" />
|
|
<Color.Item name="primary-600" value="#2563EB" />
|
|
<Color.Item name="primary-700" value="#1D4ED8" />
|
|
</Color.Row>
|
|
<Color.Row title="Secondary">
|
|
<Color.Item name="secondary-500" value="#8B5CF6" />
|
|
<Color.Item name="secondary-600" value="#7C3AED" />
|
|
</Color.Row>
|
|
</Color>
|
|
|
|
```mdx Table example
|
|
<Color variant="table">
|
|
<Color.Row title="Primary">
|
|
<Color.Item name="primary-500" value="#3B82F6" />
|
|
<Color.Item name="primary-600" value="#2563EB" />
|
|
<Color.Item name="primary-700" value="#1D4ED8" />
|
|
</Color.Row>
|
|
<Color.Row title="Secondary">
|
|
<Color.Item name="secondary-500" value="#8B5CF6" />
|
|
<Color.Item name="secondary-600" value="#7C3AED" />
|
|
</Color.Row>
|
|
</Color>
|
|
```
|
|
|
|
## Color formats
|
|
|
|
The component supports all CSS color formats including hex, rgb, rgba, hsl, and oklch.
|
|
|
|
<Color variant="compact">
|
|
<Color.Item name="hex" value="#FF5733" />
|
|
<Color.Item name="rgb" value="rgb(51, 255, 87)" />
|
|
<Color.Item name="rgba" value="rgba(51, 87, 255, 0.7)" />
|
|
<Color.Item name="hsl" value="hsl(180, 70%, 55%)" />
|
|
<Color.Item name="oklch" value="oklch(70% 0.2 145)" />
|
|
</Color>
|
|
|
|
```mdx Color formats example
|
|
<Color variant="compact">
|
|
<Color.Item name="hex" value="#FF5733" />
|
|
<Color.Item name="rgb" value="rgb(51, 255, 87)" />
|
|
<Color.Item name="rgba" value="rgba(51, 87, 255, 0.7)" />
|
|
<Color.Item name="hsl" value="hsl(180, 70%, 55%)" />
|
|
<Color.Item name="oklch" value="oklch(70% 0.2 145)" />
|
|
</Color>
|
|
```
|
|
|
|
## Theme-aware colors
|
|
|
|
Define different colors for light and dark modes using an object with `light` and `dark` properties.
|
|
|
|
<Color variant="compact">
|
|
<Color.Item name="bg-primary" value={{ light: "#FFFFFF", dark: "#000000" }} />
|
|
<Color.Item name="bg-secondary" value={{ light: "#F9FAFB", dark: "#0A0A0A" }} />
|
|
<Color.Item name="text-primary" value={{ light: "#111827", dark: "#F9FAFB" }} />
|
|
</Color>
|
|
|
|
```mdx Theme-aware example
|
|
<Color variant="compact">
|
|
<Color.Item name="bg-primary" value={{ light: "#FFFFFF", dark: "#000000" }} />
|
|
<Color.Item name="bg-secondary" value={{ light: "#F9FAFB", dark: "#0A0A0A" }} />
|
|
<Color.Item name="text-primary" value={{ light: "#111827", dark: "#F9FAFB" }} />
|
|
</Color>
|
|
```
|
|
|
|
## Properties
|
|
|
|
### Color
|
|
|
|
<ResponseField name="variant" type="string" required>
|
|
Display style for the color palette. Options: `compact` or `table`.
|
|
</ResponseField>
|
|
|
|
<ResponseField name="children" type="Color.Item | Color.Row" required>
|
|
Color items or rows to display.
|
|
</ResponseField>
|
|
|
|
### Color.Row
|
|
|
|
<ResponseField name="title" type="string">
|
|
Label for the row of colors.
|
|
</ResponseField>
|
|
|
|
<ResponseField name="children" type="Color.Item" required>
|
|
Color items to display in the row.
|
|
</ResponseField>
|
|
|
|
### Color.Item
|
|
|
|
<ResponseField name="name" type="string">
|
|
Name or label for the color.
|
|
</ResponseField>
|
|
|
|
<ResponseField name="value" type="string | { light: string, dark: string }" required>
|
|
Color value in any CSS format, or an object with light and dark mode values.
|
|
</ResponseField>
|