@lemon30_npm/csit-vue3 0.0.0 → 0.0.5

package/README.md

@@ -0,0 +1,83 @@
+# 🧩 csit-vue3 组件库
+
+> 一个基于 **Vue 3** + **Element Plus** 封装的业务组件库，提供统一的 UI 规范和业务逻辑组件，提升开发效率。
+
+---
+
+## 📦 安装方式
+
+```bash
+# 推荐使用 pnpm
+pnpm add @lemon30/csit-vue3
+
+# 或者使用 npm/yarn
+npm install @lemon30/csit-vue3
+# 或
+yarn add @lemon30/csit-vue3
+```
+
+#### ⚠️ 注意：该组件库依赖以下环境，请确保你的项目已安装(如果使用vue3项目脚手架，请忽略)：
+
+> 版本可自行升级，无影响
+
+- "vue": "^3.5.12"
+- "echarts": "^5.5.1"
+- "echarts-map": "^3.0.1"
+- "element-plus": "^2.9.7"
+- "@element-plus/icons-vue": "^2.3.1"
+- "axios": "^1.7.7"
+- "nanoid": "^5.0.8"
+
+---
+
+## 🚀 快速开始
+
+在你的项目入口文件中：
+
+```ts
+import { createApp } from "vue";
+import App from "./App.vue";
+
+// 引入组件库
+import CsitVue3 from "@lemon30_npm/csit-vue3";
+// 引入 csit-vue3 样式
+import "@lemon30_npm/csit-vue3/dist/index.css";
+
+const app = createApp(App);
+
+app.use(CsitVue3);
+
+app.mount("#app");
+```
+
+## 🧩 示例组件使用
+
+```html
+<template>
+  <CiUpload
+    class="demo-page-ci-upload"
+    v-model:file-list="fileList"
+    :accept="'.jpg,.png,.jpeg,.xls,.xlsx,.doc,.docx,.pdf,.zip'"
+    :limit="10"
+    :max-size="10 * 1024 * 1024"
+    :multiple="true"
+  >
+  </CiUpload>
+</template>
+
+<script lang="ts" setup>
+import { ref } from 'vue'
+
+const fileList = ref<any[]>([
+  {
+    fileSize: 1024 * 1024 * 1.3,
+    fileKey: 'key-0',
+    fileName: 'element-plus-logo-0.svg',
+  },
+  {
+    fileSize: 1024 * 1024 * 1.3,
+    fileKey: 'key-0',
+    fileName: 'element-plus-logo-0.svg',
+  },
+])
+```