Skip to main content

MapControls

Map Furniture

Branded zoom / compass / locate / fullscreen controls.

import { MapControls } 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 MapControls 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 MapControls up before writing code: `npx -y @elabs-ai/components-cli docs MapControls` 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

4 live examples

All Controls

Top Left

Static Map

A static editorial map (`interactive={false}`) shows no zoom chrome: the gestures those buttons invite are switched off, so the affordance would lie. The host can still ask for a group explicitly — the fullscreen toggle here works either way.

API

MapControls

PropTypeDescription
position"top-left" | "top-right" | "bottom-left" | "bottom-right"Position of the controls on the map (default: "bottom-right").
showZoombooleanShow zoom in/out buttons. Default: true on an interactive map, false on a static one (`<MapCanvas interactive={false}>`), whose whole point is a fixed view — set `showZoom` explicitly to override either way.
showCompassbooleanShow a compass button to reset bearing/pitch (default: false).
showLocatebooleanShow a locate button to fly to the user's location (default: false).
showFullscreenbooleanShow a fullscreen toggle button (default: false).
showFitbooleanShow a button that frames the whole plan again — a plan map has an edge to come back to, so this defaults to ON there and off on a geographic map.
fitBounds[[number, number], [number, number]]What the fit button frames. Defaults to the plan's own extent; pass bounds to frame something else (one wing, the selected cluster).
onFit() => voidCalled after the camera has been asked to frame the plan.
classNamestringAdditional CSS classes for the controls container.
onLocate(coords: { longitude: number; latitude: number }) => voidCallback with user coordinates when located.
onLocateError(error: GeolocationPositionError) => voidCallback when geolocation fails or is denied.