TerrainX

Map

Sun, 29 Mar 2026 19:09:36 GMT

← Components | API Reference Root component. All other components must be children of this.

Marker

Sun, 29 Mar 2026 19:09:36 GMT

← Components Drops a pin at a coordinate. Optionally shows a Popup on click.

Polygon

Sun, 29 Mar 2026 19:09:36 GMT

← Components Draws a filled, outlined closed shape on the map. Good for zones, regions, and boundaries.

Popup

Sun, 29 Mar 2026 19:09:36 GMT

← Components A floating callout bubble anchored above a marker. Opens on click, closes on click outside.

Route

Sun, 29 Mar 2026 19:09:36 GMT

← Components Draws a line through an ordered list of coordinates on the map.

SearchBox

Sun, 29 Mar 2026 19:09:36 GMT

← Components Location search input. Uses Nominatim to find places, flies the map to the result.

data-flow

Sun, 29 Mar 2026 19:09:36 GMT

Data Flow ← Back How a Map Renders mounts ↓ MapLibre GL initializes with a Style Spec (JSON) ↓ GET tiles.openfreemap.org/planet ← TileJSON manifest ↓ MapLibre calculates visible tiles for current viewport ↓ GET .../planet/{z}/{x}/{y}.pbf ← Binary vector tile per tile square ↓ MapLibre ...

folder-structure

Sun, 29 Mar 2026 19:09:36 GMT

Folder Structure ← Back Full Layout TerrainX/ ├── docs/ ← Obsidian vault (you are here) ├── src/ │ ├── index.ts ← Public exports (components, hooks, types) │ ├── types.ts ← All TypeScript interfaces │ ├── context/ │ │ └── MapContext.ts ← React context holding the MapLibre instance │ ├── hooks/ │ │ └...

useMap

Sun, 29 Mar 2026 19:09:36 GMT

useMap() ← API Reference Hook for programmatic map control. Must be used inside a tree.

index

Sun, 29 Mar 2026 19:09:36 GMT

TerrainX A reusable React map component library. Drop it into any project, render beautiful maps, pin locations, draw routes.