⚡ vite-plugin-cesium

Easily set up a Cesium project in Vite.

update： if you just wanna a scaffolding by using this plugin, try a simply command yarn create cesium, click create-cesium for more info.

Chinese tutorial: 中文教程

Install

npm i cesium vite-plugin-cesium vite -D
# yarn add cesium vite-plugin-cesium vite -D

Usage

add this plugin to vite.config.js

import { defineConfig } from 'vite';
import cesium from 'vite-plugin-cesium';
export default defineConfig({
  plugins: [cesium()]
});

add dev command to package.json

"scripts": {
  "dev": "vite",
  "build": "vite build"
}

run:

yarn dev

Options

rebuildCesium

Type : boolean
Default : false

Default copy min cesium file to dist. if true will rebuild cesium from source.

import { defineConfig } from 'vite';
import cesium from 'vite-plugin-cesium';
export default defineConfig({
  plugins: [
    cesium({
      rebuildCesium: true
    })
  ]
});

Demo

src/index.js

import { Viewer } from 'cesium';
import './css/main.css';

const viewer = new Viewer('cesiumContainer');

or if you like global Cesium object you can write as

import * as Cesium from 'cesium';
const viewer = new Cesium.Viewer('cesiumContainer');

index.html

<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="UTF-8" />
    <meta http-equiv="X-UA-Compatible" content="IE=edge" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    <title>cesium-vite</title>
    <script type="module" src="/src/index.js"></script>
  </head>

  <body>
    <div id="cesiumContainer"></div>
  </body>
</html>

src/css/main.css

html,
body,
#cesiumContainer {
  width: 100%;
  height: 100%;
  margin: 0;
  padding: 0;
  overflow: hidden;
}

Add dev and build commands to package.json

"scripts": {
    "dev": "vite",
    "build": "vite build"
},

Run yarn dev

For full demo project please check ./demo folder.

License

MIT

nshen/vite-plugin-cesium

nshen

Reviews

Repository Details