mxcad-app 1.0.5 → 1.0.6

package/README.md

@@ -23,6 +23,10 @@ yarn add mxcad-app
 
 ## 🚀 使用方法（3分钟搞定）
 
+## 核心依赖库
+
+
+
 ### 基于 vite
 
 main.js
@@ -115,10 +119,34 @@ import { setStaticAssetPath } from "mxcad-app";
 setStaticAssetPath("https://unpkg.com/mxcad-app/dist/mxcadAppAssets");
 ```
 
-### 使用 mxcad-app 中的外部资源库
+## 核心依赖库
+
+`mxcad-app`内置了[`mxcad`](https://www.mxdraw3d.com/mxcad_docs/zh/1.%E5%BC%80%E5%A7%8B/2.%E5%BF%AB%E9%80%9F%E5%85%A5%E9%97%A8.html) 核心库，你可以直接使用`mxcad` 不需要安装`mxcad`。
+
+
+```js
+import { MxCpp } from 'mxcad'
+```
+
+如果不是模块化的方式使用,`mxcad`在`window.MxCAD`挂载你可以直接使用`MxCAD`访问到需要的方法和类。
+
+`mxcad`依赖`mxdraw`, 你也可以使用`mxdraw`
+
+```js
+import * as Mx from 'mxdraw'
+```
+
+如果不是模块化的方式使用, `mxdraw` 在 `window.Mx` 挂载。你可以直接使用`Mx`访问到需要的方法和类。
+
+直接引入`mxcad`和`mxdraw`模块的前提是要使用构建工具构建。我们提供给了webpack和vite的插件, 用于支持模块化开发。
 
-只需要添加 添加依赖映射配置， 如:
+只要使用了插件就可以直接使用`import`引入`mxcad`和`mxdraw`模块。
 
+### 使用 mxcad-app 依赖映射
+
+你可以直接引入使用mxcad-app内部使用的mxcad和mxdraw模块。同时你也可以添加配置`libraryNames`使用其他的外部依赖的npm库。
+目前支持的依赖映射的库有`vue`, `axios`, `vuetify`, `vuetify/components`, `mapboxgl`, `pinia` 你也可以访问`window.MXCADAPP_EXTERNALLIBRARIES`获取到所有提供的依赖库，从而不依赖与构建工具的使用。
+比如`vue`框架,只需要添加依赖映射配置， 如:
 vite.config.js
 
 ```js
@@ -142,18 +170,13 @@ module.exports = {
   // 其他配置...
   plugins: [
     new MxCadAssetsWebpackPlugin({
-      libraryNames: ["vue"],
-      // 自定义UI配置
-      transformMxServerConfig: (config)=> {
-        config.title = "自定义标题"
-        return config
-      }
+      libraryNames: ["vue"]
     }),
   ],
 };
 ```
 
-正常使用mxcad-app中的vue模块
+就可以正常使用mxcad-app中的vue模块（mxcad-app打包的内部vue模块）
 ```js
 import { ref } from "vue";
 const n = ref(1)
@@ -179,7 +202,18 @@ export default {
       transformMxServerConfig: (config) => {
         config.serverUrl = "/api/cad"; // 修改API地址
         return config;
-      }
+      },
+      // 修改快捷命令(命令别名)
+      // transformMxQuickCommand: (config) => config
+
+      // 修改草图与注释UI模式的配置
+      // transformMxSketchesAndNotesUiConfig: (config) => config
+
+      // 修改UI配置
+      // transformMxUiConfig: (config) => config,
+
+      // 修改Vuetify主题配置
+      // transformVuetifyThemeConfig: (config) => config
     })
   ]
 };
@@ -203,16 +237,6 @@ module.exports = {
 };
 ```
 
-### 配置项说明
-- `transformMxcadUiConfig` - 修改主界面配置
-- `transformMxServerConfig` - 修改服务器配置
-- `transformVuetifyThemeConfig` - 修改主题配置
-- `transformMxQuickCommand` - 修改快捷命令
-- `transformMxSketchesAndNotesUiConfig` - 修改草图工具配置
-- `transformMxUiConfig` - 修改通用UI配置
-
-函数接收原始配置对象，返回修改后的配置对象（支持Promise）
-
 ## 📚 常见问题速查
 
 **Q: 支持哪些CAD格式？**