fangguo-component 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 lhlyu
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,128 @@
+# Fangguo-Component
+
+基于 Vue 3 与 Element Plus 的增强组件库，并集成工具函数、自定义指令与组合式函数（Hooks）。
+
+## 特性
+
+- **Vue 3 + Element Plus**：组件与 Element Plus 同栈；`vue`、`element-plus` 等在本包 `peerDependencies` 中声明，由业务工程显式安装，构建时作 external，减小包体。
+- **双形态交付**：`export *` 暴露组件、工具、指令与组合式函数（Hooks）；`default` 上提供 `install(app, options?)` 用于按需全局注册组件/指令，并将工具与 Hooks 命名空间展开在 `default` 上（与 `src/index.ts` 一致）；仅注册组件或仅注册指令时可使用命名导出的 `installComponents` / `installDirectives`。Hooks 始终建议按需命名导出使用，**无需**为 Hooks 单独 `app.use`。构建为多入口 ES 模块，可按需 `import` 子路径（见 `package.json` 的 `exports` 与 `vite` 多入口配置）。
+- **类型与构建**：`vite-plugin-dts` 生成 `dist` 下 `.d.ts`；`vite-plugin-lib-inject-css` 将组件样式注入对应 chunk，配合 `sideEffects` 声明，便于打包器做 Tree Shaking。
+- **文档与开发体验**：内置 VitePress 文档站；`pnpm docs:gen` 同步侧栏并生成组件、工具、指令与 Hooks 文档入口；工具模块在无手写 md 时可从源码与 JSDoc 自动生成 API 说明（组件、指令与 Hooks 正文在源码目录维护 Markdown）。
+
+## 项目结构
+
+```
+项目根目录/
+├── src/
+│   ├── index.ts                 # 库入口，聚合导出
+│   ├── components/              # 组件：每个子目录为一个组件
+│   │   └── <单个组件目录>/
+│   │       ├── index.ts         # 对外导出
+│   │       ├── *.vue            # 单文件组件
+│   │       ├── *.ts             # 类型、逻辑等（按需）
+│   │       └── *.md             # 组件文档（可借助 AI/手写 生成；脚本不会从源码自动生成，最后由 docs:gen 挂到站点）
+│   ├── tools/                   # 工具函数：每个子目录为一个工具包
+│   │   ├── index.ts             # 聚合各工具包导出
+│   │   └── <单个工具目录>/
+│   │       ├── index.ts         # 该包对外 export（可再 export 同目录下其它 .ts）
+│   │       ├── *.ts             # 实现文件
+│   │       └── *.md             # 可选：手写文档（见下文「文档生成」）
+│   ├── directive/               # 自定义指令：每个子目录一条指令包
+│   │   ├── index.ts             # 聚合导出
+│   │   └── <指令子目录>/
+│   │       ├── *.ts             # 指令实现
+│   │       └── *.md             # 可选：指令文档（由 docs:gen 挂到站点）
+│   ├── hooks/                   # 组合式函数：每个子目录一个 Hook 包
+│   │   ├── index.ts             # 聚合导出
+│   │   └── <hook 子目录>/
+│   │       ├── *.ts             # 实现与 re-export
+│   │       └── *.md             # 可选：Hook 文档（由 docs:gen 挂到站点）
+│   ├── dev/                     # 本地环境 组件或者工具函数调试mock
+│   └── …
+├── docs/                        # VitePress 文档站
+│   ├── .vitepress/              # 主题、config.ts、开发期缓存等
+│   │   └── dist/                # 文档静态站：`pnpm docs:build` 输出至此；`pnpm docs:preview` 本地预览；可整目录上传到静态托管。
+│   ├── guide/                   # 指南（安装、快速开始等）
+│   ├── index.md                 # 文档首页
+│   ├── components/              # 由脚本生成的组件文档入口（勿手改内容逻辑）
+│   ├── tools/                   # 由脚本生成的工具文档入口（勿手改内容逻辑）
+│   ├── directives/              # 由脚本生成的指令文档入口（勿手改内容逻辑）
+│   └── hooks/                   # 由脚本生成的 Hooks 文档入口（勿手改内容逻辑）
+├── scripts/
+│   └── gen-docs.ts              # 同步组件/工具/指令/Hooks 文档与侧边栏
+└── dist/                        # npm 包构建产物：pnpm build:npm 生成，用于发布到 npm（与 docs/.vitepress/dist 不同）
+```
+
+说明：`docs/components`、`docs/tools`、`docs/directives`、`docs/hooks` 下的 `.md` 多为脚本生成的薄入口文件；正文一般写在 `src/components/<单个组件目录>/`、`src/tools/<单个工具目录>/`、`src/directive/<指令子目录>/`、`src/hooks/<子目录>/` 下的 Markdown 中，通过 `@include` 引入。
+
+## 文档站（VitePress）与相关命令
+
+文档根目录为 `docs/`，配置在 `docs/.vitepress/config.ts`。
+
+| 命令                | 说明                                                                             |
+| ------------------- | -------------------------------------------------------------------------------- |
+| `pnpm docs:dev`     | 本地启动 VitePress，热更新预览文档                                               |
+| `pnpm docs:build`   | 构建静态站点，输出到 `docs/.vitepress/dist`（默认）                              |
+| `pnpm docs:preview` | 预览已构建的文档站                                                               |
+| `pnpm docs:gen`     | 根据 `src/components`、`src/tools`、`src/directive`、`src/hooks` 扫描结果生成/更新文档入口与侧边栏（见下一节） |
+
+典型流程：改完组件、工具、指令、Hooks 源码或手写 md 后执行 `pnpm docs:gen`，再 `pnpm docs:dev` 查看效果；发布文档前执行 `pnpm docs:build`。
+
+## 文档生成说明（`pnpm docs:gen`）
+
+脚本入口：`scripts/gen-docs.ts`。会更新 `docs/.vitepress/config.ts` 中的导航与侧边栏，并在 `docs/components/`、`docs/tools/`、`docs/directives/`、`docs/hooks/` 下写入或更新入口 Markdown。
+
+### 组件文档
+
+- 扫描 `src/components/` 下**一级子目录**（排除内部约定的目录名，以脚本中 `EXCLUDE` 为准）。
+- **组件正文 Markdown 不会由脚本从 `.vue`/`.ts` 自动生成**，需在组件目录下维护 `.md`（可手写或借助 AI 生成），再由 `docs:gen` 生成 `docs/components` 中的 `@include` 入口。
+- 在每个组件目录内按优先级查找文档文件：`README.md` → `index.md` → `<组件目录名>.md` → 否则取该目录下任意一个 `.md`（按文件名排序取第一个）。
+- 在 `docs/components/<组件名>.md` 中生成一行 VitePress 引入，例如：`<!--@include: ../../src/components/<组件名>/<上述选中的 md 文件名>-->`。
+- 同步生成 **`docs/components/index.md`** 作为 **`/components/`** 聚合说明页；导航栏「组件」与此页对齐，**不写死**某个具体组件路由；侧栏在存在组件时增加「概览」指向该页。
+- 正文请在**源码目录**下的对应 `.md` 中维护；`docs/components` 内上述文件由脚本覆盖，不要当作唯一正文仓库。
+
+### 工具文档
+
+- 扫描 `src/tools/` 下含 `index.ts` 的一级子目录（排除脚本中 `TOOLS_EXCLUDE_DIRS`）。
+- **若该工具目录内存在**可被上述同样规则选中的 `.md`（`README.md` / `index.md` / `<工具包名>.md` / 其它 `.md`）：在 `docs/tools/<工具包名>.md` 中生成 `@include`，指向 `src/tools/<工具包名>/` 下选中的那个文件。
+- **若不存在**任何符合条件的 `.md`：脚本会根据 `index.ts` 中的 `export … from './…'` 收集对外暴露的 `.ts` 源码，自动解析 JSDoc / 类型并生成整页 API 式文档（无手写 md 时走此分支）。
+- 每次 `docs:gen` 会写入 **`docs/tools/index.md`** 作为 **`/tools/`** 聚合说明页；导航栏「工具」与此页对齐（**不写死**某个工具包 slug）；侧栏在存在工具包时含「概览」指向该页；清理 `docs/tools` 下已移除工具对应的旧 `.md` 时**不会**删除 `index.md`。
+
+工具侧栏标题会尽量使用手写 md 的一级标题 `# …`；若无则回退到源码中的 `@file`、`@Description` 等注释。
+
+### 指令文档
+
+- 扫描 `src/directive/` 下一级子目录（排除脚本中 `DIRECTIVE_EXCLUDE_DIRS`，默认含 `_template`）。
+- 与组件相同，在子目录内按 `README.md` → `index.md` → `<子目录名>.md` → 其它 `.md` 优先级查找正文；在 `docs/directives/<子目录名>.md` 中生成 `@include`，指向 `src/directive/<子目录名>/` 下选中的文件。
+- 同步生成 **`docs/directives/index.md`** 作为 **`/directives/`** 聚合页；导航栏「指令」与此页对齐；侧栏含「概览」及各指令条目。若无任何带 md 的子目录，则不会生成指令相关导航与侧栏（仍会生成占位 `index.md` 于 `docs/directives`，便于路由稳定）。
+- 指令正文撰写规范（钩子、`binding`、示例结构）见 **`src/directive/DIRECTIVE_DOC_SKILL.md`**，可用 `@src/directive/DIRECTIVE_DOC_SKILL.md` 让 AI 按规范生成。
+
+### Hooks（组合式函数）文档
+
+- 扫描 `src/hooks/` 下一级子目录（排除脚本中 `HOOK_EXCLUDE_DIRS`，默认含 `_template`）。
+- 与指令相同，在子目录内按 `README.md` → `index.md` → `<子目录名>.md` → 其它 `.md` 优先级查找正文；在 `docs/hooks/<子目录名>.md` 中生成 `@include`，指向 `src/hooks/<子目录名>/` 下选中的文件。
+- 同步生成 **`docs/hooks/index.md`** 作为 **`/hooks/`** 聚合页；导航栏「Hooks」与此页对齐；侧栏含「概览」及各 Hook 条目。若无任何带 md 的子目录，则不会生成 Hooks 相关导航与侧栏（仍会写入占位 `index.md`）。
+- Hooks **不需要**全局安装：业务项目按需 `import { useXxx } from 'fangguo-component'` 即可（与 `src/index.ts` 命名导出一致）。
+- Hook 正文撰写规范见 **`src/hooks/HOOK_DOC_SKILL.md`**，可用 `@src/hooks/HOOK_DOC_SKILL.md` 让 AI 按规范生成。
+
+面向在本仓库内开发、构建与维护文档的说明。业务项目如何安装、引入本包，请见文档站内的 [安装](docs/guide/installation.md) 与 [快速开始](docs/guide/quickstart.md)。
+
+```bash
+pnpm install          # 安装本仓库依赖
+pnpm dev              # 启动本地 Playground（组件 / 工具调试）
+pnpm build:npm        # 构建 npm 发布产物，输出到仓库根目录 dist/
+pnpm lint             # 代码检查（oxlint）
+pnpm lint:fix         # 自动修复可修复项
+pnpm fmt              # 格式化（oxfmt）
+```
+
+开发与类型检查建议环境：
+
+- Vue 版本以本仓库 `package.json` 中 **`peerDependencies`** 为准（当前为 `^3.5.3`）
+- Element Plus、`@element-plus/icons-vue`、`sass`、`vue-virtual-scroller` 等同上，以 **`peerDependencies`** 为准；随包安装的 **`dependencies`** 仅 `crypto-js`、`lodash-unified`
+
+文档相关命令见上文「文档站（VitePress）与相关命令」。
+
+## 许可证
+
+[ISC](./LICENSE)

