@agent-xy/admin-vue3 0.0.0-stage → 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (37) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +43 -2
  3. package/dist/index.js +1404 -0
  4. package/dist/style.css +1 -0
  5. package/dist/types/components/BaseCard/index.vue.d.ts +26 -0
  6. package/dist/types/components/DataTable/TableCell.vue.d.ts +14 -0
  7. package/dist/types/components/DataTable/index.vue.d.ts +53 -0
  8. package/dist/types/components/DataTable/types.d.ts +81 -0
  9. package/dist/types/components/Dialog/BaseDialog.vue.d.ts +141 -0
  10. package/dist/types/components/Dialog/index.d.ts +43 -0
  11. package/dist/types/components/Drawer/BaseDrawer.vue.d.ts +130 -0
  12. package/dist/types/components/Drawer/index.d.ts +1 -0
  13. package/dist/types/components/SearchForm/components/FormItem.vue.d.ts +35 -0
  14. package/dist/types/components/SearchForm/index.vue.d.ts +45 -0
  15. package/dist/types/components/SearchForm/types.d.ts +97 -0
  16. package/dist/types/components/SearchForm/values.d.ts +4 -0
  17. package/dist/types/hooks/useAsyncListAction.d.ts +7 -0
  18. package/dist/types/hooks/usePageList.d.ts +30 -0
  19. package/dist/types/hooks/useSelectOptions.d.ts +16 -0
  20. package/dist/types/index.d.ts +16 -0
  21. package/dist/types/types/admin.d.ts +3 -0
  22. package/dist/types/utils/adminCore.d.ts +74 -0
  23. package/dist/types/utils/data.d.ts +2 -0
  24. package/dist/types/utils/formRender.d.ts +2 -0
  25. package/dist/types/utils/tableRender.d.ts +7 -0
  26. package/docs/DataTable.md +23 -0
  27. package/docs/SearchForm.md +21 -0
  28. package/docs/usage.md +33 -0
  29. package/package.json +39 -4
  30. package/templates/manifest.json +23 -0
  31. package/templates/users/README.md +12 -0
  32. package/templates/users/UsersList.vue +73 -0
  33. package/templates/users/config.ts +12 -0
  34. package/templates/users/data-source.ts +5 -0
  35. package/templates/users/index.vue +21 -0
  36. package/templates/users/style.css +5 -0
  37. package/templates/users/types.ts +13 -0
