---
title: "Introduction"
description: "Learn about Movk Mapbox's declarative design, context injection architecture, and dual Nuxt / Vue modes — from installation to composing maps, sources, layers, and controls."
canonical_url: "https://mapbox.mhaibaraai.cn/en/docs/getting-started"
---
# Introduction

> Learn about Movk Mapbox's declarative design, context injection architecture, and dual Nuxt / Vue modes — from installation to composing maps, sources, layers, and controls.

## Introduction

Movk Mapbox is a **declarative Mapbox GL JS v3 wrapper library**. It replaces imperative `map.addSource` / `map.addLayer` / marker and control management with a composable set of Vue components and composables: use `MapboxMap` to create a map, then declaratively compose map content with `MapboxSource`, `MapboxLayer`, `MapboxMarker`, `MapboxPopup`, and various controls — state is view. It also ships built-in 3D buildings, dynamic effects like radar / diffusion / glow, fog / terrain / weather environments, and localization capabilities including Tianditu, WMS / WMTS, and multi-CRS coordinate conversion.

It supports **two usage modes**:

- **Nuxt 4** — as a Nuxt module, with components and composables auto-imported out of the box.
- **Plain Vue + Vite** — via `@movk/mapbox/vite` + `@movk/mapbox/vue-plugin`, the same components and usage patterns work in non-Nuxt projects.

> [!NOTE]
> 
> Designed for 
> 
> progressive adoption
> 
> : you can use just the coordinate conversion utilities, or go all the way with layers, effects, drawing, and localized basemaps. Start with 
> 
> Installation
> 
> , then follow the 
> 
> Nuxt
> 
>  or 
> 
> Vue / Vite
> 
>  setup guide.

## Key Features

**Declarative Composition**

Compose maps, sources, layers, markers, popups, and controls as components — no more imperative add/remove boilerplate.

**MapboxContext Injection**

The root component provides context down the tree; child components access the instance, 

isLoaded

, and 

whenLoaded()

 via 

useMap()

 — no id lookups needed.

**Two-Way Camera Binding**

v-model:center

 / 

zoom

 / 

bearing

 / 

pitch

 sync the camera bidirectionally, with cross-route 

persistent

 support.

**Rich Layers & Effects**

Built-in layer types with clustering / buildings / raster / video, plus dynamic effects like radar, diffusion, glow, and migration, as well as fog / terrain / weather environments.

**Localization Extensions**

Tianditu basemaps, WMS / WMTS services, mapbox-gl-draw integration, and multi-CRS coordinate conversion via gcoord.

## Capability Overview

> [!NOTE]
> 
> **Documentation Structure**
> 
> - **Core Components** — Map, Source, Layer, LayerGroup, CustomLayer, Marker, LottieMarker, Popup, Tooltip
> - **Layer Components** — Built-in types (circle/fill/line/symbol/fill-extrusion/heatmap) and data-driven layers (cluster/building/image/video/raster)
> - **Controls** — Navigation / Geolocate / Fullscreen / Scale / Attribution
> - **Effect Components** — Radar, diffusion, glow, ripple, trail, migration, and building effects
> - **Environment & Weather** — Fog, Lights, Terrain, Temperature, Rain, Snow
> - **Extensions** — DrawControl, Tianditu, WMS/WMTS, and coordinate conversion
> - **Composables & Utilities** — useMap, useMapboxCamera, useMeasure, and coordinate / buffer / geometry tools


## Sitemap

See the full [sitemap](https://mapbox.mhaibaraai.cn/sitemap.md) for all pages.
