inl-ui 0.1.1-rc.99 → 0.1.2

package/README.md

@@ -1,41 +1,49 @@
-# 工业 pc ui 库
+# 工业PC ui库
 
-## 编译 UI
+前端通用库，包括组件、hooks、utils等。
 
-> 编译 UI 需要在项目根目录运行 `yarn build:pc`, 如出现错误请查看源代码是否有问题以及主题文件是否存在， 打包完成后 会在 `packages/pc`, 下出现 dist 文件夹，所有打包后的文件均在该文件夹下。部署至 npm 需在 `packages/pc` 目录下运行 npm publish，注意版本号迭代.
+### 运行
 
-## 组件列表与划分
++ 开发模式 yarn dev
++ 生产打包 yarn build
++ 生成文档 yarn build:docs
++ 打包图扑工具 yarn buildtp
 
-### 页面组件
+### 使用方法
 
-#### 视频组件(video)
+```javascript
+import inl from 'inl-ui';
+import 'inl-ui/dist/style.css';
 
+vue.use(inl)
+```
 
-#### 基座组件(base)
 
-#### 报警组件(alarm)
 
-### 功能组件
+### 激活主题
 
-1. [修改主题的工具](./src/components/changeTheme/README.md)
-2. [视频播放组件](./src/components/videoPlayer/README.md)
-3. [顶部导航菜单组件](./src/components/headerMenu/README.md)
+**vite.config.ts**
 
-### [UI 工具类](./src/utils/README.md)
+```javascript
+const additionalData = require("inl-ui/dist/theme").default;
 
-## 规则
-> 开发规则,该主题依赖于 [ant-vue](https://www.antdv.com/components) 最新版本
+...
 
-### 查询表单
-> `table-query-form` 查询表单需要添加特殊类
-``` html
-<a-form class="ant-form ant-form-inline table-query-form">
-    <a-form-item
-      label="Username"
-      name="username"
-      :rules="[{ required: true, message: 'Please input your username!' }]"
-    >
-      <a-input v-model:value="formState.username" />
-    </a-form-item>
-</a-form>
+css: {
+  preprocessorOptions: {
+    less: {
+      javascriptEnabled: true,
+      additionalData,
+    },
+  },
+},
 ```
+
+### 文档链接
+
+##### [组件文档](./src/components/README.md)
+
+##### [hooks文档](./src/hooks/README.md)
+
+##### [Utils文档](./src/utils/README.md)
+