diff --git a/_doc/完整使用文档.md b/_doc/完整使用文档.md index f95fb27..e048e63 100644 --- a/_doc/完整使用文档.md +++ b/_doc/完整使用文档.md @@ -6,7 +6,7 @@ ## 🎯 Demo 项目 -📦 **已提供完整的示例项目**:`demo-project/` +📦 **已提供完整的示例项目**:`demo/` 一个开箱即用的完整示例,包含: - ✅ 框架集成配置 @@ -18,12 +18,12 @@ **快速体验**: ```bash -cd demo-project +cd demo npm install npm run dev ``` -详细说明:[demo-project/README.md](./demo-project/README.md) +详细说明:[demo/README.md](./demo/README.md) --- @@ -46,7 +46,7 @@ npm run dev ✅ **主页组件**(欢迎页面,自动显示系统标题) ✅ **系统管理页面**(sys 开头的所有页面和功能) ✅ **系统 API**(system 和 system 所有 API) -✅ **全局组件**(Tables、Editor、Upload、FieldRenderer 等) +✅ **全局组件**(Tables、Editor、Upload、FieldRenderer、FloatPanel 等) ✅ **布局组件**(Main、ParentView) ✅ **文件下载**(支持 CSV 等格式,自动处理换行符) ✅ **登录和错误页面**(Login、401、404、500) @@ -63,11 +63,11 @@ npm run dev ### 🎯 方式一:使用 Demo 项目(推荐新手) -我们提供了一个完整的 **demo-project** 示例项目,可以直接运行查看效果! +我们提供了一个完整的 **demo** 示例项目,可以直接运行查看效果! ```bash # 1. 进入 demo 项目 -cd demo-project +cd demo # 2. 安装依赖 npm install @@ -81,7 +81,7 @@ npm run dev - `/home` - 主页 - `/business/product` - 业务示例页面 -**详细说明**:查看 `demo-project/README.md` 和 `demo-project/INSTALL.md` +**详细说明**:查看 `demo/README.md` --- @@ -628,6 +628,7 @@ import { ```javascript import { SysLog, // 系统日志管理 + SysLogOperate, // 系统操作日志 SysParamSetup, // 参数设置 SysRole, // 角色管理 SysUser // 用户管理 @@ -645,7 +646,7 @@ import { #### 在路由中使用 ```javascript -import { HomePage, SysUser, SysRole, SysMenu } from 'admin-framework' +import { HomePage, SysUser, SysRole, SysMenu, SysLog, SysLogOperate } from 'admin-framework' const routes = [ { @@ -667,6 +668,16 @@ const routes = [ path: '/system/menu', name: 'sys_menu', component: SysMenu + }, + { + path: '/system/log', + name: 'sys_log', + component: SysLog + }, + { + path: '/system/log_operate', + name: 'sys_log_operate', + component: SysLogOperate } ] ``` @@ -691,19 +702,35 @@ const users = await userServer.getList({ page: 1 }) const roles = await roleServer.getList() ``` -#### system API +#### system API(所有 API 都在 systemApi 中) ```javascript -import { systemHighApi } from 'admin-framework' +import { systemApi } from 'admin-framework' // 使用示例 const { + userServer, + roleServer, + sysLogServe, + fileServe, menuServer, paramSetupServer, modelServer, + formServer, + formFieldServer, + modelFieldServer, + tableServer, + rolePermissionServer, + sysControlTypeServer, + sysModuleServer, + sysAddressServer, + systemTypeServer, + plaAccountServer, // ... 其他 API -} = systemHighApi +} = systemApi // 调用 API +const users = await userServer.getList({ page: 1 }) +const roles = await roleServer.getList() const menus = await menuServer.getTree() const params = await paramSetupServer.getOne('sys_title') ``` @@ -739,17 +766,11 @@ const params = await paramSetupServer.getOne('sys_title') ref="floatPanel" title="详情面板" position="right" - :width="800" :show-back="true" back-text="返回" @back="handleBack" >