Skip to main content

MapLegend

Map Furniture

MapLegend — the map's key: marker rows (items) and / or a colour ramp (scale, built with colorScaleFor from @elabs-ai/components-ui, so its colours are token references in every theme).

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

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 MapLegend component (from @elabs-ai/components-maps) 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 MapLegend up before writing code: `npx -y @elabs-ai/components-cli docs MapLegend` prints its real props, variants, what it pairs with and what to avoid.
3. If @elabs-ai/components-maps is not installed yet: `pnpm add @elabs-ai/components-tokens @elabs-ai/components-ui @elabs-ai/components-maps` (or `npm install @elabs-ai/components-tokens @elabs-ai/components-ui @elabs-ai/components-maps`). 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

7 live examples

Grid Below

The same key as a grid, under the map — for keys wider than a corner.

Above

Above the map, as a list.

Stepped Ramp

A stepped ramp from the shared colour-scale helper: every swatch is a `var(--chart-seq-N)` reference, so the ramp follows the theme.

Continuous Ramp

A continuous ramp, drawn as a gradient of token references.

Corners

Every corner a key can sit in.

Responsive Position

Over a corner on wide maps; under the map at `narrow`, where it would cover data.

API

MapLegend

PropTypeDescription
titleReactNodeA heading for the key.
itemsreadonly MapLegendItem[]Marker key rows.
scaleMapLegendScaleA colour ramp (continuous / stepped) or category key, from `colorScaleFor`.
layoutMapLegendLayoutDefault `"list"`.
positionMapResponsive<MapLegendPosition>Where the key sits, optionally per tier — for example `{ base: "top-left", narrow: "below" }` so it stops covering a phone-width map. Default `"above"`.
formatValue(value: number) => stringFormats a ramp's tick values (default: the locale's number format).

Also accepts: Omit<HTMLAttributes<HTMLDivElement>, "title">