Skip to main content

MapMarker

Map and Layersdisplay

A point on the map, optionally carrying content, a label, a popup or a tooltip.

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

Avoid

  • Hardcoding a marker color — resolve a semantic token; WebGL can't read CSS variables directly.
  • Hundreds of individual markers — switch to MapClusterLayer above roughly 50 points.

Works with

Contains

  • MapMarkerContent
  • MapMarkerLabel
  • MapMarkerPopup
  • MapMarkerTooltip

Used inside

Examples

5 live examples

With Popup And Tooltip

Draggable

Label Positions

A marker's own label, at each of the eight positions around its point; the lower row adds a box (a plate that keeps the text readable over busy ground) and a callout line.

Label Only And Show At

A label with no marker glyph — text placed on the map (a lake or region name) — plus a marker that only shows from `medium` up.

API

MapMarker

PropTypeDescription
childrenReactNodeMarker sub-components (MapMarkerContent, MapMarkerPopup, MapMarkerTooltip, MapMarkerLabel). Optional when `label` alone marks the place — an inline area label, for example.
showAtMapResponsive<boolean>Whether the marker shows at a tier (default `true` everywhere): `{ base: true, narrow: false }` drops it from a phone-width map. The The editorial advice applies — duplicate a marker with a shorter label and the opposite `showAt` rather than cramming one label into both.
labelMapMarkerLabelSpecA text label drawn with the marker (see {@link MapMarkerLabelSpec}).
onClick(e: MouseEvent) => voidCallback when the marker is clicked.
onMouseEnter(e: MouseEvent) => voidCallback when the mouse enters the marker.
onMouseLeave(e: MouseEvent) => voidCallback when the mouse leaves the marker.
onDragStart(lngLat: { lng: number; lat: number }, plan: PlanPoint | null) => voidCallback when a drag starts (requires `draggable`). The plan point is `null` off a plan.
onDrag(lngLat: { lng: number; lat: number }, plan: PlanPoint | null) => voidCallback during a drag (requires `draggable`). The plan point is `null` off a plan.
onDragEnd(lngLat: { lng: number; lat: number }, plan: PlanPoint | null) => voidCallback when a drag ends (requires `draggable`). The plan point is `null` off a plan.
dragLabelstringThe accessible name of a `draggable` marker — say what it moves ("Depot location"). Defaults to the locale seam's generic name. Ignored when the marker is not draggable.

Also accepts: MapPosition, Omit<MarkerOptions, "element">

MapMarkerContent

PropTypeDescription
childrenReactNodeCustom marker content. Defaults to a primary-colored dot.
classNamestringAdditional CSS classes for the marker container.

MapMarkerLabel

PropTypeDescription
childrenrequiredReactNodeLabel text content.
classNamestringAdditional CSS classes for the label.
position"top" | "bottom"Position of the label relative to the marker (default: "top").

MapMarkerPopup

PropTypeDescription
childrenrequiredReactNodePopup content.
classNamestringAdditional CSS classes for the popup container.
closeButtonbooleanShow a close button in the popup (default: false).

Also accepts: Omit<PopupOptions, "className" | "closeButton">

MapMarkerTooltip

PropTypeDescription
childrenrequiredReactNodeTooltip content.
classNamestringAdditional CSS classes for the tooltip container.

Also accepts: Omit<PopupOptions, "className" | "closeButton" | "closeOnClick">

Theming

The tokens each state resolves to. Change the token and every theme follows.

StateToken
default--primary via the token resolver (WebGL can't read CSS variables)