package/dist/MInput-CO6YUVuZ.js

@@ -0,0 +1,101 @@
+import { defineComponent as w, ref as r, useModel as E, openBlock as m, createElementBlock as p, createVNode as d, unref as s, mergeProps as C, createSlots as B, withCtx as o, createElementVNode as v, renderSlot as D, toDisplayString as f, createCommentVNode as I, withKeys as N, withModifiers as $, createTextVNode as c, mergeModels as V } from "vue";
+import { ElInput as y, ElDialog as h, ElButton as x } from "element-plus";
+import { _ as S } from "./_plugin-vue_export-helper-CHgC5LLL.js";
+import './MInput.css';const T = { class: "custom-input" }, U = {
+  key: 0,
+  class: "pb-[12px] text-fill-900",
+  style: { "font-family": "MicrosoftYaHei, sans-serif" }
+}, K = /* @__PURE__ */ w({
+  __name: "MInput",
+  props: /* @__PURE__ */ V({
+    tip: {},
+    label: {},
+    placeholder: {},
+    saveBtnText: {}
+  }, {
+    modelValue: { default: "" },
+    modelModifiers: {}
+  }),
+  emits: /* @__PURE__ */ V(["saveEvent"], ["update:modelValue"]),
+  setup(l, { emit: g }) {
+    const k = g, a = r(!1), i = E(l, "modelValue"), n = r(""), M = () => {
+      n.value = i.value, a.value = !0;
+    }, b = () => {
+      i.value = n.value, a.value = !1, k("saveEvent", n.value);
+    };
+    return (u, e) => (m(), p("div", T, [
+      d(s(y), C({
+        class: "input",
+        modelValue: i.value,
+        "onUpdate:modelValue": e[0] || (e[0] = (t) => i.value = t)
+      }, u.$attrs, {
+        placeholder: l.placeholder,
+        clearable: ""
+      }), B({
+        append: o(() => [
+          v("span", { onClick: M }, "•••")
+        ]),
+        _: 2
+      }, [
+        u.$slots.prepend ? {
+          name: "prepend",
+          fn: o(() => [
+            D(u.$slots, "prepend", {}, void 0, !0)
+          ]),
+          key: "0"
+        } : void 0
+      ]), 1040, ["modelValue", "placeholder"]),
+      d(s(h), {
+        class: "order-dialog",
+        modelValue: a.value,
+        "onUpdate:modelValue": e[4] || (e[4] = (t) => a.value = t),
+        width: "480px",
+        title: l.label,
+        "align-center": "",
+        draggable: "",
+        "close-on-click-modal": !1
+      }, {
+        footer: o(() => [
+          v("div", null, [
+            d(s(x), {
+              type: "info",
+              plain: "",
+              onClick: e[3] || (e[3] = (t) => a.value = !1)
+            }, {
+              default: o(() => [...e[5] || (e[5] = [
+                c("取消", -1)
+              ])]),
+              _: 1
+            }),
+            d(s(x), {
+              class: "!ml-[14px]",
+              type: "primary",
+              onClick: b
+            }, {
+              default: o(() => [
+                c(f(l.saveBtnText || "确认"), 1)
+              ]),
+              _: 1
+            })
+          ])
+        ]),
+        default: o(() => [
+          l.tip ? (m(), p("div", U, f(l.tip), 1)) : I("", !0),
+          d(s(y), {
+            modelValue: n.value,
+            "onUpdate:modelValue": e[1] || (e[1] = (t) => n.value = t),
+            type: "textarea",
+            autosize: { minRows: 3, maxRows: 5 },
+            placeholder: l.placeholder,
+            onKeyup: e[2] || (e[2] = N($(() => {
+            }, ["stop"]), ["enter"]))
+          }, null, 8, ["modelValue", "placeholder"])
+        ]),
+        _: 1
+      }, 8, ["modelValue", "title"])
+    ]));
+  }
+}), P = /* @__PURE__ */ S(K, [["__scopeId", "data-v-9b456dcb"]]);
+export {
+  P as M
+};