@@ -0,0 +1,4 @@
1
+ import type { RuntimeFormItem } from './types';
2
+ export declare function clone<Value>(value: Value): Value;
3
+ export declare function same(left: unknown, right: unknown): boolean;
4
+ export declare function fieldNames(field: RuntimeFormItem): string[];
@@ -0,0 +1,7 @@
1
+ export declare function useAsyncListAction(refresh?: () => void | Promise<unknown>): {
2
+ pendingKeys: import("vue").Ref<string[], string[]>;
3
+ activate: () => void;
4
+ dispose: () => void;
5
+ exec: <T>(task: (signal: AbortSignal) => Promise<T>, success?: string | ((result: T) => string | undefined | false), key?: string) => Promise<T>;
6
+ };
7
+ export { isAbortError } from "../utils/adminCore";
@@ -0,0 +1,30 @@
1
+ import { type Query, type PageResult, type ListOptions } from "../utils/adminCore";
2
+ export declare function usePageList<Q extends Query, Row, Result extends PageResult<Row> = PageResult<Row>>(queryForm: Q, options: ListOptions<Q, Row, Result>): {
3
+ state: import("vue").ShallowRef<import("..").ListState<Q, Row, Result>, import("..").ListState<Q, Row, Result>>;
4
+ result: import("vue").ComputedRef<Result | undefined>;
5
+ loading: import("vue").ComputedRef<boolean>;
6
+ error: import("vue").ComputedRef<unknown>;
7
+ tableData: import("vue").ComputedRef<Row[]>;
8
+ total: import("vue").ComputedRef<number>;
9
+ pageParams: import("vue").ComputedRef<{
10
+ currentPage: number;
11
+ pageSize: number;
12
+ pageSizes: number[];
13
+ total: number;
14
+ }>;
15
+ getSnapshot: () => import("..").ListState<Q, Row, Result>;
16
+ subscribe: (listener: () => void) => () => void;
17
+ setOptions: (next: ListOptions<Q, Row, Result>) => void;
18
+ activate: () => void;
19
+ dispose: () => void;
20
+ getData: () => Promise<Result | undefined>;
21
+ onSubmit: (form: Partial<Q>) => Promise<Result | undefined>;
22
+ handlePageChange: ({ pageNum }: {
23
+ pageNum: number;
24
+ }) => Promise<Result | undefined>;
25
+ handleSizeChange: ({ pageSize }: {
26
+ pageSize: number;
27
+ }) => Promise<Result | undefined>;
28
+ reset: () => Promise<Result | undefined>;
29
+ restorePagination: () => void;
30
+ };
@@ -0,0 +1,16 @@
1
+ /** 返回独立选项状态,由页面组合字段配置,不修改外部配置。 */
2
+ export declare function useSelectOptions<Row, Value extends string | number | boolean>(fetcher: (signal: AbortSignal) => Promise<Row[]>, map: (row: Row) => {
3
+ label: string;
4
+ value: Value;
5
+ }): {
6
+ options: import("vue").ShallowRef<{
7
+ label: string;
8
+ value: Value;
9
+ }[], {
10
+ label: string;
11
+ value: Value;
12
+ }[]>;
13
+ loading: import("vue").Ref<boolean, boolean>;
14
+ error: import("vue").ShallowRef<Error | null, Error | null>;
15
+ reload: () => Promise<void>;
16
+ };
@@ -0,0 +1,16 @@
1
+ export { default as BaseCard } from './components/BaseCard/index.vue';
2
+ export { default as SearchForm } from './components/SearchForm/index.vue';
3
+ export { default as DataTable } from './components/DataTable/index.vue';
4
+ export { default as AdminDialog } from './components/Dialog';
5
+ export * from './components/Dialog';
6
+ export * from './components/Drawer';
7
+ export * from './hooks/usePageList';
8
+ export * from './hooks/useSelectOptions';
9
+ export * from './hooks/useAsyncListAction';
10
+ export * from './utils/formRender';
11
+ export * from './utils/tableRender';
12
+ export * from './utils/data';
13
+ export type * from './components/SearchForm/types';
14
+ export type * from './components/DataTable/types';
15
+ export type { Query, ListOptions, PageResult, ListState } from './utils/adminCore';
16
+ export type { TablePageParams as PaginationParams } from './components/DataTable/types';
@@ -0,0 +1,3 @@
1
+ export type { SelectOption, Query, ListOptions, PageResult } from '../utils/adminCore';
2
+ export type { FormItemConfig, FormModel, SearchFormProps, SearchFormExpose } from '../components/SearchForm/types';
3
+ export type { TableColumn, TablePageParams as PaginationParams } from '../components/DataTable/types';
@@ -0,0 +1,74 @@
1
+ /** 工具集内部状态逻辑。请求与业务响应转换由调用方提供。 */
2
+ export type Query = {
3
+ page?: number;
4
+ page_size?: number;
5
+ page_sizes?: number[];
6
+ total?: number;
7
+ };
8
+ export interface PageResult<Row> {
9
+ list: Row[];
10
+ total: number;
11
+ }
12
+ export interface ListOptions<Q extends Query, Row, Result extends PageResult<Row> = PageResult<Row>> {
13
+ initialQuery: Q;
14
+ fetchList: (query: Q, signal: AbortSignal) => Promise<Result>;
15
+ keepPrevious?: boolean;
16
+ persistKey?: string;
17
+ isRefreshData?: boolean;
18
+ onError?: (error: unknown) => void;
19
+ }
20
+ export interface ListState<Q, Row, Result = PageResult<Row>> {
21
+ result: Result | undefined;
22
+ query: Q;
23
+ tableData: Row[];
24
+ total: number;
25
+ loading: boolean;
26
+ error: unknown;
27
+ }
28
+ /** 克隆查询和配置的可变部分,保留回调;日期不转成字符串。 */
29
+ export declare function clone<T>(value: T): T;
30
+ export declare function createListController<Q extends Query, Row, Result extends PageResult<Row> = PageResult<Row>>(initialQuery: Q, initialOptions: ListOptions<Q, Row, Result>): {
31
+ getSnapshot: () => ListState<Q, Row, Result>;
32
+ subscribe: (listener: () => void) => () => void;
33
+ setOptions: (next: ListOptions<Q, Row, Result>) => void;
34
+ activate: () => void;
35
+ dispose: () => void;
36
+ pageParams: () => {
37
+ currentPage: number;
38
+ pageSize: number;
39
+ pageSizes: number[];
40
+ total: number;
41
+ };
42
+ getData: () => Promise<Result | undefined>;
43
+ onSubmit: (form: Partial<Q>) => Promise<Result | undefined>;
44
+ handlePageChange: ({ pageNum }: {
45
+ pageNum: number;
46
+ }) => Promise<Result | undefined>;
47
+ handleSizeChange: ({ pageSize }: {
48
+ pageSize: number;
49
+ }) => Promise<Result | undefined>;
50
+ reset: () => Promise<Result | undefined>;
51
+ restorePagination: () => void;
52
+ };
53
+ export interface SelectOption {
54
+ label: string;
55
+ value: string | number | boolean;
56
+ }
57
+ export interface FieldMap {
58
+ key: string;
59
+ value: string;
60
+ }
61
+ export declare function getFiltedOptions(raw: unknown[], map: FieldMap): SelectOption[];
62
+ export declare function createOptionsController(write: (field: string, options: SelectOption[]) => void): {
63
+ activate: () => void;
64
+ dispose: () => void;
65
+ setFieldOptions: (field: string, raw: unknown[], map: FieldMap) => void;
66
+ loadFieldOptions: (field: string, fetcher: () => Promise<unknown[]>, map: FieldMap) => Promise<void>;
67
+ };
68
+ /** 取消不作为业务失败展示,调用方可据此忽略过期操作。 */
69
+ export declare function isAbortError(error: unknown): boolean;
70
+ export declare function createActionController(refresh?: () => void | Promise<unknown>, notify?: (text: string) => void, onPending?: (keys: string[]) => void): {
71
+ activate: () => void;
72
+ dispose: () => void;
73
+ exec: <T>(task: (signal: AbortSignal) => Promise<T>, success?: string | ((result: T) => string | undefined | false), key?: string) => Promise<T>;
74
+ };
@@ -0,0 +1,2 @@
1
+ export { getFiltedOptions } from './adminCore';
2
+ export type { FieldMap, SelectOption } from './adminCore';
@@ -0,0 +1,2 @@
1
+ import type { FormItemConfig } from '../components/SearchForm/types';
2
+ export declare function buildFormItems<Values extends object>(items: FormItemConfig<Values>[]): FormItemConfig<Values>[];
@@ -0,0 +1,7 @@
1
+ import type { TableColumn } from '../components/DataTable/types';
2
+ export interface CopyFeedback {
3
+ onCopied?: () => void;
4
+ onCopyError?: (error: unknown) => void;
5
+ }
6
+ export declare function createRender<Row extends object>(column: TableColumn<Row>, feedback?: CopyFeedback): NonNullable<TableColumn<Row>['render']>;
7
+ export declare function buildColumns<Row extends object = Record<string, unknown>>(columns: TableColumn<Row>[], feedback?: CopyFeedback): TableColumn<Row>[];
@@ -0,0 +1,23 @@
1
+ # DataTable
2
+
3
+ 基于 Element Plus 的泛型表格。完整调用见 [用户管理模板](../templates/users/index.vue)。
4
+
5
+ | 属性 | 用途 |
6
+ | --- | --- |
7
+ | `tableData: Row[] / tableColumns: TableColumn<Row>[]` | 行数据与列配置;不在表格内部请求 |
8
+ | `rowKey` | 必填稳定行标识;字段名或返回字符串/数字的函数 |
9
+ | `pageParams` | `{ currentPage, pageSize, pageSizes?, total }`;也支持列表接口的 page/page_size 结构 |
10
+ | `showColumnSettings` | 独立工具栏列设置入口,默认开启 |
11
+ | `selection / reserveSelection` | 行选择及跨页保留 |
12
+ | `tableHeight / maxHeight / resizable` | 原生高度与列宽调整 |
13
+ | `showSerialNumber` | 按当前页计算序号,默认开启 |
14
+
15
+ 列用 `prop` 标识、`label` 展示,支持 width/minWidth、fixed、align、group、sortable、formatter、render、tooltip、lineClamp。连续且固定方向一致的同名 group 合成分组表头。`hideable: false` 禁止隐藏;`showColumn` 表达初始或显式变化的显示配置。修改标题或重建相同配置不重置用户勾选。
16
+
17
+ 单元格插槽按 prop 命名,接收 `{ row, column, index }`;表头使用 `header-${prop}` 插槽。渲染顺序为字段插槽 → render → formatter → 原值;空值不插入 HTML。多行省略按实际溢出测量显示提示,支持键盘聚焦。
18
+
19
+ `toolbar` 放刷新等操作,`multiple-operation` 接收 `selectionData`,`empty` 自定义空态。其他属性和原生事件透传 ElTable,class/style 放外层容器。
20
+
21
+ 分页事件:`handle-current-change({ pageNum })`、`handle-size-change({ pageSize })`;修改每页数量时去重页码变化。其他事件:`handle-selection-change(rows)`、`handle-sort-change({ prop, order })`。
22
+
23
+ 实例方法:clearSort、sort、doLayout、clearSelection、getSelectionRows、toggleRowSelection。组件外调用需要保存泛型实例类型 `TableExpose<Row>`。
@@ -0,0 +1,21 @@
1
+ # SearchForm
2
+
3
+ 配置式搜索表单,内部维护输入草稿。基础接入见 [技术栈 README](../README.md),完整页面见 [用户管理模板](../templates/users/index.vue)。
4
+
5
+ | 属性 | 用途 |
6
+ | -------------------------------------- | ------------------------------------------------------------ |
7
+ | `formHeader: FormItemConfig<Values>[]` | 字段与模型键、控件值类型关联 |
8
+ | `formModel?: Partial<Values>` | 初始输入与外部回填;对象替换覆盖草稿,原地变化只同步变化字段 |
9
+ | `loading / disabled` | 提交忙状态 / 禁用表单 |
10
+ | `showButton / isShowReset` | 默认操作按钮 / 重置按钮 |
11
+ | `labelPosition / labelWidth` | 标签布局 |
12
+
13
+ 字段类型:`text`、`number`、`selectOne`(可配置 multiple)、`date`、`dateRange`、`datetimerange`、`inputBoxInterval`、`custom`。数字区间用 `propName1 / propName2`,其余用 `propName`。单选及多选支持字符串、数字、布尔值。日期默认输出字符串:单日期与日期范围为 `YYYY-MM-DD`,时间范围为 `YYYY-MM-DD HH:mm:ss`。`format` 控制展示,`valueFormat` 控制输出;字符串模型使用非空格式。若模型使用 `Date` 或 `Date[]`,必须显式设置 `valueFormat: ''`,并在接口边界转换。
14
+
15
+ `optionsArr`、远程加载与 `loading` 由页面提供,可通过 `useSelectOptions` 管理选项请求。控件扩展放 `controlProps`;值及更新事件由组件管理,不通过 controlProps 覆盖。`rules` 使用与 Element Plus 一致的 async-validator 规则,由字段管理校验序号,旧成功和旧失败都不能改写当前校验状态;没有 rules 时使用内置必填、区间完整性与数字区间顺序检查。
16
+
17
+ 事件 `submit-form / reset-form / form-change` 都返回当前配置字段的独立快照。移除字段会清理其草稿与校验,新增字段按首次注册时模型值重置。回车和搜索按钮走同一次校验;规则或值变化使未完成校验失效。
18
+
19
+ 字段插槽按 `slotName ?? propName` 匹配,接收 `{ form, item, value, updateValue, change }`。通过 `updateValue(value)` 或 `change(name, value)` 更新,不直接写 form。`actions` 插槽接收 `{ submit, reset, form, busy }`;`actions-extra` 放导出等页面操作。
20
+
21
+ 实例方法:`submitForm(): Promise<boolean>`、`resetForm()`、`getFormData()`、`validate()`、`validateField()`、`clearValidate()`。提交事件本身不等待页面请求,页面使用 loading 管理请求状态。切换初始化实体时更换 key。
package/docs/usage.md ADDED
@@ -0,0 +1,33 @@
1
+ # 弹层与列表逻辑
2
+
3
+ 以下能力均通过 `@agent-xy/admin-vue3` 的公共导出使用。
4
+
5
+ ## 列表逻辑
6
+
7
+ | 能力 | 入口与职责 | 状态约定 |
8
+ | --- | --- | --- |
9
+ | `usePageList(query, options)` | 注入 `fetchList(query, signal)`;搜索 `onSubmit`、重置 `reset`、刷新 `getData`、分页 `handlePageChange` / `handleSizeChange` | 返回 `tableData`、`total`、完整 `result`、`loading`、`error` 和 `pageParams`;过期响应不覆盖新查询 |
10
+ | `useSelectOptions(fetcher, map)` | 项目请求选项并转换为 `{ label, value }` | 挂载加载,独立 `loading`、`error`、`reload`;卸载取消 |
11
+ | `useAsyncListAction(refresh?)` | `exec(signal => operation(signal), successMessage?, key?)` | 同键操作去重,成功后刷新;失败拒绝;卸载取消 |
12
+
13
+ `usePageList` 不自动发起首次请求,由页面明确调用。`fetchList` 返回 `{ list, total }` 或包含额外统计的扩展结果。查询参数原始值与嵌套条件通过 `initialQuery` 提供。
14
+
15
+ 搜索组件维护草稿;页面提交时整体替换 `filters`,翻页使用已提交条件。请求失败通过 `error` 展示,不回退演示数据。取消错误可通过 `isAbortError` 判断。
16
+
17
+ [用户管理模板](../templates/users/index.vue) 展示数据源接入、分页与行操作。模板中的展示模型可以修改,不作为后端接口契约。
18
+
19
+ ## 弹层
20
+
21
+ 声明式 `BaseDialog`、`BaseDrawer` 使用 `v-model` 控制可见性,不需要安装弹窗插件。确认操作通过 `onConfirm` 接收可等待的回调;失败拒绝 Promise,弹层保留输入并展示错误。
22
+
23
+ `BaseDialog` 默认 `closeOnConfirm: true`,可以设置为 `false`,在保存成功后保持打开。`confirmDisabled` 禁用确认;组件实例的 `confirm()` 与确认按钮共用校验及重复操作保护。
24
+
25
+ 函数式弹窗可选择 `app.use(AdminDialog)` 后使用 `Dialog` / `showDialog`。多个 Vue 应用或需要显式管理宿主上下文时,使用 `createDialogService(appContext)`,在宿主退出时调用返回的 `dispose()`。
26
+
27
+ `Dialog.confirm` 返回 `Promise<boolean>`;关闭或释放实例时以 `false` 结束。首版没有函数式抽屉。
28
+
29
+ ## 配置辅助
30
+
31
+ `buildFormItems` 和 `buildColumns` 是可选辅助函数,不要求额外包装。列辅助支持枚举、嵌套字段和复制入口,保留调用方的 `render` / `formatter`。
32
+
33
+ 通过 `CopyFeedback` 的 `onCopied`、`onCopyError` 接入项目提示方式。默认值仅填补缺失值,保留 `0`、`false` 和空字符串。
package/package.json CHANGED
@@ -1,6 +1,41 @@
1
1
  {
2
2
  "name": "@agent-xy/admin-vue3",
3
- "version": "0.0.0-stage",
4
- "stub": true,
5
- "description": "Temporary package placeholder for staged publishing"
6
- }
3
+ "version": "0.1.0",
4
+ "description": "Vue 3 管理后台组件、类型与页面起点",
5
+ "type": "module",
6
+ "license": "MIT",
7
+ "engines": { "node": ">=18" },
8
+ "files": ["dist", "templates", "docs", "README.md", "LICENSE"],
9
+ "main": "./dist/index.js",
10
+ "module": "./dist/index.js",
11
+ "types": "./dist/types/index.d.ts",
12
+ "exports": {
13
+ ".": { "types": "./dist/types/index.d.ts", "import": "./dist/index.js" },
14
+ "./style.css": "./dist/style.css",
15
+ "./package.json": "./package.json",
16
+ "./templates/manifest.json": "./templates/manifest.json",
17
+ "./docs/*": "./docs/*",
18
+ "./README.md": "./README.md"
19
+ },
20
+ "sideEffects": ["**/*.css"],
21
+ "scripts": {
22
+ "prebuild": "cd ../.. && node scripts/build-admin.mjs",
23
+ "build": "vite build && vue-tsc -p tsconfig.build.json",
24
+ "typecheck": "vue-tsc --noEmit -p tsconfig.json",
25
+ "dev": "vite --config vite.demo.config.ts",
26
+ "build:demo": "vue-tsc --noEmit -p tsconfig.demo.json && vite build --config vite.demo.config.ts"
27
+ },
28
+ "peerDependencies": { "vue": "^3.5.25", "element-plus": "^2.11.5" },
29
+ "dependencies": { "async-validator": "4.2.5" },
30
+ "devDependencies": {
31
+ "vue": "3.5.25",
32
+ "element-plus": "2.11.5",
33
+ "@vitejs/plugin-vue": "5.2.4",
34
+ "vite": "5.4.21",
35
+ "vue-tsc": "2.2.12",
36
+ "typescript": "5.9.3",
37
+ "sass": "1.93.2",
38
+ "@types/node": "20.17.24",
39
+ "jsdom": "24.1.3"
40
+ }
41
+ }
@@ -0,0 +1,23 @@
1
+ {
2
+ "schemaVersion": 1,
3
+ "framework": "vue3",
4
+ "package": "@agent-xy/admin-vue3",
5
+ "style": "@agent-xy/admin-vue3/style.css",
6
+ "documentation": "@agent-xy/admin-vue3/README.md",
7
+ "capabilities": [
8
+ { "name": "布局", "exports": ["BaseCard"], "purpose": "页面区块布局" },
9
+ { "name": "搜索", "exports": ["SearchForm", "buildFormItems"], "purpose": "搜索项配置、提交和重置" },
10
+ { "name": "表格", "exports": ["DataTable", "buildColumns"], "purpose": "列、分页与操作插槽" },
11
+ { "name": "弹层", "exports": ["BaseDialog", "BaseDrawer", "AdminDialog", "createDialogService"], "purpose": "声明式弹层与可等待的确认" },
12
+ { "name": "列表逻辑", "exports": ["usePageList", "useSelectOptions", "useAsyncListAction"], "purpose": "由项目注入请求,处理查询、选项和异步操作" }
13
+ ],
14
+ "links": {},
15
+ "templates": {
16
+ "users": {
17
+ "title": "用户管理",
18
+ "root": "templates/users",
19
+ "entry": "index.vue",
20
+ "files": ["index.vue", "UsersList.vue", "config.ts", "data-source.ts", "types.ts", "style.css", "README.md"]
21
+ }
22
+ }
23
+ }
@@ -0,0 +1,12 @@
1
+ # 用户管理页面起点
2
+
3
+ 本目录归业务项目维护。公共组件来自 `@agent-xy/admin-vue3`,组件升级或规则同步不会覆盖这些文件。
4
+
5
+ 1. 将 `index.vue` 接入项目已有路由;生成器不自动修改路由。
6
+ 2. 在 `data-source.ts` 实现 `UsersDataSource`,接入现有请求层并传递取消信号。`types.ts` 是页面展示模型,不代表后端接口。
7
+ 3. 列表响应映射为 `{ list, total }`。接口失败应拒绝 Promise,不返回演示数据。
8
+ 4. 根据项目修改 `config.ts` 的搜索项和列,以及 `UsersList.vue` 的操作区。权限和业务操作由页面负责。
9
+
10
+ 未配置数据源时只显示接入提示。示例通过 `source` 属性注入模拟数据,模拟实现不包含在本目录。
11
+
12
+ 入口显式加载 Element Plus 与组件样式;若项目统一加载样式,可以移到已有样式入口。模板仅使用普通 CSS。
@@ -0,0 +1,73 @@
1
+ <template>
2
+ <main class="admin-users">
3
+ <BaseCard>
4
+ <template #title><h1>用户管理</h1></template>
5
+ <SearchForm
6
+ :form-header="fields"
7
+ :form-model="initialFilters"
8
+ :loading="loading"
9
+ @submit-form="search"
10
+ @reset-form="resetFilters"
11
+ />
12
+ </BaseCard>
13
+ <ElAlert v-if="error" type="error" :title="error instanceof Error ? error.message : String(error)" :closable="false">
14
+ <ElButton @click="getData">重试</ElButton>
15
+ </ElAlert>
16
+ <BaseCard>
17
+ <DataTable
18
+ row-key="id"
19
+ :table-columns="columns"
20
+ :table-data="tableData"
21
+ :loading="loading"
22
+ :page-params="pageParams"
23
+ table-height="440"
24
+ @handle-current-change="handlePageChange"
25
+ @handle-size-change="handleSizeChange"
26
+ >
27
+ <template #toolbar><ElButton :disabled="loading" @click="getData">刷新</ElButton></template>
28
+ <template #operation="{ row }">
29
+ <ElButton @click="selectedId = row.id">查看<span class="admin-users__sr-only">{{ row.name }}</span></ElButton>
30
+ </template>
31
+ </DataTable>
32
+ </BaseCard>
33
+ <BaseDrawer v-if="selectedRow" v-model="drawerOpen" title="用户信息" :show-confirm="false">
34
+ <dl class="admin-users__details">
35
+ <dt>姓名</dt><dd>{{ selectedRow.name }}</dd>
36
+ <dt>邮箱</dt><dd>{{ selectedRow.email }}</dd>
37
+ </dl>
38
+ </BaseDrawer>
39
+ </main>
40
+ </template>
41
+
42
+ <script setup lang="ts">
43
+ import { computed, reactive, ref, watch } from 'vue';
44
+ import { ElAlert, ElButton } from 'element-plus';
45
+ import { BaseCard, BaseDrawer, DataTable, SearchForm, usePageList } from '@agent-xy/admin-vue3';
46
+ import { columns, fields, initialFilters } from './config';
47
+ import type { UserFilters, UserQuery, UserRow, UsersDataSource } from './types';
48
+
49
+ const props = defineProps<{ source: UsersDataSource }>();
50
+ const initialQuery: UserQuery = { page: 1, page_size: 20, filters: { ...initialFilters } };
51
+ const query = reactive<UserQuery>({ ...initialQuery, filters: { ...initialFilters } });
52
+ const {
53
+ tableData, loading, error, pageParams, getData, onSubmit, reset,
54
+ handlePageChange, handleSizeChange,
55
+ } = usePageList<UserQuery, UserRow>(query, {
56
+ initialQuery,
57
+ fetchList: (params, signal) => props.source.list(params, signal),
58
+ });
59
+
60
+ // 仅保留行标识,刷新替换行对象后详情读取当前记录。
61
+ const selectedId = ref<string>();
62
+ const selectedRow = computed(() => tableData.value.find(row => row.id === selectedId.value));
63
+ const drawerOpen = computed({
64
+ get: () => Boolean(selectedRow.value),
65
+ set: (open: boolean) => { if (!open) selectedId.value = undefined; },
66
+ });
67
+ function search(filters: Partial<UserFilters>) { void onSubmit({ filters }); }
68
+ function resetFilters() { selectedId.value = undefined; void reset(); }
69
+ watch(() => props.source, () => {
70
+ selectedId.value = undefined;
71
+ void reset();
72
+ }, { immediate: true });
73
+ </script>
@@ -0,0 +1,12 @@
1
+ import { buildColumns, buildFormItems } from '@agent-xy/admin-vue3';
2
+ import type { UserFilters, UserRow } from './types';
3
+
4
+ export const initialFilters: UserFilters = { keyword: '' };
5
+ export const fields = buildFormItems<UserFilters>([
6
+ { propName: 'keyword', itemType: 'text', labelName: '用户', placeholder: '输入姓名或邮箱' },
7
+ ]);
8
+ export const columns = buildColumns<UserRow>([
9
+ { prop: 'name', label: '姓名', minWidth: 140 },
10
+ { prop: 'email', label: '邮箱', minWidth: 200 },
11
+ { prop: 'operation', label: '操作', width: 120, fixed: 'right', hideable: false },
12
+ ]);
@@ -0,0 +1,5 @@
1
+ import type { UsersDataSource } from './types';
2
+
3
+ // 在这里接入项目已有请求层,映射查询和响应;不在公共组件中填写业务地址。
4
+ // 未配置时页面仅显示接入提示,不发送请求,也不返回模拟成功数据。
5
+ export const usersDataSource: UsersDataSource | undefined = undefined;
@@ -0,0 +1,21 @@
1
+ <template>
2
+ <UsersList v-if="source" :source="source" />
3
+ <section v-else class="admin-users" aria-labelledby="users-setup-title">
4
+ <h1 id="users-setup-title">用户管理</h1>
5
+ <p role="status">尚未接入用户数据源。请在本页面的 data-source.ts 中接入项目请求层。</p>
6
+ </section>
7
+ </template>
8
+
9
+ <script setup lang="ts">
10
+ import { computed } from 'vue';
11
+ import 'element-plus/dist/index.css';
12
+ import '@agent-xy/admin-vue3/style.css';
13
+ import './style.css';
14
+ import UsersList from './UsersList.vue';
15
+ import { usersDataSource } from './data-source';
16
+ import type { UsersDataSource } from './types';
17
+
18
+ // 示例通过属性提供数据源;业务项目也可以直接编辑 data-source.ts。
19
+ const props = defineProps<{ source?: UsersDataSource }>();
20
+ const source = computed(() => props.source ?? usersDataSource);
21
+ </script>
@@ -0,0 +1,5 @@
1
+ .admin-users { display: grid; gap: 16px; }
2
+ .admin-users h1 { margin: 0; font-size: 20px; }
3
+ .admin-users__details dt { margin-top: 12px; font-weight: 600; }
4
+ .admin-users__details dd { margin: 4px 0 0; overflow-wrap: anywhere; }
5
+ .admin-users__sr-only { position: absolute; width: 1px; height: 1px; overflow: hidden; clip-path: inset(50%); white-space: nowrap; }
@@ -0,0 +1,13 @@
1
+ import type { PageResult } from '@agent-xy/admin-vue3';
2
+
3
+ // 页面展示模型;在 data-source.ts 中将实际接口映射到此模型,或按项目契约修改。
4
+ export interface UserRow {
5
+ id: string;
6
+ name: string;
7
+ email: string;
8
+ }
9
+ export interface UserFilters { keyword?: string }
10
+ export interface UserQuery { page: number; page_size: number; filters: UserFilters }
11
+ export interface UsersDataSource {
12
+ list(query: UserQuery, signal: AbortSignal): Promise<PageResult<UserRow>>;
13
+ }