Skip to content

Commit 52c5816

Browse files
authored
chore: optimize api docs output script (#748)
1 parent 9b52e6c commit 52c5816

File tree

29 files changed

+2
-37
lines changed

29 files changed

+2
-37
lines changed

packages/products/tdesign-miniprogram/packages/components/button/README.en-US.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,6 @@ session-from | String | - | \- | N
3131
shape | String | rectangle | button shape。options: rectangle/square/round/circle | N
3232
show-message-card | Boolean | false | \- | N
3333
size | String | medium | a button has four size。options: extra-small/small/medium/large | N
34-
3534
t-id | String | - | id | N
3635
theme | String | default | button theme。options: default/primary/danger/light | N
3736
type | String | - | type of button element, same as formType of Miniprogram。options: submit/reset | N

packages/products/tdesign-miniprogram/packages/components/button/README.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,6 @@ session-from | String | - | 会话来源,open-type="contact"时有效 | N
3131
shape | String | rectangle | 按钮形状,有 4 种:长方形、正方形、圆角长方形、圆形。可选项:rectangle/square/round/circle | N
3232
show-message-card | Boolean | false | 是否显示会话内消息卡片,设置此参数为 true,用户进入客服会话会在右下角显示"可能要发送的小程序"提示,用户点击后可以快速发送小程序消息,open-type="contact"时有效 | N
3333
size | String | medium | 组件尺寸。可选项:extra-small/small/medium/large | N
34-
3534
t-id | String | - | 按钮标签id | N
3635
theme | String | default | 组件风格,依次为品牌色、危险色。可选项:default/primary/danger/light | N
3736
type | String | - | 同小程序的 formType。可选项:submit/reset | N

packages/products/tdesign-miniprogram/packages/components/cascader/README.en-US.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,7 @@ style | Object | - | CSS(Cascading Style Sheets) | N
1010
custom-style | Object | - | CSS(Cascading Style Sheets),used to set style on virtual component | N
1111
check-strictly | Boolean | false | \- | N
1212
close-btn | Boolean | true | \- | N
13-
1413
keys | Object | - | Typescript:`KeysType`[see more ts definition](https://github.com/Tencent/tdesign-miniprogram/blob/develop/packages/components/common/common.ts) | N
15-
1614
options | Array | [] | Typescript:`Array<CascaderOption>` | N
1715
placeholder | String | 选择选项 | \- | N
1816
sub-titles | Array | [] | Typescript:`Array<string>` | N

packages/products/tdesign-miniprogram/packages/components/cascader/README.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,7 @@ style | Object | - | 样式 | N
1010
custom-style | Object | - | 样式,一般用于开启虚拟化组件节点场景 | N
1111
check-strictly | Boolean | false | 父子节点选中状态不再关联,可各自选中或取消 | N
1212
close-btn | Boolean | true | 关闭按钮 | N
13-
1413
keys | Object | - | 用来定义 value / label 在 `options` 中对应的字段别名。TS 类型:`KeysType`[通用类型定义](https://github.com/Tencent/tdesign-miniprogram/blob/develop/packages/components/common/common.ts) | N
15-
1614
options | Array | [] | 可选项数据源。TS 类型:`Array<CascaderOption>` | N
1715
placeholder | String | 选择选项 | 未选中时的提示文案 | N
1816
sub-titles | Array | [] | 每级展示的次标题。TS 类型:`Array<string>` | N

packages/products/tdesign-miniprogram/packages/components/color-picker/README.en-US.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,7 @@ color-modes | String / Array | "monochrome" | Typescript:`colorModesEnum \| co
1313
enable-alpha | Boolean | false | \- | N
1414
enable-multiple-gradient | Boolean | true | \- | N
1515
fixed | Boolean | false | `1.8.5` | N
16-
1716
format | String | RGB | When `enableAlpha` is true, `HEX8/RGBA/HSLA/HSVA` are valid。options: HEX/HEX8/RGB/RGBA/HSL/HSLA/HSV/HSVA/CMYK/CSS | N
18-
1917
popup-props | Object | {} | Typescript:`PopupProps`[Popup API Documents](./popup?tab=api)[see more ts definition](https://github.com/Tencent/tdesign-miniprogram/blob/develop/packages/components/color-picker/type.ts) | N
2018
swatch-colors | Array | undefined | swatch colors。Typescript:`Array<string> \| null \| undefined` | N
2119
type | String | base | options: base/multiple。Typescript:`TypeEnum ` `type TypeEnum = 'base' \| 'multiple'`[see more ts definition](https://github.com/Tencent/tdesign-miniprogram/blob/develop/packages/components/color-picker/type.ts) | N

packages/products/tdesign-miniprogram/packages/components/color-picker/README.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,7 @@ color-modes | String / Array | "monochrome" | 颜色模式选择。同时支持
1313
enable-alpha | Boolean | false | 是否开启透明通道 | N
1414
enable-multiple-gradient | Boolean | true | 是否允许开启通过点击渐变轴增加渐变梯度,默认开启,关闭时只会存在起始和结束两个颜色 | N
1515
fixed | Boolean | false | `1.8.5`。如果 color-picker 是在一个 `position:fixed` 的区域,需要显式指定属性 fixed 为 true | N
16-
1716
format | String | RGB | 格式化色值。`enableAlpha` 为真时,`HEX8/RGBA/HSLA/HSVA` 有效。可选项:HEX/HEX8/RGB/RGBA/HSL/HSLA/HSV/HSVA/CMYK/CSS | N
18-
1917
popup-props | Object | {} | 透传 Popup 组件全部属性。TS 类型:`PopupProps`[Popup API Documents](./popup?tab=api)[详细类型定义](https://github.com/Tencent/tdesign-miniprogram/blob/develop/packages/components/color-picker/type.ts) | N
2018
swatch-colors | Array | undefined | 系统预设的颜色样例,值为 `null``[]` 则不显示系统色,值为 `undefined` 会显示组件内置的系统默认色。TS 类型:`Array<string> \| null \| undefined` | N
2119
type | String | base | 颜色选择器类型。(base 表示仅展示系统预设内容; multiple 表示展示色板和系统预设内容。可选项:base/multiple。TS 类型:`TypeEnum ` `type TypeEnum = 'base' \| 'multiple'`[详细类型定义](https://github.com/Tencent/tdesign-miniprogram/blob/develop/packages/components/color-picker/type.ts) | N

packages/products/tdesign-miniprogram/packages/components/date-time-picker/README.en-US.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,6 @@ confirm-btn | String | - | \- | N
1414
custom-locale | String | zh | \- | N
1515
end | String / Number | - | \- | N
1616
filter | Function | - | Typescript:`(type: TimeModeValues, columns: DateTimePickerColumn) => DateTimePickerColumn` `type DateTimePickerColumn = DateTimePickerColumnItem[]` `interface DateTimePickerColumnItem { label: string,value: string}`[see more ts definition](https://github.com/Tencent/tdesign-miniprogram/blob/develop/packages/components/date-time-picker/type.ts) | N
17-
1817
format | String | 'YYYY-MM-DD HH:mm:ss' | \- | N
1918
formatter | Function | - | Typescript:`(option: DateTimePickerColumnItem, columnIndex: number) => DateTimePickerColumnItem` | N
2019
header | Boolean | true | \- | N

packages/products/tdesign-miniprogram/packages/components/date-time-picker/README.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,6 @@ confirm-btn | String | - | 确定按钮文字 | N
1414
custom-locale | String | zh | 组件国际化语言,目前支持: 简体中文(zh)、(tc)、英文(en)、日语(ja)、韩语(ko)、俄语(ru)等六种语言 | N
1515
end | String / Number | - | 选择器的最大可选时间,默认为当前时间+10年 | N
1616
filter | Function | - | 列选项过滤函数,支持自定义列内容。(type 值可为: year, month, date, hour, minute, second)。TS 类型:`(type: TimeModeValues, columns: DateTimePickerColumn) => DateTimePickerColumn` `type DateTimePickerColumn = DateTimePickerColumnItem[]` `interface DateTimePickerColumnItem { label: string,value: string}`[详细类型定义](https://github.com/Tencent/tdesign-miniprogram/blob/develop/packages/components/date-time-picker/type.ts) | N
17-
1817
format | String | 'YYYY-MM-DD HH:mm:ss' | 用于格式化 pick、change、confirm 事件返回的值,[详细文档](https://day.js.org/docs/en/display/format) | N
1918
formatter | Function | - | 格式化标签。TS 类型:`(option: DateTimePickerColumnItem, columnIndex: number) => DateTimePickerColumnItem` | N
2019
header | Boolean | true | 头部内容。值为 true 显示空白头部,值为 false 不显示任何内容 | N

packages/products/tdesign-miniprogram/packages/components/dialog/README.en-US.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,12 +15,10 @@ close-btn | Boolean / Object | false | `0.31.0`。Typescript:`boolean \| Butto
1515
close-on-overlay-click | Boolean | false | \- | N
1616
confirm-btn | String / Object | - | \- | N
1717
content | String | - | \- | N
18-
1918
overlay-props | Object | {} | Typescript:`OverlayProps`[Overlay API Documents](./overlay?tab=api)[see more ts definition](https://github.com/Tencent/tdesign-miniprogram/blob/develop/packages/components/dialog/type.ts) | N
2019
prevent-scroll-through | Boolean | true | \- | N
2120
show-overlay | Boolean | true | \- | N
2221
title | String | - | \- | N
23-
2422
using-custom-navbar | Boolean | false | \- | N
2523
visible | Boolean | - | \- | N
2624
z-index | Number | 11500 | \- | N

packages/products/tdesign-miniprogram/packages/components/dialog/README.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,12 +15,10 @@ close-btn | Boolean / Object | false | `0.31.0`。是否展示关闭按钮,值
1515
close-on-overlay-click | Boolean | false | 点击蒙层时是否触发关闭事件 | N
1616
confirm-btn | String / Object | - | 确认按钮。值为 null 则不显示确认按钮。值类型为字符串,则表示自定义按钮文本,值类型为 Object 则表示透传 Button 组件属性。使用 Slot 自定义按钮时,需自行控制确认事件 | N
1717
content | String | - | 内容 | N
18-
1918
overlay-props | Object | {} | 透传至 Overlay 组件。TS 类型:`OverlayProps`[Overlay API Documents](./overlay?tab=api)[详细类型定义](https://github.com/Tencent/tdesign-miniprogram/blob/develop/packages/components/dialog/type.ts) | N
2019
prevent-scroll-through | Boolean | true | 防止滚动穿透 | N
2120
show-overlay | Boolean | true | 是否显示遮罩层 | N
2221
title | String | - | 标题 | N
23-
2422
using-custom-navbar | Boolean | false | 是否使用了自定义导航栏 | N
2523
visible | Boolean | - | 控制对话框是否显示 | N
2624
z-index | Number | 11500 | 对话框层级,Web 侧样式默认为 2500,移动端样式默认 2500,小程序样式默认为 11500 | N

0 commit comments

Comments
 (0)