Skip to main content

Legend

Canvas

Small legend mapping colors/types to labels for a canvas or chart (variant: "categorical", the default), or — via variant="scale" — a continuous width/color ramp with a domain, tick marks and formatting.

import { Legend } from "@elabs-ai/components-flow";
Install
npm install @elabs-ai/components-tokens @elabs-ai/components-ui @elabs-ai/components-flow

Skipping the @source line is the most common first failure: Tailwind does not scan node_modules, so every component renders unstyled. The one-time wiring

Prompt for your coding agent

Paste it into Claude Code, Cursor, Codex or any other coding agent. Text in [brackets] is yours to fill in.

Add the brand-ui Legend component (from @elabs-ai/components-flow) to this project.

1. Read https://elabs-ai.com/llms.txt first: it maps every package and the rules. If you can use MCP servers, connect https://elabs-ai.com/mcp and use its search, docs and tokens tools. If not, run the same lookups in the terminal: `npx -y @elabs-ai/components-cli search "<what you need>"` and `npx -y @elabs-ai/components-cli docs <Component>`.
2. Look Legend up before writing code: `npx -y @elabs-ai/components-cli docs Legend` prints its real props, variants, what it pairs with and what to avoid.
3. If @elabs-ai/components-flow is not installed yet: `pnpm add @elabs-ai/components-tokens @elabs-ai/components-ui @elabs-ai/components-flow` (or `npm install @elabs-ai/components-tokens @elabs-ai/components-ui @elabs-ai/components-flow`). If this is the first brand-ui package in the project, wire it once: import `@elabs-ai/components-tokens/styles.css` plus the `themes/light.css` and `themes/dark.css` stylesheets in the CSS entry, add one Tailwind `@source` line per installed @elabs-ai package (Tailwind does not scan node_modules, so without it everything renders unstyled), and wrap the app root in `ThemeProvider` from `@elabs-ai/components-tokens`.
4. Use it here: [the screen or file, and what it should show]
5. Rules: use only @elabs-ai/components-* components and the semantic tokens — no raw colours, no raw font sizes, no arbitrary Tailwind values. Look up each component's real props with the docs tool before you use it; never guess a prop.
6. Done means: the typecheck passes, `npx -y @elabs-ai/components-cli audit src --strict` reports nothing, and you have opened the app and looked at every screen you touched in the light and the dark theme.

Examples

10 live examples

No Title

Legend without a title — items only.

Full Pipeline

Richer set of items representing a full pipeline.

Single Item

Single item.

Scale Width

Width ramp, default `ticks="minmax"` — min/max sample strokes drawn at the exact widths `computeEdgeWeightScale` (RM-043) would assign those weights, so the legend can never drift from a real flow's weighted edges.

Scale Width Min Med Max

`ticks="minmedmax"` adds the domain midpoint as a third sample stroke.

Scale Color

Colour ramp — always a fixed 5-stop gradient built from `--flow-edge-weak`/`--flow-edge-strong`, labelled at every stop via `format`. Colour alone never carries the ordering (WCAG 1.4.1); the five numbered ticks are the required second channel.

Scale Width Zero Domain

Zero-width domain (`min === max`) — every sample collapses onto one value. Must render without crashing and without a duplicate React key warning.

Scale Color Wide Range

Domain spanning several orders of magnitude.

Scale Width Long Labels

A verbose custom `format` must truncate rather than break the layout.