From 09b70c5f7294c625e519fec8339b10af7966e1bb Mon Sep 17 00:00:00 2001 From: Y Date: Thu, 13 Jul 2023 12:35:33 +0800 Subject: [PATCH] docs: add external-class content (#2186) * docs(Button): add external-class contnet * docs(Grid): add external-class contnet * docs(Divider): add external-class content --- src/button/README.md | 7 ++++++- src/divider/README.md | 6 +++++- src/grid/README.md | 16 ++++++++++++++-- 3 files changed, 25 insertions(+), 4 deletions(-) diff --git a/src/button/README.md b/src/button/README.md index 341910a57..76c8160b7 100644 --- a/src/button/README.md +++ b/src/button/README.md @@ -69,7 +69,6 @@ block | Boolean | false | 是否为块级元素 | N content | String / Slot | - | 按钮内容 | N custom-dataset | Object | - | 自定义 dataset，可通过 event.currentTarget.dataset.custom 获取。TS 类型：`any` | N disabled | Boolean | false | 禁用状态 | N -external-classes | Array | - | 组件类名。`['t-class', 't-class-icon', 't-class-loading']` | N ghost | Boolean | false | 是否为幽灵按钮（镂空按钮） | N icon | String / Object | - | 图标名称。值为字符串表示图标名称，值为 `Object` 类型，表示透传至 `icon`。 | N loading | Boolean | false | 是否显示为加载状态 | N @@ -106,6 +105,12 @@ bindchooseavatar | Eventhandle | - | 获取用户头像回调，open-type=choose -- | -- | -- tap | `event` | 点击按钮，当按钮不为加载或禁用状态时触发 +### Button 外部样式类 +类名 | 说明 +-- | -- +t-class | 根节点样式类 +t-class-icon | 图标样式类 +t-class-loading | 加载样式类 ### CSS 变量 组件提供了下列 CSS 变量，可用于自定义样式。 diff --git a/src/divider/README.md b/src/divider/README.md index 3588c31cd..925cdd480 100644 --- a/src/divider/README.md +++ b/src/divider/README.md @@ -36,9 +36,13 @@ isComponent: true align | String | center | 文本位置（仅在水平分割线有效）。可选项：left/right/center | N content | String / Slot | - | 子元素 | N dashed | Boolean | false | 是否虚线（仅在水平分割线有效） | N -external-classes | Array | - | 组件类名，分别用于设置 组件外层类名、分隔线类名 等。`['t-class', 't-class-line', 't-class-content']` | N layout | String | horizontal | 分隔线类型有两种：水平和垂直。可选项：horizontal/vertical | N +### Divider 外部样式类 +类名 | 说明 +-- | -- +t-class | 根节点样式类 +t-class-content | 内容样式类 ### CSS 变量 组件提供了下列 CSS 变量，可用于自定义样式。 diff --git a/src/grid/README.md b/src/grid/README.md index d59b2585d..e217e6f15 100644 --- a/src/grid/README.md +++ b/src/grid/README.md @@ -63,18 +63,22 @@ isComponent: true align | String | center | 内容对齐方式。可选项：left/center | N border | Boolean / Object | false | 边框，默认不显示。值为 true 则显示默认边框，值类型为 object 则表示自定义边框样式。TS 类型：`boolean \| { color?: string; width?: string; style?: 'solid' \| 'dashed' \| 'dotted' \| 'double' \| 'groove' \| 'inset' \| 'outset' }` | N column | Number | 4 | 每一行的列数量；为 0 时等于固定大小 | N -external-classes | Array | - | 组件类名，用于设置组件外层元素类名。`['t-class']` | N gutter | Number | - | 间隔大小 | N hover | Boolean | false | 是否开启点击反馈 | N theme | String | default | 宫格的风格。可选项：default/card | N +### Grid 外部样式类 +类名 | 说明 +-- | -- +t-class | 根节点样式类 + + ### GridItem Props 名称 | 类型 | 默认值 | 说明 | 必传 -- | -- | -- | -- | -- badge-props | Object | null | 透传至 Badge 属性。TS 类型：`BadgeProps`，[Badge API Documents](./badge?tab=api)。[详细类型定义](https://github.com/Tencent/tdesign-miniprogram/tree/develop/src/grid-item/type.ts) | N description | String / Slot | - | 文本以外的更多描述，辅助信息。可以通过 Props 传入文本，也可以自定义标题节点 | N -external-classes | Array | - | 组件类名，分别用于设置组件外层元素、图片、文本、描述等元素类名。`['t-class', 't-class-image', 't-class-text', 't-class-description']` | N icon | String / Object | - | 图标名称。值为字符串表示图标名称，值为 `Object` 类型，表示透传至 `icon` | N image | String / Slot | - | 图片，可以是图片地址，也可以自定义图片节点，值为 slot 的时候才能使用插槽 | N image-props | Object | - | 透传至 Image 组件 | N @@ -89,6 +93,14 @@ url | String | - | 点击后的跳转链接 | N -- | -- | -- click | \- | 点击子项后触发 +### GridItem 外部样式类 +类名 | 说明 +-- | -- +t-class | 根节点样式类 +t-class-content | 内容样式类 +t-class-image | 图片样式类 +t-class-text | 文本样式类 +t-class-description | 描述样式类 ### CSS 变量