Vue component and composition-api library for Cesium.

vesium

<img src="https://github.com/vesiumjs/vesium/raw/main/assets/logo.svg" align="center" width="15%" />


<h1 align="center">
Vesium
</h1>

Vue Composition API and Vue Components for CesiumJS


<a href="https://github.com/vesiumjs/vesium/releases" target="__blank"><img src="https://img.shields.io/github/v/tag/vesiumjs/vesium" alt="Github tag"></a>
<a href="https://www.npmjs.com/package/vesium" target="__blank"><img src="https://img.shields.io/npm/v/vesium?color=a1b858&label=npm" alt="NPM Version"></a>
<a href="https://github.com/vesiumjs/vesium/blob/main/LICENSE" target="__blank"><img src="https://img.shields.io/github/license/vesiumjs/vesium" alt="Github tag"></a>
<a href="https://github.com/vesiumjs/vesium" target="__blank"><img alt="GitHub Stars" src="https://img.shields.io/github/stars/vesiumjs/vesium?style=social"></a>



<a href="https://github.com/vesiumjs/vesium/blob/main/README.zh.md" target="__blank">中文</a>
|
<a href="https://github.com/vesiumjs/vesium/blob/main/README.md" target="__blank">English</a>


> 🚧 This project is under active development, and the API may change frequently. Any version may introduce breaking changes.

## Documentation

To view the documentation, visit <a href="https://vesium.js.org" target="__blank">vesium.js.org</a>

## Features

- 🎯 **Intuitive** - VueUse-style API design familiar to Vue developers
- 💪 **Type Safe** - Written in TypeScript with full TS support
- 🏪 **Modular** - Tree-shakeable ESM modules
- 🌐 **Comprehensive** - Full coverage of common Cesium functionality
- 🎮 **Interactive** - Rich interactive capabilities with map elements
- ⚡️ **Lightweight** - No redundant dependencies

## Installation

```bash
# npm
npm i cesium @vueuse/core vesium

# yarn
yarn add cesium @vueuse/core vesium

# pnpm
pnpm add cesium @vueuse/core vesium
```

## Related Projects

- [Cesium](https://github.com/CesiumGS/cesium) - An open-source JavaScript library for world-class 3D globes and maps

- [VueUse](https://github.com/vueuse/vueuse) - Collection of essential Vue Composition API utilities

- [VitePress](https://github.com/vuejs/vitepress) - Vite & Vue-powered static site generator

## 📄 License

Vesium is released under the [MIT License](./LICENSE).