@wlydfe/pro-ui 0.2.21 → 0.2.24

package/docs/components/search.md

@@ -1,149 +0,0 @@
-# Search 搜索
-
-[PlusSearch](/components/search.html) 是在 [PlusForm](/components/form.html) 组件上自定义 `footer` 的基础上构建而来，除下文提到 [PlusSearch](/components/search.html) 特有的属性和方法外，同时支持 [PlusForm](/components/form.html) 组件的所有自定义函数和插槽。
-
-::: warning 注意
-表单`v-model`绑定的值尽量使用 ref 定义绑定的值，以避免 reactive 带来的响应式丢失问题。 <el-text  type="primary" tag="ins">[参考 reactive 的局限性](https://cn.vuejs.org/guide/essentials/reactivity-fundamentals.html#limitations-of-reactive)</el-text>
-:::
-
-## 基础用法
-
-:::demo
-
-search/basic
-
-:::
-
-## 显示个数
-
-配置 `show-number` 属性为显示个数，默认值 2。
-
-:::demo
-
-search/show-number
-
-:::
-
-## 展开收缩隐藏
-
-配置 `hasUnfold` 属性为`false`展开收缩隐藏，同时默认显示所有搜索框。
-
-:::demo
-
-search/hide-unfold
-
-:::
-
-## 自定义搜索按钮
-
-使用`search-footer` 自定义搜索按钮.
-
-:::demo
-
-search/search-footer
-
-:::
-
-## 默认搜索参数
-
-配置 `defaultValues`属性，设置默认搜索参数，当页面**点击重置按钮**时 [PlusSearch](/components/search.html) 组件的`model-value / v-model` 会被设置为 defaultValues。
-
-:::demo
-
-search/default-values
-
-:::
-
-## 隐藏 label
-
-表单整体的`hasLabel` 设置为 `false` 时, 隐藏 label。配置[columns](/components/config.html)中的 `hasLabel`可以控制单个表单项的 label 是否显示， 优先级会更高。
-
-:::demo
-
-search/hide-label
-
-:::
-
-## 异步数据用法
-
-[PlusColumn](/components/config.html) 配置中的 `options` 支持数组，函数和 Promise。
-[PlusColumn](/components/config.html) 配置中的 `fieldProps` 支持对象 object，函数和 Promise。
-
-:::demo
-
-search/async
-
-:::
-
-## Search API
-
-## Search Attributes
-
-| 名称                                         | 说明                                                                                                                 | 类型                                                                                    | 默认值                              | 是否必须 |
-| -------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | ----------------------------------- | -------- |
-| `model-value / v-model`                      | 搜索表单绑定值 <el-text type="warning">（尽量使用 ref 定义绑定的值，以避免 reactive 带来的响应式丢失问题）</el-text> | `object`[FieldValues](/components/type.html#fieldvalues)                                |                                     | 否       |
-| `defaultValues`                              | 点击重置按钮时 赋值给表单                                                                                            | `object` [FieldValues](/components/type.html#fieldvalues)                               | `{}`                                | 否       |
-| `columns`                                    | 搜索配置信息                                                                                                         | `array` [PlusColumn[]](/components/config.html)                                         | `[]`                                | 否       |
-| `hasFooter`                                  | 是否需要全部按钮                                                                                                     | `boolean`                                                                               | `true`                              | 否       |
-| `hasReset`                                   | 是否需要底部按钮 `重置`                                                                                              | `boolean`                                                                               | `true`                              | 否       |
-| `hasUnfold`                                  | 是否显示展开收缩按钮， 当 columns 中有效的数据（hideInSearch 不为 true）的长度小于`showNumber` 时自动隐藏            | `boolean`                                                                               | `true`                              | 否       |
-| `searchLoading`                              | 查询按钮 loading                                                                                                     | `boolean`                                                                               | `false`                             | 否       |
-| `searchText`                                 | 查询按钮文字                                                                                                         | `string`                                                                                | `查询`                              | 否       |
-| `resetText`                                  | 重置按钮文字                                                                                                         | `string`                                                                                | `重置`                              | 否       |
-| `retractText`<el-tag>v0.1.16</el-tag>        | 收起按钮文字                                                                                                         | `string`                                                                                | `收起`                              | 否       |
-| `expandText`<el-tag>v0.1.16</el-tag>         | 展开按钮文字                                                                                                         | `string`                                                                                | `展开`                              | 否       |
-| `inline`                                     | 一行内显示                                                                                                           | `boolean`                                                                               | `true`                              | 否       |
-| `showNumber`                                 | 默认显示个数                                                                                                         | `number`                                                                                | `2`                                 | 否       |
-| `rowProps`                                   | el-row 属性                                                                                                          | `object`[RowProps](https://element-plus.org/zh-CN/component/layout.html#row-attributes) | `{gutter: 20}`                      | 否       |
-| `colProps`                                   | el-col 属性                                                                                                          | `object`[ColProps](https://element-plus.org/zh-CN/component/layout.html#col-attributes) | `{xs: 24,sm: 12,md: 8,lg: 8,xl: 6}` | 否       |
-| `collapseTransition`<el-tag>v0.1.15</el-tag> | 是否开启折叠动画                                                                                                     | `boolean`                                                                               | `true`                              | 否       |
-| `collapseDuration`<el-tag>v0.1.15</el-tag>   | 折叠动画持续时长(单位：ms)                                                                                           | `number`                                                                                | `300`                               | 否       |
-| `needValidate`<el-tag>v0.1.15</el-tag>       | 搜索是否需要校验 ，默认不需要校验表单                                                                                | `boolean`                                                                               | `false`                             | 否       |
-| `defaultUnfold`<el-tag>v0.1.24</el-tag>      | 默认展开搜索                                                                                                         | `boolean`                                                                               | `false`                             | 否       |
-| ...                                          | ...                                                                                                                  | ...                                                                                     | ...                                 | ...      |
-
-:::tip 提示
-**`...`表示同时支持所有 [PlusFrom 方法](/components/form.html) Attributes** 。
-:::
-
-## Search Events
-
-| 名称                              | 说明                                                                                             | 类型                                                                                        |
-| --------------------------------- | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------- |
-| `search`                          | 点击查询按钮触发的事件。<el-tag>v0.1.15</el-tag> 版本新增 `needValidate`，开启后校验通过才会触发 | `function` <docs-tip content='(values: FieldValues) => void'></docs-tip>                    |
-| `change`                          | 表单变化触发的事件                                                                               | `function` <docs-tip content='(values: FieldValues,column: PlusColumn) => void'></docs-tip> |
-| `reset`                           | 点击重置按钮触发的事件                                                                           | `function` <docs-tip content='(values: FieldValues) => void'></docs-tip>                    |
-| `collapse`<el-tag>v0.0.6</el-tag> | 点击展开/收起触发的事件                                                                          | `function` <docs-tip content='(isShowUnfold: Boolean) => void'></docs-tip>                  |
-
-## Search Slots
-
-| 插槽名                                | 说明                                                                                                                               | 作用域插槽参数                                                                                                        |
-| ------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- |
-| `footer`                              | 自定义搜索 按钮组 区域                                                                                                             | `{isShowUnfold,handleReset,handleSearch,handleUnfold,searchLoading}` searchLoading 参数为<el-tag>v0.1.23</el-tag>新增 |
-| `tooltip-icon`<el-tag>v0.0.5</el-tag> | tooltip icon                                                                                                                       |                                                                                                                       |
-| `plus-field-*`                        | [PlusForm](/components/form.html#form-slots) 的自定义表单项，组件会自动根据配置项的 prop 生成对应的插槽                            | `{prop,label,fieldProps,valueType,column}`                                                                            |
-| `plus-label-*`                        | [PlusForm](/components/form.html#form-slots) 的自定义表单项 label，组件会自动根据配置项的 prop 生成对应的插槽                      | `{prop,label,fieldProps,valueType,column}`                                                                            |
-| `plus-extra-*`                        | [PlusForm](/components/form.html#form-slots)的自定义渲染 el-form-item 下一行额外的内容，组件会自动根据配置项的 prop 生成对应的插槽 | `{column}`                                                                                                            |
-
-**footer 作用域插槽参数说明**
-
-| 作用域插槽参数 | 说明                 | 类型                                                                                                                                                                                    | 默认值  |
-| -------------- | -------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- |
-| `isShowUnfold` | 多余搜索表单展开情况 | `boolean`                                                                                                                                                                               | `false` |
-| `handleReset`  | 执行重置按钮方法     | `function` <docs-tip content="()=> void"></docs-tip>                                                                                                                                    |         |
-| `handleSearch` | 执行搜索按钮方法     | `function` <docs-tip content="()=> void"></docs-tip> /<el-tag>v0.1.15</el-tag> 版本新增 `needValidate`,开启后类型为 `async function` <docs-tip content="()=> Promise<void>"></docs-tip> |         |
-| `handleUnfold` | 执行展开按钮方法     | `function` <docs-tip content="()=> void"></docs-tip>                                                                                                                                    |         |
-
-## Exposes
-
-| 名称               | 说明                                   | 类型                                                                                                                                                                                    |
-| ------------------ | -------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `plusFormInstance` | [PlusForm](/components/form.html) 实例 | `object` <docs-tip content="PlusFormInstance"></docs-tip>                                                                                                                               |
-| `handleReset`      | 执行重置按钮方法                       | `function` <docs-tip content="()=> void"></docs-tip>                                                                                                                                    |
-| `handleSearch`     | 执行搜索按钮方法                       | `function` <docs-tip content="()=> void"></docs-tip> /<el-tag>v0.1.15</el-tag> 版本新增 `needValidate`,开启后类型为 `async function` <docs-tip content="()=> Promise<void>"></docs-tip> |
-| `handleUnfold`     | 执行展开按钮方法                       | `function` <docs-tip content="()=> void"></docs-tip>                                                                                                                                    |
-
-::: tip 提示
-拿到 plusFormInstance 中的 formInstance 可以支持所有[PlusFrom 方法](/components/form.html)，
-如 `validate`,`validateField`等
-:::

package/docs/components/sidebar.md

@@ -1,140 +0,0 @@
-# Sidebar 侧边栏
-
-## 简介
-
-PlusSidebar 侧边栏，根据路由信息支持多级展示，可自定义展示。
-
-## 基础用法
-
-:::demo
-
-sidebar/basic
-
-:::
-
-## 横向用法
-
-:::demo
-
-sidebar/horizontal
-
-:::
-
-## 外链
-
-路由信息的`path`给 `/+ 链接` 例： `/https://plus-pro-components.com` 。路由信息配置[ PlusRouteRecordRaw](/components/type.html#plusrouterecordraw)
-
-:::demo
-
-sidebar/external
-
-:::
-
-## 在菜单中不显示某一级
-
-路由信息的`meta` 中添加 `hideInMenu: true`即可。路由信息配置[ PlusRouteRecordRaw](/components/type.html#plusrouterecordraw)
-
-:::demo
-
-sidebar/hidden
-
-:::
-
-## 自定义菜单 icon
-
-路由信息的`meta.icon`支持组件，函数和 VNode。可以支持图片 icon，el-icon，Svg icon，Symbol svg icon, Iconfont icon，Font-awesome icon 等几乎所有常见 icon。 路由信息配置[ PlusRouteRecordRaw](/components/type.html#plusrouterecordraw)
-
-:::demo
-
-sidebar/icon
-
-:::
-
-## 自定义菜单头部区域
-
-自定义菜单头部区域 支持 `renderMenuExtra`渲染函数 和`sidebar-extra`插槽， `renderMenuExtra` 优先级高于 插槽。
-
-:::demo
-
-sidebar/extra
-
-:::
-
-## 自定义菜单显示 (renderTitle)
-
-:::warning 注意
-**render 函数的优先级高于插槽**
-:::
-
-:::demo
-
-sidebar/render-menu-item-title
-
-:::
-
-## 自定义菜单显示 (jsx/tsx)
-
-:::demo
-
-sidebar/menu-item-title-tsx
-
-:::
-
-## 自定义菜单显示 (插槽)
-
-:::warning 注意
-**插槽优先级低于 render**
-:::
-
-:::demo
-
-sidebar/menu-item-title-slots
-
-:::
-
-## Sidebar API
-
-## Sidebar Attributes
-
-| 名称                                                                                                                             | 说明                     | 类型                                                                                    | 默认值  | 是否必须 |
-| -------------------------------------------------------------------------------------------------------------------------------- | ------------------------ | --------------------------------------------------------------------------------------- | ------- | -------- |
-| `routes`                                                                                                                         | 侧边栏的路由信息         | `array` [PlusRouteRecordRaw[]](/components/type.html#plusrouterecordraw)                | `[]`    | 否       |
-| `collapse/v-model:collapse`                                                                                                      | 侧边栏闭合               | `boolean`                                                                               | `false` | 否       |
-| <el-text tag="del">`width`</el-text> <el-tag type="danger">deprecated v0.1.20</el-tag>(使用`css`变量`--plus-sidebar-width` 代替) | 侧边栏不闭合时的宽度     | `number / string`                                                                       | `200`   | 否       |
-| `renderTitle`                                                                                                                    | 自定义菜单每项标题显示   | `function` <docs-tip content='(route:PlusRouteRecordRaw) => VNode / string'></docs-tip> |         | 否       |
-| `renderMenuItem`                                                                                                                 | 自定义 菜单的 menuItem   | `function` <docs-tip content='(route:PlusRouteRecordRaw) => VNode / string'></docs-tip> |         | 否       |
-| `renderSubMenuItem`                                                                                                              | 自定义 菜单的 subMenu    | `function` <docs-tip content='(route:PlusRouteRecordRaw) => VNode / string'></docs-tip> |         | 否       |
-| `renderMenuExtra`                                                                                                                | 自定义在菜单头和菜单之间 | `function` <docs-tip content='(route:PlusRouteRecordRaw) => VNode / string'></docs-tip> |         | 否       |
-| ...                                                                                                                              | ...                      | ...                                                                                     | ...     | ...      |
-
-:::tip 提示
-**`...`表示同时支持所有 [el-menu](https://element-plus.org/zh-CN/component/menu.html#menu-attributes) Attributes**
-:::
-
-## Sidebar Events
-
-| 名称                                    | 说明                                                                                 | 类型                                                                                                                              |
-| --------------------------------------- | ------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------- |
-| `toggleCollapse`                        | 侧边栏闭合（开启）时触发                                                             | `function` <docs-tip content='(collapse:boolean) => void'></docs-tip>                                                             |
-| `clickMenuItem`<el-tag>v0.1.23</el-tag> | 自定义点击菜单每一项的事件，**当此事件存在时原有的点击菜单路由跳转的事件将会失效**。 | `function` <docs-tip content='(item: PlusRouteRecordRaw, parent: PlusRouteRecordRaw \| PlusRouteRecordRaw[]) => void'></docs-tip> |
-
-## Sidebar Slots
-
-| 插槽名               | 说明                     | 作用域插槽参数                                                       |
-| -------------------- | ------------------------ | -------------------------------------------------------------------- |
-| `sidebar-item`       | 自定义菜单的 menuItem    | route [PlusRouteRecordRaw](/components/type.html#plusrouterecordraw) |
-| `sidebar-sub`        | 自定义菜单的 subMenu     | route [PlusRouteRecordRaw](/components/type.html#plusrouterecordraw) |
-| `sidebar-item-title` | 自定义菜单每项标题显示   | route [PlusRouteRecordRaw](/components/type.html#plusrouterecordraw) |
-| `sidebar-extra`      | 自定义在菜单头和菜单之间 | route [PlusRouteRecordRaw](/components/type.html#plusrouterecordraw) |
-
-:::warning 注意
-**render 函数的优先级高于插槽**
-:::
-
-## Exposes
-
-| 名称                  | 说明           | 类型                                               |
-| --------------------- | -------------- | -------------------------------------------------- |
-| `collapse`            | 侧边栏闭合状态 | `boolean`                                          |
-| `toggleCollapse`      | 切换侧边栏     | `function`<docs-tip content='()=>void'></docs-tip> |
-| `plusSidebarInstance` | el-menu 的实例 | `object`                                           |

package/docs/components/steps-form.md

@@ -1,97 +0,0 @@
-# StepsForm 分步表单
-
-StepsForm 组件是 [ElSteps,ElStep](https://element-plus.org/zh-CN/component/steps.html)和 [PlusForm](/components/form.html) 组件的组合，支持 [PlusForm](/components/form.html) 组件的所有自定义函数和插槽，
-它的主要用途是引导用户按照流程完成任务的分步导航条， 可根据实际应用场景设定步骤，步骤不得少于 2 步。
-
-## 基础用法
-
-设置 `active` 属性，接受一个 `Number`，表明步骤，从 1 开始。`data` 是分步表单所需的数据。
-
-:::demo
-
-steps-form/basic
-
-:::
-
-## 垂直的分步表单
-
-垂直方向的分步表单。
-
-只需要设置 direction 属性为 vertical 即可。
-:::demo
-
-steps-form/vertical-stepsform
-
-:::
-
-## 带图标的分步表单
-
-通过 icon 属性来设置图标， 图标的类型可以参考 Icon 组件的文档。
-:::demo
-
-steps-form/icon-stepsform
-
-:::
-
-## 简洁风格的分步表单
-
-设置 simple 可应用简洁风格，该条件下 align-center / description / direction / space 都将失效。
-:::demo
-
-steps-form/simple
-
-:::
-
-## 插槽渲染分步表单头部
-
-设置 simple 可应用简洁风格，该条件下 align-center / description / direction / space 都将失效。
-:::demo
-
-steps-form/slots
-
-:::
-
-## 插槽渲染分步表单每一步内容
-
-<el-tag>v0.1.22</el-tag> 新增
-
-设置 step-\* 可应用自定义插槽渲染每一步内容，\*表示的是步骤数，从 1 开始。
-
-:::demo
-
-steps-form/step-slots
-
-:::
-
-## StepsForm API
-
-## StepsForm Attributes
-
-| 名称                                  | 说明                   | 类型                                                               | 默认值   | 是否必须                                      |
-| ------------------------------------- | ---------------------- | ------------------------------------------------------------------ | -------- | --------------------------------------------- |
-| `model-value / v-model`               | 分步表单绑定的第几步值 | `number`                                                           | `1`      | 否 (<el-tag>v0.1.14</el-tag> 版本前是 `必须`) |
-| `data`                                | 分步表单展示的数据     | `array` [PlusStepFromRow[]](/components/type.html#plusstepfromrow) | `[]`     | 否 (<el-tag>v0.1.14</el-tag> 版本前是 `必须`) |
-| `submitText` <el-tag>v0.1.14</el-tag> | 提交按钮文字           | `string`                                                           | `提交`   | 否                                            |
-| `nextText` <el-tag>v0.1.14</el-tag>   | 下一步按钮文字         | `string`                                                           | `下一步` | 否                                            |
-| `preText` <el-tag>v0.1.14</el-tag>    | 上一步按钮文字         | `string`                                                           | `上一步` | 否                                            |
-| ...                                   | ...                    | ...                                                                | ...      | ...                                           |
-
-`...`表示同时支持所有 [ElSteps Attributes](https://element-plus.org/zh-CN/component/steps.html#steps-%E5%B1%9E%E6%80%A7)
-
-## StepsForm Events
-
-| 名称                              | 说明                                         | 类型                                                                                                                                                           |
-| --------------------------------- | -------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `change`                          | 表单变化触发的事件                           | `function` <docs-tip content='(values: FieldValues,column: PlusColumn) => void'></docs-tip>                                                                    |
-| `pre`                             | 点击`上一步`按钮触发的事件                   | `function` <docs-tip content='(active: number) => void'></docs-tip>                                                                                            |
-| `next`                            | 点击`下一步`（`提交`）按钮校验通过触发的事件 | `function` <docs-tip content='(active: number, values: FieldValues, allValues: FieldValues) => void'></docs-tip> `allValues`参数为<el-tag>v0.1.23</el-tag>新增 |
-| `submit` <el-tag>v0.1.23</el-tag> | 点击`提交`按钮触发的事件                     | `function` <docs-tip content='(active: number, values: FieldValues, allValues: FieldValues) => void'></docs-tip>                                               |
-
-## StepsForm Slots
-
-| 插槽名                           | 说明                                          | 作用域插槽参数                                                                                  |
-| -------------------------------- | --------------------------------------------- | ----------------------------------------------------------------------------------------------- |
-| step-\* <el-tag>v0.1.22</el-tag> | 每一步内容的插槽，\*表示的是步骤数，从 1 开始 | `{title,form,description,icon,status}` [PlusStepFromRow](/components/type.html#plusstepfromrow) |
-| ...                              | ...                                           | ...                                                                                             |
-
-`...`表示同时支持所有 [ElStep](https://element-plus.org/zh-CN/component/steps.html#step-%E6%8F%92%E6%A7%BD) 的其他插槽 如 `icon, title, description `