@bscjc/webui 0.0.20 → 1.0.1

package/README.md

@@ -1,2 +1,58 @@
 # @bscjc/webui
 一个 Vue3 组件库，使用 Vite，Element Plus 和 TypeScript 构建的组件库
+
+## 组件目录介绍
+
+@bscjc/webui 是一个基于 Element Plus 的 Vue3 组件库，包含以下组件：
+
+| 组件名             | 说明                                           |
+| ------------------ | ---------------------------------------------- |
+| JcListLayout       | 列表布局组件，支持自定义顶部和底部内容         |
+| JcSelectQuery      | 下拉选择器组件，支持多选、单选、搜索和全选功能 |
+| JcDatePicker       | 日期选择器组件，支持日期范围和月份范围选择     |
+| JcInputSwitch      | 输入切换组件，支持多字段切换输入               |
+| JcInputComplex     | 复杂输入切换组件，支持单行和多行文本输入       |
+| JcTagQuery         | 标签查询组件，用于展示和管理查询标签           |
+| JcMoreQueryContain | 查询容器，用于包裹更多查询条件                 |
+
+## 安装使用说明
+
+### 安装
+
+```shell
+npm i @bscjc/webui  
+// 或者
+pnpm add @bscjc/webui
+```
+
+### 完整导入
+
+```typescript
+// src/main.ts
+import { createApp } from "vue";
+import App from "./App.vue";
+import JcWebui from "@bscjc/webui";
+import "@bscjc/webui/dist/index.css";
+
+const app = createApp(App);
+app.use(JcWebui);
+app.mount("#app");
+```
+
+### 按需导入
+
+```vue
+<template>
+  <JcSelectQuery
+    ref="selectRef"
+    field="selectList"
+    :options="options"
+    @change="(val:any) => console.log(val)"
+  >
+  </JcSelectQuery>
+</template>
+
+<script setup>
+import { JcSelectQuery } from "@bscjc/webui";
+</script>
+```