From 7e1e32a1f6de807ccdf8bb0f430c95be24532cd0 Mon Sep 17 00:00:00 2001 From: Lyan-u Date: Thu, 29 Feb 2024 09:07:11 +0000 Subject: [PATCH] feat(Guide): new component for mobile-vue --- db/TDesign.db | Bin 868352 -> 868352 bytes .../products/tdesign-mobile-vue/src/common.ts | 6 +- .../src/guide/guide.en-US.md | 56 +++ .../tdesign-mobile-vue/src/guide/guide.md | 56 +++ .../tdesign-mobile-vue/src/guide/props.ts | 86 ++++ .../tdesign-mobile-vue/src/guide/type.ts | 174 +++++++ packages/scripts/api.json | 436 ++++++++++++++++-- 7 files changed, 764 insertions(+), 50 deletions(-) create mode 100644 packages/products/tdesign-mobile-vue/src/guide/guide.en-US.md create mode 100644 packages/products/tdesign-mobile-vue/src/guide/guide.md create mode 100644 packages/products/tdesign-mobile-vue/src/guide/props.ts create mode 100644 packages/products/tdesign-mobile-vue/src/guide/type.ts diff --git a/db/TDesign.db b/db/TDesign.db index b5fd0846f39fc18aa790c30cc2c2bae03cb922e6..ff2cd5ff11099dd5a67b26feaeadb734a2f160a5 100644 GIT binary patch delta 1525 zcmaJ=e{2&~9PhPV-@CisHDp5Fy0`;11xCa5+U`f~fQVsgqAnOQY$G`wH$m81YiF`V z+}&82GmCC^@)V5DzciAd|FDY1kP!bcN(>|t60*#}`eTJ9kTDgfb-w$Nwz|bXF7Lh1 zd++=C@qH)D0a*@=x`?T?T zfBzK_>iUo0fDho&^EZh4@i-wsO1=3U4@VJZvz-uN6dI(jH9~)si zu7K_|!x^1pdK=t8poS1!PdJA5h9LgPWlNp>B( zndMk}a=~oRQ-mK)F?PO{v{=p3Ov_PvUYq^$*F1e&pB3EnEn{Y*^V;lcdmTNe&)O1n zPTyUcrn3fijm`{pV1^Es`F#DB2MDLh(Zwn(w9nAXbT!pX{y@G6FMzGkX^T}9Dt24H zvQm~4=5fNA@J4cv4D_KRE-O(>){;&}dCUYEpU-s6X(Ay5852}xLgdeYC;IQ4AK92r z#WUX~II%l?KoYt1*WYkrBpeC9E=5Hyizaj9pJd;EYm>kWeh)8rgeHz}330sC!l(Q{F^}t5xNX5)7lz zotpCgqHvrlZ0S98KvGK?B2mw?u!c8Cxm;>6otm7L2Q)j)1=8-J8+YxMdyEpT(QxE7?kLw44R>?y9R{kpcon@;rJ7hvGMl`5`lgbH zg1h8F%{-##g|`0*YIYSf#!7^s?_U`kkg@?C(lYX>8C9;VZ-Z#f5_m@XzZPmn1C1+; z1{#%z&_PXo9WLLeSAV#u9>3g@`j_^19!B5a1fKr63*(tnA7@8~^Y5L>ogB;@k7v%D zD;D>1yb#2%#_wANdb~Fl3-@SYDsJ>LcIG73LWbFCf(pRzwv^n}wuH`YR*7>1=Q2Yn zojAc?--zs0w7Xr;PbaJodQ170pcv}H{+zfwu2s6TG_7-#b*8*Q2g@4d6N3Kwq9goY z`0&%gkkWu8)ds01s2C5REW);HI)&<@%stG@@21aBaJnU=gkU8)wE#$T`##0k4Ak)* ZT=!p74MA^HQHJhQh001Nw>B_W;6GID-yHw| delta 410 zcmZo@Fl}fsogmG)Yod%ZVj9fuO* zbaNXHMMn1aNE;3y=G-1>!xh>FRJ{HW*DnJ`_T{TSbFl)stAB8P0s3V7g1=na($fze zU|%%-fC-1*^bIoHGSf^sSf=lmcumii7{rn5HpY3b`EBq%Up~t)9>)|7)(EMncZ^w-h1rg?J;~j+hh26S18KxuV!Z diff --git a/packages/products/tdesign-mobile-vue/src/common.ts b/packages/products/tdesign-mobile-vue/src/common.ts index 689048813..345da9b0e 100644 --- a/packages/products/tdesign-mobile-vue/src/common.ts +++ b/packages/products/tdesign-mobile-vue/src/common.ts @@ -68,6 +68,8 @@ export type HorizontalAlignEnum = 'left' | 'center' | 'right'; export type VerticalAlignEnum = 'top' | 'middle' | 'bottom'; +export type LayoutEnum = 'vertical' | 'horizontal'; + export type ClassName = { [className: string]: any } | ClassName[] | string; export type CSSSelector = string; @@ -119,7 +121,7 @@ export type InfinityScroll = TScroll; export interface ScrollToElementParams { /** 跳转元素下标 */ - index: number; + index?: number; /** 跳转元素距离顶部的距离 */ top?: number; /** 单个元素高度非固定场景下，即 isFixedRowHeight = false。延迟设置元素位置，一般用于依赖不同高度异步渲染等场景，单位：毫秒 */ @@ -128,5 +130,5 @@ export interface ScrollToElementParams { } export interface ComponentScrollToElementParams extends ScrollToElementParams { - key: string | number; + key?: string | number; } diff --git a/packages/products/tdesign-mobile-vue/src/guide/guide.en-US.md b/packages/products/tdesign-mobile-vue/src/guide/guide.en-US.md new file mode 100644 index 000000000..cebfa3e84 --- /dev/null +++ b/packages/products/tdesign-mobile-vue/src/guide/guide.en-US.md @@ -0,0 +1,56 @@ +:: BASE_DOC :: + +## API + +### Guide Props + +name | type | default | description | required +-- | -- | -- | -- | -- +backButtonProps | Object | - | Typescript：`ButtonProps` | N +counter | Slot / Function | - | Typescript：`TNode<{ current: number; total: number }>`。[see more ts definition](https://github.com/Tencent/tdesign-mobile-vue/blob/develop/src/common.ts) | N +current | Number | - | `v-model` and `v-model:current` is supported | N +defaultCurrent | Number | - | uncontrolled property | N +finishButtonProps | Object | - | Typescript：`ButtonProps` | N +hideCounter | Boolean | false | \- | N +hideSkip | Boolean | false | \- | N +highlightPadding | Number | 8 | \- | N +mode | String | popover | options: popover/dialog | N +nextButtonProps | Object | - | Typescript：`ButtonProps`，[Button API Documents](./button?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-mobile-vue/tree/develop/src/guide/type.ts) | N +showOverlay | Boolean | true | \- | N +skipButtonProps | Object | - | Typescript：`ButtonProps` | N +steps | Array | - | Typescript：`Array` | N +zIndex | Number | 999999 | \- | N +onBack | Function | | Typescript：`(context: { e: MouseEvent, current: number, total: number }) => void`
| N +onChange | Function | | Typescript：`(current: number, context?: { e: MouseEvent, total: number }) => void`
| N +onFinish | Function | | Typescript：`(context: { e: MouseEvent, current: number, total: number }) => void`
| N +onNextStepClick | Function | | Typescript：`(context: { e: MouseEvent, next: number, current: number, total: number }) => void`
| N +onSkip | Function | | Typescript：`(context: { e: MouseEvent, current: number, total: number }) => void`
| N + +### Guide Events + +name | params | description +-- | -- | -- +back | `(context: { e: MouseEvent, current: number, total: number })` | \- +change | `(current: number, context?: { e: MouseEvent, total: number })` | \- +finish | `(context: { e: MouseEvent, current: number, total: number })` | \- +next-step-click | `(context: { e: MouseEvent, next: number, current: number, total: number })` | \- +skip | `(context: { e: MouseEvent, current: number, total: number })` | \- + +### GuideStep + +name | type | default | description | required +-- | -- | -- | -- | -- +backButtonProps | Object | - | Typescript：`ButtonProps` | N +body | String / Slot / Function | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-mobile-vue/blob/develop/src/common.ts) | N +content | Slot / Function | - | Typescript：`TNode`。[see more ts definition](https://github.com/Tencent/tdesign-mobile-vue/blob/develop/src/common.ts) | N +element | String / Function | - | required。Typescript：`AttachNode`。[see more ts definition](https://github.com/Tencent/tdesign-mobile-vue/blob/develop/src/common.ts) | Y +highlightContent | Slot / Function | - | Typescript：`TNode`。[see more ts definition](https://github.com/Tencent/tdesign-mobile-vue/blob/develop/src/common.ts) | N +highlightPadding | Number | - | \- | N +mode | String | - | options: popover/dialog | N +nextButtonProps | Object | - | Typescript：`ButtonProps` | 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-mobile-vue/tree/develop/src/guide/type.ts) | N +popoverProps | Object | - | Popover component props if `mode = popover`。Typescript：`PopoverProps`，[Popover API Documents](./popover?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-mobile-vue/tree/develop/src/guide/type.ts) | N +showOverlay | Boolean | true | \- | N +skipButtonProps | Object | - | Typescript：`ButtonProps` | N +title | String / Slot / Function | - | title of current step。Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-mobile-vue/blob/develop/src/common.ts) | N diff --git a/packages/products/tdesign-mobile-vue/src/guide/guide.md b/packages/products/tdesign-mobile-vue/src/guide/guide.md new file mode 100644 index 000000000..ffc36c5d8 --- /dev/null +++ b/packages/products/tdesign-mobile-vue/src/guide/guide.md @@ -0,0 +1,56 @@ +:: BASE_DOC :: + +## API + +### Guide Props + +名称 | 类型 | 默认值 | 说明 | 必传 +-- | -- | -- | -- | -- +backButtonProps | Object | - | 透传 返回 的全部属性，示例：`{ content: '返回', theme: 'default' }`。TS 类型：`ButtonProps` | N +counter | Slot / Function | - | 用于自定义渲染计数部分。TS 类型：`TNode<{ current: number; total: number }>`。[通用类型定义](https://github.com/Tencent/tdesign-mobile-vue/blob/develop/src/common.ts) | N +current | Number | - | 当前步骤，即整个引导的进度。-1 则不展示，用于需要中断展示的场景。支持语法糖 `v-model` 或 `v-model:current` | N +defaultCurrent | Number | - | 当前步骤，即整个引导的进度。-1 则不展示，用于需要中断展示的场景。非受控属性 | N +finishButtonProps | Object | - | 透传 完成 的全部属性，示例：`{ content: '完成', theme: 'primary' }`。TS 类型：`ButtonProps` | N +hideCounter | Boolean | false | 是否隐藏计数 | N +hideSkip | Boolean | false | 是否隐藏跳过按钮 | N +highlightPadding | Number | 8 | 高亮框的内边距 | N +mode | String | popover | 引导框的类型。可选项：popover/dialog | N +nextButtonProps | Object | - | 透传 下一步按钮 的全部属性，示例：{ content: '下一步', theme: 'primary' }。TS 类型：`ButtonProps`，[Button API Documents](./button?tab=api)。[详细类型定义](https://github.com/Tencent/tdesign-mobile-vue/tree/develop/src/guide/type.ts) | N +showOverlay | Boolean | true | 是否出现遮罩层 | N +skipButtonProps | Object | - | 透传 跳过按钮 的全部属性，{ content: '跳过', theme: 'default' }。TS 类型：`ButtonProps` | N +steps | Array | - | 用于定义每个步骤的内容，包括高亮的节点、相对位置和具体的文案内容等。。TS 类型：`Array` | N +zIndex | Number | 999999 | 提示框的层级 | N +onBack | Function | | TS 类型：`(context: { e: MouseEvent, current: number, total: number }) => void`
点击返回按钮时触发 | N +onChange | Function | | TS 类型：`(current: number, context?: { e: MouseEvent, total: number }) => void`
当前步骤发生变化时触发 | N +onFinish | Function | | TS 类型：`(context: { e: MouseEvent, current: number, total: number }) => void`
点击完成按钮时触发 | N +onNextStepClick | Function | | TS 类型：`(context: { e: MouseEvent, next: number, current: number, total: number }) => void`
点击下一步时触发 | N +onSkip | Function | | TS 类型：`(context: { e: MouseEvent, current: number, total: number }) => void`
点击跳过按钮时触发 | N + +### Guide Events + +名称 | 参数 | 描述 +-- | -- | -- +back | `(context: { e: MouseEvent, current: number, total: number })` | 点击返回按钮时触发 +change | `(current: number, context?: { e: MouseEvent, total: number })` | 当前步骤发生变化时触发 +finish | `(context: { e: MouseEvent, current: number, total: number })` | 点击完成按钮时触发 +next-step-click | `(context: { e: MouseEvent, next: number, current: number, total: number })` | 点击下一步时触发 +skip | `(context: { e: MouseEvent, current: number, total: number })` | 点击跳过按钮时触发 + +### GuideStep + +名称 | 类型 | 默认值 | 说明 | 必传 +-- | -- | -- | -- | -- +backButtonProps | Object | - | 用于自定义当前引导框的返回按钮的内容。TS 类型：`ButtonProps` | N +body | String / Slot / Function | - | 当前步骤提示框的内容。TS 类型：`string \| TNode`。[通用类型定义](https://github.com/Tencent/tdesign-mobile-vue/blob/develop/src/common.ts) | N +content | Slot / Function | - | 用户自定义引导弹框的内容，一旦存在，此时除 `placement`、`offset`和`element` 外，其它属性全部失效）。TS 类型：`TNode`。[通用类型定义](https://github.com/Tencent/tdesign-mobile-vue/blob/develop/src/common.ts) | N +element | String / Function | - | 必需。高亮的节点。数据类型为 String 时，会被当作选择器处理，进行节点查询。示例：'#tdesign' 或 () => document.querySelector('#tdesign')。TS 类型：`AttachNode`。[通用类型定义](https://github.com/Tencent/tdesign-mobile-vue/blob/develop/src/common.ts) | Y +highlightContent | Slot / Function | - | 用户自定义的高亮框 (仅当 `mode` 为 `popover` 时生效)。TS 类型：`TNode`。[通用类型定义](https://github.com/Tencent/tdesign-mobile-vue/blob/develop/src/common.ts) | N +highlightPadding | Number | - | 高亮框的内边距 | N +mode | String | - | 引导框的类型。可选项：popover/dialog | N +nextButtonProps | Object | - | 用于自定义当前引导框的下一步按钮的内容。TS 类型：`ButtonProps` | N +offset | Array | - | 【讨论确认中】相对于 placement 的偏移量，示例：[-10, 20] 或 ['10px', '8px']。TS 类型：`Array` | N +placement | String | 'top' | 引导框相对于高亮元素出现的位置，(仅当 `mode` 为 `popover` 时生效)。TS 类型：`StepPopoverPlacement ` `type StepPopoverPlacement = 'top'\|'left'\|'right'\|'bottom'\|'top-left'\|'top-right'\|'bottom-left'\|'bottom-right'\|'left-top'\|'left-bottom'\|'right-top'\|'right-bottom'\|'center'`。[详细类型定义](https://github.com/Tencent/tdesign-mobile-vue/tree/develop/src/guide/type.ts) | N +popoverProps | Object | - | 透传全部属性到 Popover 组件。`mode=popover` 时有效。TS 类型：`PopoverProps`，[Popover API Documents](./popover?tab=api)。[详细类型定义](https://github.com/Tencent/tdesign-mobile-vue/tree/develop/src/guide/type.ts) | N +showOverlay | Boolean | true | 是否出现遮罩层 | N +skipButtonProps | Object | - | 用于自定义当前步骤引导框的跳过按钮的内容。TS 类型：`ButtonProps` | N +title | String / Slot / Function | - | 当前步骤的标题内容。TS 类型：`string \| TNode`。[通用类型定义](https://github.com/Tencent/tdesign-mobile-vue/blob/develop/src/common.ts) | N diff --git a/packages/products/tdesign-mobile-vue/src/guide/props.ts b/packages/products/tdesign-mobile-vue/src/guide/props.ts new file mode 100644 index 000000000..9ec3e7c16 --- /dev/null +++ b/packages/products/tdesign-mobile-vue/src/guide/props.ts @@ -0,0 +1,86 @@ +/* eslint-disable */ + +/** + * 该文件为脚本自动生成文件，请勿随意修改。如需修改请联系 PMC + * */ + +import { TdGuideProps } from './type'; +import { PropType } from 'vue'; + +export default { + /** 透传 返回 的全部属性，示例：`{ content: '返回', theme: 'default' }` */ + backButtonProps: { + type: Object as PropType, + }, + /** 用于自定义渲染计数部分 */ + counter: { + type: Function as PropType, + }, + /** 当前步骤，即整个引导的进度。-1 则不展示，用于需要中断展示的场景 */ + current: { + type: Number, + default: undefined, + }, + modelValue: { + type: Number, + default: undefined, + }, + /** 当前步骤，即整个引导的进度。-1 则不展示，用于需要中断展示的场景，非受控属性 */ + defaultCurrent: { + type: Number, + }, + /** 透传 完成 的全部属性，示例：`{ content: '完成', theme: 'primary' }` */ + finishButtonProps: { + type: Object as PropType, + }, + /** 是否隐藏计数 */ + hideCounter: Boolean, + /** 是否隐藏跳过按钮 */ + hideSkip: Boolean, + /** 高亮框的内边距 */ + highlightPadding: { + type: Number, + default: 8, + }, + /** 引导框的类型 */ + mode: { + type: String as PropType, + default: 'popover' as TdGuideProps['mode'], + validator(val: TdGuideProps['mode']): boolean { + if (!val) return true; + return ['popover', 'dialog'].includes(val); + }, + }, + /** 透传 下一步按钮 的全部属性，示例：{ content: '下一步', theme: 'primary' } */ + nextButtonProps: { + type: Object as PropType, + }, + /** 是否出现遮罩层 */ + showOverlay: { + type: Boolean, + default: true, + }, + /** 透传 跳过按钮 的全部属性，{ content: '跳过', theme: 'default' } */ + skipButtonProps: { + type: Object as PropType, + }, + /** 用于定义每个步骤的内容，包括高亮的节点、相对位置和具体的文案内容等。 */ + steps: { + type: Array as PropType, + }, + /** 提示框的层级 */ + zIndex: { + type: Number, + default: 999999, + }, + /** 点击返回按钮时触发 */ + onBack: Function as PropType, + /** 当前步骤发生变化时触发 */ + onChange: Function as PropType, + /** 点击完成按钮时触发 */ + onFinish: Function as PropType, + /** 点击下一步时触发 */ + onNextStepClick: Function as PropType, + /** 点击跳过按钮时触发 */ + onSkip: Function as PropType, +}; diff --git a/packages/products/tdesign-mobile-vue/src/guide/type.ts b/packages/products/tdesign-mobile-vue/src/guide/type.ts new file mode 100644 index 000000000..dd29efeb7 --- /dev/null +++ b/packages/products/tdesign-mobile-vue/src/guide/type.ts @@ -0,0 +1,174 @@ +/* eslint-disable */ + +/** + * 该文件为脚本自动生成文件，请勿随意修改。如需修改请联系 PMC + * */ + +import { ButtonProps } from '../button'; +import { PopoverProps } from '../popover'; +import { TNode, AttachNode } from '../common'; + +export interface TdGuideProps { + /** + * 透传 返回 的全部属性，示例：`{ content: '返回', theme: 'default' }` + */ + backButtonProps?: ButtonProps; + /** + * 用于自定义渲染计数部分 + */ + counter?: TNode<{ current: number; total: number }>; + /** + * 当前步骤，即整个引导的进度。-1 则不展示，用于需要中断展示的场景 + */ + current?: number; + /** + * 当前步骤，即整个引导的进度。-1 则不展示，用于需要中断展示的场景，非受控属性 + */ + defaultCurrent?: number; + /** + * 当前步骤，即整个引导的进度。-1 则不展示，用于需要中断展示的场景 + */ + modelValue?: number; + /** + * 透传 完成 的全部属性，示例：`{ content: '完成', theme: 'primary' }` + */ + finishButtonProps?: ButtonProps; + /** + * 是否隐藏计数 + * @default false + */ + hideCounter?: boolean; + /** + * 是否隐藏跳过按钮 + * @default false + */ + hideSkip?: boolean; + /** + * 高亮框的内边距 + * @default 8 + */ + highlightPadding?: number; + /** + * 引导框的类型 + * @default popover + */ + mode?: 'popover' | 'dialog'; + /** + * 透传 下一步按钮 的全部属性，示例：{ content: '下一步', theme: 'primary' } + */ + nextButtonProps?: ButtonProps; + /** + * 是否出现遮罩层 + * @default true + */ + showOverlay?: boolean; + /** + * 透传 跳过按钮 的全部属性，{ content: '跳过', theme: 'default' } + */ + skipButtonProps?: ButtonProps; + /** + * 用于定义每个步骤的内容，包括高亮的节点、相对位置和具体的文案内容等。 + */ + steps?: Array; + /** + * 提示框的层级 + * @default 999999 + */ + zIndex?: number; + /** + * 点击返回按钮时触发 + */ + onBack?: (context: { e: MouseEvent; current: number; total: number }) => void; + /** + * 当前步骤发生变化时触发 + */ + onChange?: (current: number, context?: { e: MouseEvent; total: number }) => void; + /** + * 点击完成按钮时触发 + */ + onFinish?: (context: { e: MouseEvent; current: number; total: number }) => void; + /** + * 点击下一步时触发 + */ + onNextStepClick?: (context: { e: MouseEvent; next: number; current: number; total: number }) => void; + /** + * 点击跳过按钮时触发 + */ + onSkip?: (context: { e: MouseEvent; current: number; total: number }) => void; +} + +export interface GuideStep { + /** + * 用于自定义当前引导框的返回按钮的内容 + */ + backButtonProps?: ButtonProps; + /** + * 当前步骤提示框的内容 + */ + body?: string | TNode; + /** + * 用户自定义引导弹框的内容，一旦存在，此时除 `placement`、`offset`和`element` 外，其它属性全部失效） + */ + content?: TNode; + /** + * 高亮的节点。数据类型为 String 时，会被当作选择器处理，进行节点查询。示例：'#tdesign' 或 () => document.querySelector('#tdesign') + */ + element: AttachNode; + /** + * 用户自定义的高亮框 (仅当 `mode` 为 `popover` 时生效) + */ + highlightContent?: TNode; + /** + * 高亮框的内边距 + */ + highlightPadding?: number; + /** + * 引导框的类型 + */ + mode?: 'popover' | 'dialog'; + /** + * 用于自定义当前引导框的下一步按钮的内容 + */ + nextButtonProps?: ButtonProps; + /** + * 【讨论确认中】相对于 placement 的偏移量，示例：[-10, 20] 或 ['10px', '8px'] + */ + offset?: Array; + /** + * 引导框相对于高亮元素出现的位置，(仅当 `mode` 为 `popover` 时生效) + * @default 'top' + */ + placement?: StepPopoverPlacement; + /** + * 透传全部属性到 Popover 组件。`mode=popover` 时有效 + */ + popoverProps?: PopoverProps; + /** + * 是否出现遮罩层 + * @default true + */ + showOverlay?: boolean; + /** + * 用于自定义当前步骤引导框的跳过按钮的内容 + */ + skipButtonProps?: ButtonProps; + /** + * 当前步骤的标题内容 + */ + title?: string | TNode; +} + +export type StepPopoverPlacement = + | 'top' + | 'left' + | 'right' + | 'bottom' + | 'top-left' + | 'top-right' + | 'bottom-left' + | 'bottom-right' + | 'left-top' + | 'left-bottom' + | 'right-top' + | 'right-bottom' + | 'center'; diff --git a/packages/scripts/api.json b/packages/scripts/api.json index 29d1a0e21..10f7c7918 100644 --- a/packages/scripts/api.json +++ b/packages/scripts/api.json @@ -48441,12 +48441,50 @@ "String" ] }, + { + "id": 1708481239, + "platform_framework": [ + "8" + ], + "component": "Guide", + "field_category": 1, + "field_name": "backButtonProps", + "field_type": [ + "8" + ], + "field_default_value": "", + "field_enum": "", + "field_desc_zh": "透传 返回 的全部属性，示例：`{ content: '返回', theme: 'default' }`", + "field_desc_en": null, + "field_required": 0, + "event_input": "", + "create_time": "2024-02-21 02:07:19", + "update_time": "2024-02-21 02:07:19", + "event_output": null, + "custom_field_type": "ButtonProps", + "syntactic_sugar": null, + "readonly": 1, + "html_attribute": 0, + "trigger_elements": "", + "deprecated": 0, + "version": "", + "test_description": null, + "support_default_value": 0, + "field_category_text": "Props", + "platform_framework_text": [ + "Vue(Mobile)" + ], + "field_type_text": [ + "Object" + ] + }, { "id": 2970, "platform_framework": [ "1", "2", - "4" + "4", + "8" ], "component": "Guide", "field_category": 1, @@ -48476,7 +48514,8 @@ "platform_framework_text": [ "Vue(PC)", "React(PC)", - "Angular(PC)" + "Angular(PC)", + "Vue(Mobile)" ], "field_type_text": [ "TNode" @@ -48487,7 +48526,8 @@ "platform_framework": [ "1", "2", - "4" + "4", + "8" ], "component": "Guide", "field_category": 1, @@ -48517,7 +48557,8 @@ "platform_framework_text": [ "Vue(PC)", "React(PC)", - "Angular(PC)" + "Angular(PC)", + "Vue(Mobile)" ], "field_type_text": [ "Number" @@ -48528,7 +48569,8 @@ "platform_framework": [ "1", "2", - "4" + "4", + "8" ], "component": "Guide", "field_category": 1, @@ -48558,7 +48600,8 @@ "platform_framework_text": [ "Vue(PC)", "React(PC)", - "Angular(PC)" + "Angular(PC)", + "Vue(Mobile)" ], "field_type_text": [ "Object" @@ -48569,7 +48612,8 @@ "platform_framework": [ "1", "2", - "4" + "4", + "8" ], "component": "Guide", "field_category": 1, @@ -48599,7 +48643,8 @@ "platform_framework_text": [ "Vue(PC)", "React(PC)", - "Angular(PC)" + "Angular(PC)", + "Vue(Mobile)" ], "field_type_text": [ "Boolean" @@ -48651,7 +48696,8 @@ "platform_framework": [ "1", "2", - "4" + "4", + "8" ], "component": "Guide", "field_category": 1, @@ -48681,7 +48727,8 @@ "platform_framework_text": [ "Vue(PC)", "React(PC)", - "Angular(PC)" + "Angular(PC)", + "Vue(Mobile)" ], "field_type_text": [ "Boolean" @@ -48692,7 +48739,8 @@ "platform_framework": [ "1", "2", - "4" + "4", + "8" ], "component": "Guide", "field_category": 1, @@ -48722,7 +48770,8 @@ "platform_framework_text": [ "Vue(PC)", "React(PC)", - "Angular(PC)" + "Angular(PC)", + "Vue(Mobile)" ], "field_type_text": [ "Number" @@ -48769,12 +48818,50 @@ "String" ] }, + { + "id": 1709177566, + "platform_framework": [ + "8" + ], + "component": "Guide", + "field_category": 1, + "field_name": "mode", + "field_type": [ + "1" + ], + "field_default_value": "popover", + "field_enum": "popover/dialog", + "field_desc_zh": "引导框的类型", + "field_desc_en": null, + "field_required": 0, + "event_input": "", + "create_time": "2024-02-29 03:32:46", + "update_time": "2024-02-29 03:32:46", + "event_output": null, + "custom_field_type": null, + "syntactic_sugar": null, + "readonly": 1, + "html_attribute": 0, + "trigger_elements": "", + "deprecated": 0, + "version": "", + "test_description": null, + "support_default_value": 0, + "field_category_text": "Props", + "platform_framework_text": [ + "Vue(Mobile)" + ], + "field_type_text": [ + "String" + ] + }, { "id": 2969, "platform_framework": [ "1", "2", - "4" + "4", + "8" ], "component": "Guide", "field_category": 1, @@ -48804,7 +48891,8 @@ "platform_framework_text": [ "Vue(PC)", "React(PC)", - "Angular(PC)" + "Angular(PC)", + "Vue(Mobile)" ], "field_type_text": [ "Object" @@ -48856,7 +48944,8 @@ "platform_framework": [ "1", "2", - "4" + "4", + "8" ], "component": "Guide", "field_category": 1, @@ -48886,7 +48975,8 @@ "platform_framework_text": [ "Vue(PC)", "React(PC)", - "Angular(PC)" + "Angular(PC)", + "Vue(Mobile)" ], "field_type_text": [ "Boolean" @@ -48897,7 +48987,8 @@ "platform_framework": [ "1", "2", - "4" + "4", + "8" ], "component": "Guide", "field_category": 1, @@ -48927,7 +49018,8 @@ "platform_framework_text": [ "Vue(PC)", "React(PC)", - "Angular(PC)" + "Angular(PC)", + "Vue(Mobile)" ], "field_type_text": [ "Object" @@ -48938,7 +49030,8 @@ "platform_framework": [ "1", "2", - "4" + "4", + "8" ], "component": "Guide", "field_category": 1, @@ -48968,7 +49061,8 @@ "platform_framework_text": [ "Vue(PC)", "React(PC)", - "Angular(PC)" + "Angular(PC)", + "Vue(Mobile)" ], "field_type_text": [ "Array" @@ -48979,7 +49073,8 @@ "platform_framework": [ "1", "2", - "4" + "4", + "8" ], "component": "Guide", "field_category": 1, @@ -49009,18 +49104,53 @@ "platform_framework_text": [ "Vue(PC)", "React(PC)", - "Angular(PC)" + "Angular(PC)", + "Vue(Mobile)" ], "field_type_text": [ "Number" ] }, + { + "id": 1708481171, + "platform_framework": [ + "8" + ], + "component": "Guide", + "field_category": 2, + "field_name": "back", + "field_type": [], + "field_default_value": "", + "field_enum": "", + "field_desc_zh": "点击返回按钮时触发", + "field_desc_en": null, + "field_required": 0, + "event_input": "(context: { e: MouseEvent, current: number, total: number })", + "create_time": "2024-02-21 02:06:11", + "update_time": "2024-02-21 02:06:11", + "event_output": null, + "custom_field_type": null, + "syntactic_sugar": null, + "readonly": 1, + "html_attribute": 0, + "trigger_elements": "", + "deprecated": 0, + "version": "", + "test_description": null, + "support_default_value": 0, + "field_category_text": "Events", + "platform_framework_text": [ + "Vue(Mobile)" + ], + "field_type_text": [] + }, { "id": 2948, "platform_framework": [ "1", "2", - "4" + "4", + "8" ], "component": "Guide", "field_category": 2, @@ -49048,7 +49178,8 @@ "platform_framework_text": [ "Vue(PC)", "React(PC)", - "Angular(PC)" + "Angular(PC)", + "Vue(Mobile)" ], "field_type_text": [] }, @@ -49057,7 +49188,8 @@ "platform_framework": [ "1", "2", - "4" + "4", + "8" ], "component": "Guide", "field_category": 2, @@ -49085,7 +49217,8 @@ "platform_framework_text": [ "Vue(PC)", "React(PC)", - "Angular(PC)" + "Angular(PC)", + "Vue(Mobile)" ], "field_type_text": [] }, @@ -49094,7 +49227,8 @@ "platform_framework": [ "1", "2", - "4" + "4", + "8" ], "component": "Guide", "field_category": 2, @@ -49122,7 +49256,8 @@ "platform_framework_text": [ "Vue(PC)", "React(PC)", - "Angular(PC)" + "Angular(PC)", + "Vue(Mobile)" ], "field_type_text": [] }, @@ -49168,7 +49303,8 @@ "platform_framework": [ "1", "2", - "4" + "4", + "8" ], "component": "Guide", "field_category": 2, @@ -49196,7 +49332,8 @@ "platform_framework_text": [ "Vue(PC)", "React(PC)", - "Angular(PC)" + "Angular(PC)", + "Vue(Mobile)" ], "field_type_text": [] }, @@ -49364,12 +49501,50 @@ "Object" ] }, + { + "id": 1708481323, + "platform_framework": [ + "8" + ], + "component": "GuideStep", + "field_category": 1, + "field_name": "backButtonProps", + "field_type": [ + "8" + ], + "field_default_value": "", + "field_enum": "", + "field_desc_zh": "用于自定义当前引导框的返回按钮的内容", + "field_desc_en": null, + "field_required": 0, + "event_input": "", + "create_time": "2024-02-21 02:08:43", + "update_time": "2024-02-21 02:08:43", + "event_output": null, + "custom_field_type": "ButtonProps", + "syntactic_sugar": null, + "readonly": 1, + "html_attribute": 0, + "trigger_elements": "", + "deprecated": 0, + "version": "", + "test_description": null, + "support_default_value": 0, + "field_category_text": "Props", + "platform_framework_text": [ + "Vue(Mobile)" + ], + "field_type_text": [ + "Object" + ] + }, { "id": 2955, "platform_framework": [ "1", "2", - "4" + "4", + "8" ], "component": "GuideStep", "field_category": 1, @@ -49400,7 +49575,8 @@ "platform_framework_text": [ "Vue(PC)", "React(PC)", - "Angular(PC)" + "Angular(PC)", + "Vue(Mobile)" ], "field_type_text": [ "String", @@ -49451,7 +49627,8 @@ "platform_framework": [ "1", "2", - "4" + "4", + "8" ], "component": "GuideStep", "field_category": 1, @@ -49481,7 +49658,8 @@ "platform_framework_text": [ "Vue(PC)", "React(PC)", - "Angular(PC)" + "Angular(PC)", + "Vue(Mobile)" ], "field_type_text": [ "TNode" @@ -49492,7 +49670,8 @@ "platform_framework": [ "1", "2", - "4" + "4", + "8" ], "component": "GuideStep", "field_category": 1, @@ -49523,7 +49702,8 @@ "platform_framework_text": [ "Vue(PC)", "React(PC)", - "Angular(PC)" + "Angular(PC)", + "Vue(Mobile)" ], "field_type_text": [ "String", @@ -49571,12 +49751,50 @@ "TNode" ] }, + { + "id": 1709178118, + "platform_framework": [ + "8" + ], + "component": "GuideStep", + "field_category": 1, + "field_name": "highlightContent", + "field_type": [ + "64" + ], + "field_default_value": "", + "field_enum": "", + "field_desc_zh": "用户自定义的高亮框 (仅当 `mode` 为 `popover` 时生效)", + "field_desc_en": null, + "field_required": 0, + "event_input": "", + "create_time": "2024-02-29 03:41:58", + "update_time": "2024-02-29 03:41:58", + "event_output": null, + "custom_field_type": null, + "syntactic_sugar": null, + "readonly": 1, + "html_attribute": 0, + "trigger_elements": "", + "deprecated": 0, + "version": "", + "test_description": null, + "support_default_value": 0, + "field_category_text": "Props", + "platform_framework_text": [ + "Vue(Mobile)" + ], + "field_type_text": [ + "TNode" + ] + }, { "id": 2965, "platform_framework": [ "1", "2", - "4" + "4", + "8" ], "component": "GuideStep", "field_category": 1, @@ -49606,7 +49824,8 @@ "platform_framework_text": [ "Vue(PC)", "React(PC)", - "Angular(PC)" + "Angular(PC)", + "Vue(Mobile)" ], "field_type_text": [ "Number" @@ -49653,12 +49872,50 @@ "String" ] }, + { + "id": 1709178151, + "platform_framework": [ + "8" + ], + "component": "GuideStep", + "field_category": 1, + "field_name": "mode", + "field_type": [ + "1" + ], + "field_default_value": "", + "field_enum": "popover/dialog", + "field_desc_zh": "引导框的类型", + "field_desc_en": null, + "field_required": 0, + "event_input": "", + "create_time": "2024-02-29 03:42:31", + "update_time": "2024-02-29 03:42:31", + "event_output": null, + "custom_field_type": null, + "syntactic_sugar": null, + "readonly": 1, + "html_attribute": 0, + "trigger_elements": "", + "deprecated": 0, + "version": "", + "test_description": null, + "support_default_value": 0, + "field_category_text": "Props", + "platform_framework_text": [ + "Vue(Mobile)" + ], + "field_type_text": [ + "String" + ] + }, { "id": 2957, "platform_framework": [ "1", "2", - "4" + "4", + "8" ], "component": "GuideStep", "field_category": 1, @@ -49688,7 +49945,8 @@ "platform_framework_text": [ "Vue(PC)", "React(PC)", - "Angular(PC)" + "Angular(PC)", + "Vue(Mobile)" ], "field_type_text": [ "Object" @@ -49699,7 +49957,8 @@ "platform_framework": [ "1", "2", - "4" + "4", + "8" ], "component": "GuideStep", "field_category": 1, @@ -49729,7 +49988,8 @@ "platform_framework_text": [ "Vue(PC)", "React(PC)", - "Angular(PC)" + "Angular(PC)", + "Vue(Mobile)" ], "field_type_text": [ "Array" @@ -49776,6 +50036,80 @@ "String" ] }, + { + "id": 1709197181, + "platform_framework": [ + "8" + ], + "component": "GuideStep", + "field_category": 1, + "field_name": "placement", + "field_type": [ + "1" + ], + "field_default_value": "'top'", + "field_enum": "", + "field_desc_zh": "引导框相对于高亮元素出现的位置，(仅当 `mode` 为 `popover` 时生效)", + "field_desc_en": null, + "field_required": 0, + "event_input": "", + "create_time": "2024-02-29 08:59:41", + "update_time": "2024-02-29 08:59:41", + "event_output": null, + "custom_field_type": "StepPopoverPlacement 【type StepPopoverPlacement = 'top'|'left'|'right'|'bottom'|'top-left'|'top-right'|'bottom-left'|'bottom-right'|'left-top'|'left-bottom'|'right-top'|'right-bottom'|'center'】", + "syntactic_sugar": null, + "readonly": 1, + "html_attribute": 0, + "trigger_elements": "", + "deprecated": 0, + "version": "", + "test_description": null, + "support_default_value": 0, + "field_category_text": "Props", + "platform_framework_text": [ + "Vue(Mobile)" + ], + "field_type_text": [ + "String" + ] + }, + { + "id": 1709178092, + "platform_framework": [ + "8" + ], + "component": "GuideStep", + "field_category": 1, + "field_name": "popoverProps", + "field_type": [ + "8" + ], + "field_default_value": "", + "field_enum": "", + "field_desc_zh": "透传全部属性到 Popover 组件。`mode=popover` 时有效", + "field_desc_en": "Popover component props if `mode = popover`", + "field_required": 0, + "event_input": "", + "create_time": "2024-02-29 03:41:32", + "update_time": "2024-02-29 03:41:32", + "event_output": null, + "custom_field_type": "PopoverProps【import { PopoverProps } from '@Popover'】", + "syntactic_sugar": null, + "readonly": 1, + "html_attribute": 0, + "trigger_elements": "", + "deprecated": 0, + "version": "", + "test_description": null, + "support_default_value": 0, + "field_category_text": "Props", + "platform_framework_text": [ + "Vue(Mobile)" + ], + "field_type_text": [ + "Object" + ] + }, { "id": 3307, "platform_framework": [ @@ -49863,7 +50197,8 @@ "platform_framework": [ "1", "2", - "4" + "4", + "8" ], "component": "GuideStep", "field_category": 1, @@ -49893,7 +50228,8 @@ "platform_framework_text": [ "Vue(PC)", "React(PC)", - "Angular(PC)" + "Angular(PC)", + "Vue(Mobile)" ], "field_type_text": [ "Boolean" @@ -49904,7 +50240,8 @@ "platform_framework": [ "1", "2", - "4" + "4", + "8" ], "component": "GuideStep", "field_category": 1, @@ -49934,7 +50271,8 @@ "platform_framework_text": [ "Vue(PC)", "React(PC)", - "Angular(PC)" + "Angular(PC)", + "Vue(Mobile)" ], "field_type_text": [ "Object" @@ -49986,7 +50324,8 @@ "platform_framework": [ "1", "2", - "4" + "4", + "8" ], "component": "GuideStep", "field_category": 1, @@ -50017,7 +50356,8 @@ "platform_framework_text": [ "Vue(PC)", "React(PC)", - "Angular(PC)" + "Angular(PC)", + "Vue(Mobile)" ], "field_type_text": [ "String",