@zhangqingcq/vgce 0.0.32 → 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -4,11 +4,23 @@ Vector graphics configure editor. 矢量图组态编辑器。
4
4
 
5
5
  ## Guide
6
6
 
7
- 1. `npm i @zhangqingcq/vgce` or `pnpm add @zhangqingcq/vgce`
7
+ 1. install
8
+ ```
9
+ npm i @zhangqingcq/vgce element-plus@^2.3.8 ace-builds@^1.14.0 lodash-es^4.17.21 vue-echarts@^6.5.1 animate.css@^4.1.1
10
+ ```
11
+ or
12
+ ```
13
+ pnpm add @zhangqingcq/vgce element-plus@^2.3.8 ace-builds@^1.14.0 lodash-es^4.17.21 vue-echarts@^6.5.1 animate.css@^4.1.1
14
+ ```
8
15
 
9
- 2. `import '@zhangqingcq/vgce/dist/style.css'` in main.ts
16
+ 2. change main.ts or main.js
17
+ ```
18
+ //main.js or main.ts
19
+
20
+ import '@zhangqingcq/vgce/dist/style.css'
21
+ ```
10
22
 
11
- 3. editor
23
+ 3. use editor
12
24
  ```
13
25
  <script setup lang="ts">
14
26
  import {SvgEditor} from '@zhangqingcq/vgce'
@@ -21,7 +33,7 @@ Vector graphics configure editor. 矢量图组态编辑器。
21
33
  <SvgEditor @onPreview="preview"/>
22
34
  </template>
23
35
  ```
24
- 4. viewer
36
+ 4. use viewer
25
37
  ```
26
38
  <script setup lang="ts">
27
39
  import {SvgViewer} from '@zhangqingcq/vgce'
@@ -35,9 +47,9 @@ Vector graphics configure editor. 矢量图组态编辑器。
35
47
 
36
48
  - put svg files into `src/asset/svgs` , then file name need to be same with config.name
37
49
 
38
- - put custom parts file into `src/config/files`, then import in `src/config/index.ts` and export with `vueComp`
50
+ - put custom vue components file into `src/config/files`, then import in `src/config/index.ts` and export with `vueComp`
39
51
 
40
- - PS: you have to install `vite-plugin-svg-icons` plugin to append your svgs to html dom.
52
+ - PS: you have to install `vite-plugin-svg-icons` plugin to append your svg to html dom.
41
53
  ```
42
54
  <script setup lang="ts">
43
55
  import {SvgEditor} from '@zhangqingcq/vgce'