From b7ff2e0673f26d39b891dc7e3b0bfb61c322f1a1 Mon Sep 17 00:00:00 2001 From: chenos Date: Sun, 23 May 2021 09:32:43 +0800 Subject: [PATCH] update docs --- packages/client/src/components/Drawer/index.md | 9 ++++++++- packages/client/src/components/MenuEditor/index.md | 2 ++ packages/client/src/templates/admin-layout/index.md | 1 + packages/client/src/templates/auth-layout/index.md | 4 ++++ packages/client/src/templates/page-template/index.md | 1 + 5 files changed, 16 insertions(+), 1 deletion(-) diff --git a/packages/client/src/components/Drawer/index.md b/packages/client/src/components/Drawer/index.md index 178b8b88c..719b658d2 100644 --- a/packages/client/src/components/Drawer/index.md +++ b/packages/client/src/components/Drawer/index.md @@ -16,6 +16,9 @@ group: ### 基础抽屉 ```tsx +/** + * title: 基础抽屉 + */ import React from 'react'; import { Button } from 'antd'; import Drawer from './index.tsx'; @@ -41,6 +44,10 @@ export default () => ( ### 多层抽屉 ```tsx +/** + * title: 多层抽屉 + * desc: 有多少层就执行多少个 `Drawer.open(props)` + */ import React from 'react'; import { Button } from 'antd'; import Drawer from './index.tsx'; @@ -75,7 +82,7 @@ export default () => ( ```tsx /** * title: 关闭时提示 - * desc: 更多参数请参考 `Modal.confirm` + * desc: 通过 `closeWithConfirm(props)` 方法触发,更多参数请参考 `Modal.confirm` */ import React from 'react'; import { Button } from 'antd'; diff --git a/packages/client/src/components/MenuEditor/index.md b/packages/client/src/components/MenuEditor/index.md index 7d7d6d432..53dd394ca 100644 --- a/packages/client/src/components/MenuEditor/index.md +++ b/packages/client/src/components/MenuEditor/index.md @@ -11,6 +11,8 @@ group: # MenuEditor - 菜单编辑器 +基于 Ant Design Menu 组件实现的菜单编辑器,考虑到可视化编辑的体验,目前只支持`竖向菜单`和`混合菜单`两种场景。 + ## 代码演示 ### 竖向菜单 diff --git a/packages/client/src/templates/admin-layout/index.md b/packages/client/src/templates/admin-layout/index.md index 5950737e7..276c9f236 100644 --- a/packages/client/src/templates/admin-layout/index.md +++ b/packages/client/src/templates/admin-layout/index.md @@ -11,3 +11,4 @@ group: # AdminLayout - 后台布局 +内置的后台布局模板,提供了基础的菜单和路由切换。 diff --git a/packages/client/src/templates/auth-layout/index.md b/packages/client/src/templates/auth-layout/index.md index 9b9c499e3..7cc91617f 100644 --- a/packages/client/src/templates/auth-layout/index.md +++ b/packages/client/src/templates/auth-layout/index.md @@ -8,3 +8,7 @@ group: title: Templates path: /client/templates --- + +# AuthLayout - 登录布局 + +内置的登录、注册页布局 \ No newline at end of file diff --git a/packages/client/src/templates/page-template/index.md b/packages/client/src/templates/page-template/index.md index 8df3d8154..36b33510f 100644 --- a/packages/client/src/templates/page-template/index.md +++ b/packages/client/src/templates/page-template/index.md @@ -11,3 +11,4 @@ group: # PageTemplate - 页面模板 +常规的页面模板,支持区块配置。