package/dist/MInput.css

@@ -0,0 +1 @@
+.custom-input[data-v-9b456dcb]{@apply w-full inline-block;}.custom-input[data-v-9b456dcb] .el-input-group__append{@apply px-0 cursor-pointer;}.custom-input[data-v-9b456dcb] .el-input-group__append span{display:inline-block;line-height:30px;padding:0 8px}.custom-input[data-v-9b456dcb] .input.active .el-input__wrapper{box-shadow:0 0 0 2px #4485f5 inset}.custom-input[data-v-9b456dcb] .input.active .el-input-group__append{box-shadow:0 2px #4485f5 inset,0 -2px #4485f5 inset,-2px 0 #4485f5 inset}

package/dist/_plugin-vue_export-helper-CHgC5LLL.js

@@ -0,0 +1,9 @@
+const s = (t, r) => {
+  const o = t.__vccOpts || t;
+  for (const [c, e] of r)
+    o[c] = e;
+  return o;
+};
+export {
+  s as _
+};

package/dist/cascader.css

@@ -0,0 +1 @@
+.cascader-virtual-list[data-v-49e4ab07]{height:100%;min-height:204px;max-height:204px}.cascader-virtual-list[data-v-49e4ab07] .vue-recycle-scroller__item-view{width:100%}.empty-panel{padding:10px 0;margin:0;text-align:center;color:#909399}