docs(overlay,popup,calendar,cascader): 校正props描述信息

xiaohe0601 · xiaohe0601 · commit 56b9e8a19ee6 · 2024-09-25T10:20:56.000+08:00
diff --git a/docs/components/basic/overlay.md b/docs/components/basic/overlay.md
@@ -109,15 +109,16 @@ const overlayStyles = {
 
 ### Props
 
-| 参数                     | 说明              | 类型               | 默认值     |
-|------------------------|-----------------|------------------|---------|
-| v-model:visible        | 控制遮罩的显示/隐藏      | boolean          | `false` |
-| z-index                | 自定义遮罩层级         | string \| number | -       |
-| duration               | 显示/隐藏的动画时长，单位毫秒 | string \| number | `300`   |
-| overlay-class          | 自定义遮罩类名         | string           | -       |
-| overlay-style          | 自定义遮罩样式         | CSSProperties    | -       |
-| lock-scroll `H5`       | 遮罩显示时的背景是否锁定    | boolean          | `true`  |
-| close-on-click-overlay | 点击遮罩时是否关闭       | boolean          | `true`  |
+| 参数                     | 说明                   | 类型              | 默认值     |
+|------------------------|----------------------|-----------------|---------|
+| v-model:visible        | 控制遮罩的显示/隐藏           | boolean         | `false` |
+| z-index                | 自定义遮罩层级              | number          | -       |
+| duration               | 显示/隐藏的动画时长，单位毫秒      | string / number | `300`   |
+| overlay-class          | 自定义遮罩类名              | string          | -       |
+| overlay-style          | 自定义遮罩样式              | `CSSProperties` | -       |
+| lock-scroll `H5`       | 遮罩显示时的背景是否锁定         | boolean         | `false` |
+| close-on-click-overlay | 点击遮罩时是否关闭            | boolean         | `true`  |
+| destroy-on-close       | 弹层关闭后 `slot` 内容会不会清空 | boolean         | `false` |
 
 ### Events
 
diff --git a/docs/components/basic/popup.md b/docs/components/basic/popup.md
@@ -142,30 +142,28 @@
 
 ## API
 
-> 当前组件内部透传了 [Icon组件](/components/basic/icon) 和 [Overlay组件](/components/basic/overlay)
-
 ### Props
 
-| 参数                     | 说明                                                    | 类型               | 默认值           |
-|------------------------|-------------------------------------------------------|------------------|---------------|
-| v-model:visible        | 控制当前组件显示/隐藏                                           | boolean          | `false`       |
-| z-index                | 遮罩层级                                                  | string \| number | `2000+`       |
-| duration               | 组件显示/隐藏的动画时长，单位秒                                      | string \| number | `0.3`         |
-| lock-scroll  `H5`      | 背景是否锁定                                                | boolean          | `true`        |
-| overlay                | 是否显示遮罩                                                | boolean          | `true`        |
-| close-on-click-overlay | 是否点击遮罩关闭                                              | boolean          | `true`        |
-| position               | 弹出位置（top,bottom,left,right,center）                    | string           | `"center"`    |
-| transition             | 动画名                                                   | string           | -             |
-| custom-style           | 自定义弹框样式                                               | CSSProperties    | -             |
-| pop-class              | 自定义弹框类名                                               | string           | -             |
-| closeable              | 是否显示关闭按钮                                              | boolean          | `false`       |
-| close-icon-position    | 关闭按钮位置（top-left,top-right,bottom-left,bottom-right）   | string           | `"top-right"` |
-| close-icon             | [图标名称](/components/basic/icon) 或图片链接                  | string           | `"close"`     |
-| destroy-on-close       | 弹层关闭后 `slot`内容会不会清空                                   | boolean          | `true`        |
-| round                  | 是否显示圆角                                                | boolean          | `false`       |
-| overlay-class          | 自定义遮罩层类名                                              | string           | ''            |
-| overlay-style          | 自定义遮罩层样式                                              | string           | ''            |
-| safe-area-inset-bottom | 是否开启 iphone 系列全面屏底部安全区适配,仅当 `position` 为 `bottom` 时有效 | boolean          | `false`       |
+| 参数                     | 说明                                                    | 类型              | 默认值       |
+|------------------------|-------------------------------------------------------|-----------------|-----------|
+| v-model:visible        | 控制当前组件显示/隐藏                                           | boolean         | `false`   |
+| position               | 弹出位置（top,bottom,left,right,center）                    | string          | center    |
+| transition             | 动画名                                                   | string          | -         |
+| pop-class              | 自定义弹框类名                                               | string          | -         |
+| round                  | 是否显示圆角                                                | boolean         | `false`   |
+| closeable              | 是否显示关闭按钮                                              | boolean         | `false`   |
+| close-icon             | [图标名称](/components/basic/icon) 或图片链接                  | string          | close     |
+| close-icon-position    | 关闭按钮位置（top-left,top-right,bottom-left,bottom-right）   | string          | top-right |
+| destroy-on-close       | 弹层关闭后 `slot`内容会不会清空                                   | boolean         | `true`    |
+| overlay                | 是否显示遮罩                                                | boolean         | `true`    |
+| safe-area-inset-bottom | 是否开启 iphone 系列全面屏底部安全区适配,仅当 `position` 为 `bottom` 时有效 | boolean         | `false`   |
+| safe-area-inset-top    | 是否开启 iPhone 顶部安全区适配,仅当 `position` 为 `top` 时有效         | boolean         | `true`    |
+| z-index                | 遮罩层级                                                  | number          | `2000+`   |
+| duration               | 组件显示/隐藏的动画时长，单位毫秒                                     | string / number | `300`     |
+| overlay-class          | 自定义遮罩层类名                                              | string          | -         |
+| overlay-style          | 自定义遮罩层样式                                              | `CSSProperties` | -         |
+| lock-scroll  `H5`      | 背景是否锁定                                                | boolean         | `false`   |
+| close-on-click-overlay | 是否点击遮罩关闭                                              | boolean         | `true`    |
 
 ### Events
 
diff --git a/docs/components/dentry/calendar.md b/docs/components/dentry/calendar.md
@@ -787,25 +787,42 @@ export default {
 | 参数                    | 说明                                                   | 类型                  | 默认值          |
 |-----------------------|------------------------------------------------------|---------------------|--------------|
 | v-model:visible       | 是否可见                                                 | boolean             | `false`      |
-| type                  | 类型，日期单择`one`，区间选择`range`,日期多选`multiple`,周选择`week`    | string              | '`one`'      |
+| type                  | 类型，日期单择`one`，区间选择`range`,日期多选`multiple`,周选择`week`    | string              | one          |
 | poppable              | 是否弹窗状态展示                                             | boolean             | `true`       |
 | is-auto-back-fill     | 自动回填                                                 | boolean             | `false`      |
-| title                 | 显示标题                                                 | string              | `日期选择`       |
-| default-value         | 默认值，单个日期选择 `string`，其他为 `string[]`                   | string  \| string[] | `null`       |
+| title                 | 显示标题                                                 | string              | 日期选择         |
+| default-value         | 默认值，单个日期选择 `string`，其他为 `string[]`                   | string  \| string[] | -            |
 | start-date            | 开始日期                                                 | string              | `今天`         |
 | end-date              | 结束日期                                                 | string              | `距离今天 365 天` |
+| start-text            | 范围选择，开始信息文案                                          | string              | 开始           |
+| end-text              | 范围选择，结束信息文案                                          | string              | 结束           |
+| confirm-text          | 底部确认按钮文案                                             | string              | 确认           |
 | show-today            | 是否展示今天标记                                             | boolean             | `true`       |
-| start-text            | 范围选择，开始信息文案                                          | string              | `开始`         |
-| end-text              | 范围选择，结束信息文案                                          | string              | `结束`         |
-| confirm-text          | 底部确认按钮文案                                             | string              | `确认`         |
 | show-title            | 是否在展示日历标题                                            | boolean             | `true`       |
 | show-sub-title        | 是否展示日期标题                                             | boolean             | `true`       |
 | to-date-animation     | 是否启动滚动动画                                             | boolean             | `true`       |
 | first-day-of-week     | 设置周起始日                                               | 0-6                 | `0`          |
-| disabled-date `1.4.0` | 一个用来判断该日期是否被禁用的函数，接受一个`年-月-日`作为参数。 应该返回一个 Boolean 值。 | function            | `-`          |
+| disabled-date `1.4.0` | 一个用来判断该日期是否被禁用的函数，接受一个`年-月-日`作为参数。 应该返回一个 Boolean 值。 | function            | -            |
 | footer-slot `1.4.0`   | 是否使用footer插槽，如果使用，此值必须为 true                         | boolean             | `false`      |
 | btn-slot `1.5.7`      | 是否使用btn插槽，如果使用，此值必须为 true                            | boolean             | `false`      |
 | pop-style `1.8.0`     | 自定义弹窗样式                                              | `CSSProperties`     | -            |
+| lock-scroll  `H5`     | 背景是否锁定                                               | boolean             | `true`       |
+
+::: details 弹窗状态属性
+当 `poppable` 为 `true` 时，继承了 [Popup](/components/basic/popup) 的以下属性
+
+| 参数                     | 说明                                                  | 类型              | 默认值       |
+|------------------------|-----------------------------------------------------|-----------------|-----------|
+| pop-class              | 自定义弹框类名                                             | string          | -         |
+| closeable              | 是否显示关闭按钮                                            | boolean         | `false`   |
+| close-icon             | [图标名称](/components/basic/icon) 或图片链接                | string          | close     |
+| close-icon-position    | 关闭按钮位置（top-left,top-right,bottom-left,bottom-right） | string          | top-right |
+| overlay                | 是否显示遮罩                                              | boolean         | `true`    |
+| z-index                | 遮罩层级                                                | number          | `2000+`   |
+| overlay-class          | 自定义遮罩层类名                                            | string          | -         |
+| overlay-style          | 自定义遮罩层样式                                            | `CSSProperties` | -         |
+| close-on-click-overlay | 是否点击遮罩关闭                                            | boolean         | `true`    |
+:::
 
 ### Events
 
diff --git a/docs/components/dentry/cascader.md b/docs/components/dentry/cascader.md
@@ -344,26 +344,41 @@ export default {
 
 ### Props
 
-| 参数                     | 说明                                 | 类型               | 默认值           |
-|------------------------|------------------------------------|------------------|---------------|
-| v-model                | 选中值，双向绑定                           | Array            | -             |
-| v-model:visible        | 显示选择层                              | boolean          | `false`       |
-| options                | 级联数据                               | Array            | -             |
-| lazy                   | 是否开启动态加载                           | boolean          | -             |
-| lazy-load              | 动态加载回调，开启动态加载时生效                   | Function         | -             |
-| value-key              | 自定义 `options` 结构中 `value` 的字段      | string           | -             |
-| text-key               | 自定义 `options` 结构中 `text` 的字段       | string           | -             |
-| children-key           | 自定义 `options` 结构中 `children` 的字段   | string           | -             |
-| convert-config         | 当 `options` 为可转换为树形结构的扁平结构时，配置转换规则 | object           | -             |
-| title                  | 标题                                 | string           | `''`          |
-| close-icon-position    | 取消按钮位置，继承 `Popup` 组件               | string           | `"top-right"` |
-| closeable              | 是否显示关闭按钮，继承 `Popup` 组件             | boolean          | `false`       |
-| poppable               | 是否需要弹层展示（设置为 `false` 后，`title` 失效） | boolean          | `true`        |
-| title-gutter `1.1.7`   | 标签间隙                               | number \| string | `0`           |
-| title-size `1.1.7`     | 标签栏字体尺寸大小 可选值  large normal small  | string           | `normal`      |
-| title-ellipsis `1.1.7` | 是否省略过长的标题文字                        | boolean          | `true`        |
-| title-type `1.1.7`     | 选中底部展示样式 可选值 line、smile            | string           | `line`        |
-| pop-style `1.8.0`      | 自定义弹窗样式                            | `CSSProperties`  | -             |
+| 参数                     | 说明                                 | 类型              | 默认值      |
+|------------------------|------------------------------------|-----------------|----------|
+| v-model                | 选中值，双向绑定                           | Array           | -        |
+| v-model:visible        | 显示选择层                              | boolean         | `false`  |
+| options                | 级联数据                               | Array           | -        |
+| lazy                   | 是否开启动态加载                           | boolean         | `false`  |
+| lazy-load              | 动态加载回调，开启动态加载时生效                   | Function        | -        |
+| value-key              | 自定义 `options` 结构中 `value` 的字段      | string          | value    |
+| text-key               | 自定义 `options` 结构中 `text` 的字段       | string          | text     |
+| children-key           | 自定义 `options` 结构中 `children` 的字段   | string          | children |
+| convert-config         | 当 `options` 为可转换为树形结构的扁平结构时，配置转换规则 | object          | -        |
+| poppable               | 是否需要弹层展示（设置为 `false` 后，`title` 失效） | boolean         | `true`   |
+| title                  | 标题                                 | string          | -        |
+| title-type `1.1.7`     | 选中底部展示样式 可选值 line、smile            | string          | line     |
+| title-size `1.1.7`     | 标签栏字体尺寸大小 可选值  large normal small  | string          | normal   |
+| title-gutter `1.1.7`   | 标签间隙                               | number / string | `0`      |
+| title-ellipsis `1.1.7` | 是否省略过长的标题文字                        | boolean         | `true`   |
+| pop-style `1.8.0`      | 自定义弹窗样式                            | `CSSProperties` | -        |
+| lock-scroll  `H5`      | 背景是否锁定                             | boolean         | `true`   |
+
+::: details 弹窗状态属性
+当 `poppable` 为 `true` 时，继承了 [Popup](/components/basic/popup) 的以下属性
+
+| 参数                     | 说明                                                  | 类型              | 默认值       |
+|------------------------|-----------------------------------------------------|-----------------|-----------|
+| pop-class              | 自定义弹框类名                                             | string          | -         |
+| closeable              | 是否显示关闭按钮                                            | boolean         | `false`   |
+| close-icon             | [图标名称](/components/basic/icon) 或图片链接                | string          | close     |
+| close-icon-position    | 关闭按钮位置（top-left,top-right,bottom-left,bottom-right） | string          | top-right |
+| overlay                | 是否显示遮罩                                              | boolean         | `true`    |
+| z-index                | 遮罩层级                                                | number          | `2000+`   |
+| overlay-class          | 自定义遮罩层类名                                            | string          | -         |
+| overlay-style          | 自定义遮罩层样式                                            | `CSSProperties` | -         |
+| close-on-click-overlay | 是否点击遮罩关闭                                            | boolean         | `true`    |
+:::
 
 ### Events
 
