brand-ui — SurfaceTour

import { SurfaceTour } from "@elabs-ai/components-ui";

Install

npm install @elabs-ai/components-tokens @elabs-ai/components-ui

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

3 live examples

Sticky Tabs

The tab strip sticks at `--surface-tour-sticky-top` while the tour scrolls under it.

Affordance Hint Once

The corner hint appears after a beat, leaves on the first interaction and stays gone this session.

API

`SurfaceTour`

Prop	Type	Description
`tabs`required	`SurfaceTourTab[]`
`defaultTab`	`string`	The tab shown first. Default: the first tab.
`onTabChange`	`(id: string) => void`	Fires when the visitor picks another tab.
`title`	`ReactNode`	Section heading.
`description`	`ReactNode`	One sentence under the heading.
`hashKey`	`string`	When set, the active tab is read from and written to `#<hashKey>=<id>` (no history entries).
`frameClassName`	`string`	Classes for the frame — give it a height so every surface fills the same box.

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

`SurfaceTourActions`

Prop	Type	Description
`storybookHref`	`string`	Where "Open in Storybook" goes; it opens in a new tab. Omit to hide the link.
`prompt`	`string`	The (multi-line) prompt "Copy prompt" writes to the clipboard. Omit to hide the button.
`command`	`string`	The scaffold command shown in a copyable chip. Omit to hide the chip.
`labels`	`Partial<SurfaceTourActionsLabels>`	Override any rendered string.

Also accepts: HTMLAttributes<HTMLDivElement>