coder-xiaomo/vite-plugin-cesium-next
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity GitHub Gitee

--amend

Browse Source
This commit is contained in:
nshen
2021-04-02 09:17:27 +08:00
parent 351a173a72
commit b86ad3e8b1
1 changed files with 31 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files

59
README.md
View File

@@ -1,20 +1,20 @@
# ⚡ vite-plugin-cesium # ⚡ vite-plugin-cesium
[![npm](https://img.shields.io/npm/v/vite-plugin-cesium.svg)](https://www.npmjs.com/package/vite-plugin-cesium) [![npm](https://img.shields.io/npm/v/vite-plugin-cesium.svg)](https://www.npmjs.com/package/vite-plugin-cesium)
Easily set up a [`Cesium`] project in [`Vite`]. Easily set up a [`Cesium`] project in [`Vite`].
[`Cesium`]: https://github.com/CesiumGS/cesium [`cesium`]: https://github.com/CesiumGS/cesium
[`Vite`]: https://github.com/vitejs/vite [`vite`]: https://github.com/vitejs/vite
**update：** if you just wanna a scaffolding by using this plugin, try [create-cesium](https://www.npmjs.com/package/create-cesium), it's simply a command `yarn create cesium`. **update：** if you just wanna a scaffolding by using this plugin, try a simply command `yarn create cesium`, click [create-cesium](https://www.npmjs.com/package/create-cesium) for more info.
Chinese tutorial: [中文教程](https://segmentfault.com/a/1190000039344137) Chinese tutorial: [中文教程](https://segmentfault.com/a/1190000039344137)
## Install ## Install
```bash ```bash
npm i cesium vite-plugin-cesium vite -D npm i cesium vite-plugin-cesium vite -D
# yarn add cesium vite-plugin-cesium vite -D # yarn add cesium vite-plugin-cesium vite -D
``` ```
@@ -26,7 +26,7 @@ add this plugin to `vite.config.js`
import { defineConfig } from 'vite'; import { defineConfig } from 'vite';
import cesium from 'vite-plugin-cesium'; import cesium from 'vite-plugin-cesium';
export default defineConfig({ export default defineConfig({
plugins: [cesium()], plugins: [cesium()]
}); });
``` ```
@@ -38,6 +38,7 @@ add dev command to `package.json`
"build": "vite build" "build": "vite build"
} }
``` ```
run: run:
`yarn dev` `yarn dev`
@@ -49,26 +50,27 @@ run:
- **Type :** `boolean` - **Type :** `boolean`
- **Default :** `false` - **Default :** `false`
Default copy min cesium file to dist. if `true` will rebuild cesium from source. Default copy min cesium file to dist. if `true` will rebuild cesium from source.
```js ```js
import { defineConfig } from 'vite'; import { defineConfig } from 'vite';
import cesium from 'vite-plugin-cesium'; import cesium from 'vite-plugin-cesium';
export default defineConfig({ export default defineConfig({
plugins: [cesium({ plugins: [
rebuildCesium: true cesium({
})], rebuildCesium: true
})
]
}); });
``` ```
## Demo ## Demo
`src/index.js` `src/index.js`
```js ```js
import { Viewer } from 'cesium'; import { Viewer } from 'cesium';
import "./css/main.css"; import './css/main.css';
const viewer = new Viewer('cesiumContainer'); const viewer = new Viewer('cesiumContainer');
``` ```
@@ -78,31 +80,31 @@ const viewer = new Viewer('cesiumContainer');
```html ```html
<!DOCTYPE html> <!DOCTYPE html>
<html lang="en"> <html lang="en">
<head>
<head> <meta charset="UTF-8" />
<meta charset="UTF-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta http-equiv="X-UA-Compatible" content="IE=edge"> <meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>cesium-vite</title> <title>cesium-vite</title>
<script type="module" src="/src/index.js"></script> <script type="module" src="/src/index.js"></script>
</head> </head>
<body> <body>
<div id="cesiumContainer"></div> <div id="cesiumContainer"></div>
</body> </body>
</html> </html>
``` ```
`src/css/main.css` `src/css/main.css`
```css ```css
html, body, #cesiumContainer { html,
width: 100%; body,
height: 100%; #cesiumContainer {
margin: 0; width: 100%;
padding: 0; height: 100%;
overflow: hidden; margin: 0;
padding: 0;
overflow: hidden;
} }
``` ```
@@ -114,7 +116,8 @@ Add `dev` and `build` commands to `package.json`
"build": "vite build" "build": "vite build"
}, },
``` ```
Run `yarn dev`
Run `yarn dev`
For full demo project please check [./demo](https://github.com/nshen/vite-plugin-cesium/tree/main/demo) folder. For full demo project please check [./demo](https://github.com/nshen/vite-plugin-cesium/tree/main/demo) folder.