vue-cesium/README.md

Vue 3.x components for CesiumJS.

<!--
 * @Author: zouyaoji@https://github.com/zouyaoji
 * @Date: 2021-09-03 16:57:27
 * @LastEditTime: 2023-12-13 10:33:36
 * @LastEditors: ly
 * @Description:
 * @FilePath: \vue-cesium\README.md
-->
<p align="center">
  <img width="256px" src="https://zouyaoji.top/vue-cesium/images/vue-cesium-logo.svg">
</p>

<p align="center">
  <a href="https://github.com/zouyaoji/vue-cesium/actions/workflows/publish-npm.yml" target="_blank">
    <img src="https://img.shields.io/github/actions/workflow/status/zouyaoji/vue-cesium/publish-npm.yml?style=plastic">
  </a>
  <a href="https://www.npmjs.com/package/vue-cesium" target="_blank">
    <img src="https://img.shields.io/npm/v/vue-cesium?style=plastic">
  </a>
  <a href="https://npmcharts.com/compare/vue-cesium?minimal=true" target="_blank">
    <img src="https://img.shields.io/npm/dm/vue-cesium?style=plastic">
  </a>
  <a href="https://github.com/zouyaoji/vue-cesium/blob/dev/LICENSE" target="_blank">
    <img src="https://img.shields.io/github/license/zouyaoji/vue-cesium?style=plastic">
  </a>
  <a href="https://github.com/zouyaoji/vue-cesium/stargazers" target="_blank">
    <img src="https://img.shields.io/github/stars/zouyaoji/vue-cesium?style=plastic" />
  </a>
  <br>
</p>

<p align="center">Vue for Cesium - A Vue 3.x based component library of CesiumJS for developers.</p>

- 💪 Vue 3.0 Composition API
- 🔥 Written in TypeScript

<p align="center">
  <img width="600px" src="https://zouyaoji.top/vue-cesium/images/certified-dev-banner-light-sm_01.png">
</p>

## Highlight Moments | [简体中文](./README.zh.md)

- 🌎 2022-06-08 The moon project developed with vue-cesium was featured in the [CCTV News Broadcast](https://tv.cctv.com/2022/06/08/VIDEazqfs4AIBuVEvBzob6DA220608.shtml?spm=C31267.PXDaChrrDGdt.EbD5Beq0unIQ.29) on June 8, 2022, at 21 minutes and 52 seconds. [Screenshot](https://zouyaoji.top/vue-cesium/images/cctv.png).
- 🚀 2022-12-10 Joined the [Cesium Certified Developer Program](https://cesium.com/learn/certified-developer-directory/).
- 🎉 2023-04-25 The GitHub project `vue-cesium` has reached over 1000 [stars](https://github.com/zouyaoji/vue-cesium/stargazers)! Thank you all for your support and contributions.

## Getting Started

You can find for more details, API, and other docs on [https://zouyaoji.top/vue-cesium/#/](https://zouyaoji.top/vue-cesium/#/)

- 中国大陆[加速镜像站点](https://vue-cesium.songluck.com)

Vue for Cesium supports loading the official CesiumJS, or other third-party platforms based on CesiumJS. The tested third-party libraries:

- [CesiumJS](https://cesium.com/platform/cesiumjs/)
- [SuperMap iClient3D for WebGL](http://support.supermap.com.cn:8090/webgl/web/index.html)
- [Earth SDK](http://www.earthsdk.com/)
- [Mars3D](http://mars3d.cn/)
- [DC-SDK](http://dc.dvgis.cn/#/index)

For other untested platforms, Vue for Cesium can also be used, and a callback method can be passed in through the viewerCreator of the vc-viewer component. The initialization process of the viewer is handled by the user, and the viewer can be returned after initialization. [See details](https://github.com/zouyaoji/vue-cesium/blob/dev/packages/components/viewer/src/useViewer.ts#L725)

## Bootstrap project

With command

```bash
$ pnpm i
```

the project will install all dependencies.

## Document preview

With command

```bash
$ pnpm gen:version
$ pnpm website-dev
```

the project will launch website for you to preview all existing component

## License

Vue for Cesium is open source software licensed as
[MIT](https://github.com/zouyaoji/vue-cesium/blob/master/LICENSE).

Copyright (c) 2018-present, zouyaoji 370681295@qq.com

## Sponsors

`vue-cesium` adopts the MIT open-source license, promising that the framework itself and official documentation will be permanently open and free. However, the daily updates and community operation of the framework require a significant amount of effort. If `vue-cesium` has been helpful to you, you can kindly show your support for `vue-cesium`.

- <a href="https://www.paypal.me/zouyaoji" target="_blank"><img src="https://zouyaoji.top/vue-cesium/images/paypal.png" style="height:25px;" /></a>

- WeChat / AliPay
  <div style="display: flex">
    <img alt="wechat" title="wechat" src="https://zouyaoji.top/vue-cesium/images/wechat.png">
    <img alt="alipay" title="alipay" src="https://zouyaoji.top/vue-cesium/images/alipay.png">
  </div>

- [donation list](https://zouyaoji.top/vue-cesium/#/en-US/donations)

## Contributors

This project wouldn't exist without our amazing contributors

<a href="https://github.com/zouyaoji/vue-cesium/graphs/contributors">
  <img src="https://contrib.rocks/image?repo=zouyaoji/vue-cesium" />
</a>

## References

VueJS UI libraries: [quasar](https://github.com/quasarframework/quasar) and [element-plus](https://github.com/element-plus/element-plus).