diff --git a/src/guide/README.en-US.md b/src/guide/README.en-US.md index c211b3562..7c9ad57f7 100644 --- a/src/guide/README.en-US.md +++ b/src/guide/README.en-US.md @@ -10,7 +10,9 @@ style | Object | - | CSS(Cascading Style Sheets) | N custom-style | Object | - | CSS(Cascading Style Sheets),used to set style on virtual component | N back-button-props | Object | - | Typescript:`ButtonProps` | N current | Number | - | \- | N +default-current | Number | undefined | uncontrolled property | N finish-button-props | Object | - | Typescript:`ButtonProps` | N +hide-back | Boolean | false | \- | N hide-counter | Boolean | false | \- | N hide-skip | Boolean | false | \- | N highlight-padding | Number | 16 | \- | N @@ -31,6 +33,7 @@ change | `(current: number, context?: { total: number })` | \- finish | `(detail: { current: number, total: number })` | \- next-step-click | `(detail: { next: number, current: number, total: number })` | \- skip | `(detail: { current: number, total: number })` | \- + ### Guide External Classes className | Description @@ -58,7 +61,7 @@ finish-button-props | Object | - | Typescript:`ButtonProps` | N highlight-padding | Number | - | \- | N mode | String | - | options: popover/dialog | N next-button-props | Object | - | Typescript:`ButtonProps` | N -offset | Array | - | this api is in discussing. do not use it.。Typescript:`Array` | N +offset | Array | - | this api is in discussing. do not use it。Typescript:`Array` | N placement | String | 'top' | Typescript:`StepPopoverPlacement ` `type StepPopoverPlacement = 'top'\|'left'\|'right'\|'bottom'\|'top-left'\|'top-right'\|'bottom-left'\|'bottom-right'\|'left-top'\|'left-bottom'\|'right-top'\|'right-bottom'\|'center'`。[see more ts definition](https://github.com/Tencent/tdesign-miniprogram/tree/develop/src/guide/type.ts) | N show-overlay | Boolean | true | \- | N skip-button-props | Object | - | Typescript:`ButtonProps` | N diff --git a/src/guide/README.md b/src/guide/README.md index b16668641..dc879efaa 100644 --- a/src/guide/README.md +++ b/src/guide/README.md @@ -56,9 +56,11 @@ isComponent: true -- | -- | -- | -- | -- style | Object | - | 样式 | N custom-style | Object | - | 样式,一般用于开启虚拟化组件节点场景 | N -back-button-props | Object | - | 透传 返回 的全部属性,示例:`{ content: '返回', theme: 'default' }`。TS 类型:`ButtonProps` | N +back-button-props | Object | - | 透传 返回按钮 的全部属性,示例:`{ content: '返回', theme: 'default' }`。TS 类型:`ButtonProps` | N current | Number | - | 当前步骤,即整个引导的进度。-1 则不展示,用于需要中断展示的场景 | N -finish-button-props | Object | - | 透传 完成 的全部属性,示例:`{ content: '完成', theme: 'primary' }`。TS 类型:`ButtonProps` | N +default-current | Number | undefined | 当前步骤,即整个引导的进度。-1 则不展示,用于需要中断展示的场景。非受控属性 | N +finish-button-props | Object | - | 透传 完成按钮 的全部属性,示例:`{ content: '完成', theme: 'primary' }`。TS 类型:`ButtonProps` | N +hide-back | Boolean | false | 是否隐藏返回按钮 | N hide-counter | Boolean | false | 是否隐藏计数 | N hide-skip | Boolean | false | 是否隐藏跳过按钮 | N highlight-padding | Number | 16 | 高亮框的内边距,单位rpx | N @@ -66,7 +68,7 @@ mode | String | popover | 引导框的类型。可选项:popover/dialog | N next-button-props | Object | - | 透传 下一步按钮 的全部属性,示例:{ content: '下一步', theme: 'primary' }。TS 类型:`ButtonProps`,[Button API Documents](./button?tab=api)。[详细类型定义](https://github.com/Tencent/tdesign-miniprogram/tree/develop/src/guide/type.ts) | N show-overlay | Boolean | true | 是否出现遮罩层 | N skip-button-props | Object | - | 透传 跳过按钮 的全部属性,{ content: '跳过', theme: 'default' }。TS 类型:`ButtonProps` | N -steps | Array | - | 用于定义每个步骤的内容,包括高亮的节点、相对位置和具体的文案内容等。。TS 类型:`Array` | N +steps | Array | - | 用于定义每个步骤的内容,包括高亮的节点、相对位置和具体的文案内容等。TS 类型:`Array` | N using-custom-navbar | Boolean | false | 是否使用了自定义导航栏 | N z-index | Number | 999999 | 提示框的层级 | N @@ -79,6 +81,7 @@ change | `(current: number, context?: { total: number })` | 当前步骤发生 finish | `(detail: { current: number, total: number })` | 点击完成按钮时触发 next-step-click | `(detail: { next: number, current: number, total: number })` | 点击下一步时触发 skip | `(detail: { current: number, total: number })` | 点击跳过按钮时触发 + ### Guide External Classes 类名 | 描述 diff --git a/src/guide/content.wxml b/src/guide/content.wxml index b0d07bb9d..0b7030ad8 100644 --- a/src/guide/content.wxml +++ b/src/guide/content.wxml @@ -8,9 +8,12 @@ {{body}} - +