Skip to content

Commit

Permalink
Merge pull request #74 from TDesignOteam/hotfix/transfer-1216
Browse files Browse the repository at this point in the history 
Hotfix/transfer 1216
  • Loading branch information
@xiaosansiji
xiaosansiji authored Dec 16, 2021
2 parents be97904 + fb01eb4 commit 974d101
Show file tree
Hide file tree
Showing 52 changed files with 1,899 additions and 1,909 deletions.
32 changes: 16 additions & 16 deletions examples/alert/alert.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,22 +4,22 @@

### Alert Props

| 名称 | 类型 | 默认值 | 说明 | 必传 |
| --------- | ---------------------------------- | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | --- |
| close | String / Boolean / Slot / Function | false | 关闭按钮。值为 true 则显示默认关闭按钮；值为 false 则不显示按钮；值类型为 string 则直接显示；值类型为 Function 则可以自定关闭按钮。TS 类型：`string | boolean | TNode`。[通用类型定义](https://github.com/Tencent/tdesign-vue/blob/develop/src/common.ts) | N |
| default | String / Slot / Function | - | 内容，同 message。TS 类型：`string | TNode`。[通用类型定义](https://github.com/Tencent/tdesign-vue/blob/develop/src/common.ts) | N |
| icon | Slot / Function | - | 图标。TS 类型：`TNode`。[通用类型定义](https://github.com/Tencent/tdesign-vue/blob/develop/src/common.ts) | N |
| maxLine | Number | 0 | 内容显示最大行数，超出的内容会折叠收起，用户点击后再展开。值为 0 表示不折叠 | N |
| message | String / Slot / Function | - | 内容（子元素）。TS 类型：`string | TNode`。[通用类型定义](https://github.com/Tencent/tdesign-vue/blob/develop/src/common.ts) | N |
| operation | Slot / Function | - | 跟在告警内容后面的操作区。TS 类型：`TNode`。[通用类型定义](https://github.com/Tencent/tdesign-vue/blob/develop/src/common.ts) | N |
| theme | String | info | 组件风格。可选项：success/info/warning/error | N |
| title | String / Slot / Function | - | 标题。TS 类型：`string | TNode`。[通用类型定义](https://github.com/Tencent/tdesign-vue/blob/develop/src/common.ts) | N |
| onClose | Function | | 关闭按钮点击时触发。`(context: { e: MouseEvent }) => {}` | N |
| onClosed | Function | | 告警提示框关闭动画结束后触发。`(context: { e: TransitionEvent }) => {}` | N |
名称 | 类型 | 默认值 | 说明 | 必传
-- | -- | -- | -- | --
close | String / Boolean / Slot / Function | false | 关闭按钮。值为 true 则显示默认关闭按钮；值为 false 则不显示按钮；值类型为 string 则直接显示；值类型为 Function 则可以自定关闭按钮。TS 类型：`string | boolean | TNode`。[通用类型定义](https://github.com/Tencent/tdesign-vue/blob/develop/src/common.ts) | N
default | String / Slot / Function | - | 内容，同 message。TS 类型：`string | TNode`。[通用类型定义](https://github.com/Tencent/tdesign-vue/blob/develop/src/common.ts) | N
icon | Slot / Function | - | 图标。TS 类型：`TNode`。[通用类型定义](https://github.com/Tencent/tdesign-vue/blob/develop/src/common.ts) | N
maxLine | Number | 0 | 内容显示最大行数，超出的内容会折叠收起，用户点击后再展开。值为 0 表示不折叠 | N
message | String / Slot / Function | - | 内容（子元素）。TS 类型：`string | TNode`。[通用类型定义](https://github.com/Tencent/tdesign-vue/blob/develop/src/common.ts) | N
operation | Slot / Function | - | 跟在告警内容后面的操作区。TS 类型：`TNode`。[通用类型定义](https://github.com/Tencent/tdesign-vue/blob/develop/src/common.ts) | N
theme | String | info | 组件风格。可选项：success/info/warning/error | N
title | String / Slot / Function | - | 标题。TS 类型：`string | TNode`。[通用类型定义](https://github.com/Tencent/tdesign-vue/blob/develop/src/common.ts) | N
onClose | Function | | 关闭按钮点击时触发。`(context: { e: MouseEvent }) => {}` | N
onClosed | Function | | 告警提示框关闭动画结束后触发。`(context: { e: TransitionEvent }) => {}` | N

### Alert Events

| 名称 | 参数 | 描述 |
| ------ | ----------------------------------- | ---------------------------- |
| close | `(context: { e: MouseEvent })` | 关闭按钮点击时触发 |
| closed | `(context: { e: TransitionEvent })` | 告警提示框关闭动画结束后触发 |
名称 | 参数 | 描述
-- | -- | --
close | `(context: { e: MouseEvent })` | 关闭按钮点击时触发
closed | `(context: { e: TransitionEvent })` | 告警提示框关闭动画结束后触发
46 changes: 23 additions & 23 deletions examples/anchor/anchor.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,35 +4,35 @@

### Anchor Props

| 名称 | 类型 | 默认值 | 说明 | 必传 |
| ------------ | ----------------- | -------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---- |
| affixProps | Object | - | 透传 Affix 组件属性，即让 Anchor 组件支持所有 Affix 组件特性。TS 类型：`AffixProps`。[详细类型定义](https://github.com/Tencent/tdesign-vue/tree/develop/src/anchor/type.ts) | N |
| bounds | Number | 5 | 锚点区域边界 | N |
| container | String / Function | () => (() => window) | 指定滚动的容器。数据类型为 String 时，会被当作选择器处理，进行节点查询。示例：'body' 或 () => document.body。TS 类型：`ScrollContainer` | N |
| cursor | Slot / Function | - | 用于自定义选中项左侧游标。TS 类型：`TNode`。[通用类型定义](https://github.com/Tencent/tdesign-vue/blob/develop/src/common.ts) | N |
| size | String | medium | 组件尺寸，small(120px)，medium(200px)，large(320px)。可选项：small / medium / large | N |
| targetOffset | Number | 0 | 锚点滚动偏移量 | N |
| onChange | Function | | 锚点改变时触发。`(currentLink: string, prevLink: string) => {}` | N |
| onClick | Function | | 锚点被点击时触发。`(link: { href: string; title: string; e: MouseEvent }) => {}` | N |
名称 | 类型 | 默认值 | 说明 | 必传
-- | -- | -- | -- | --
affixProps | Object | - | 透传 Affix 组件属性，即让 Anchor 组件支持所有 Affix 组件特性。TS 类型：`AffixProps`。[详细类型定义](https://github.com/Tencent/tdesign-vue/tree/develop/src/anchor/type.ts) | N
bounds | Number | 5 | 锚点区域边界 | N
container | String / Function | () => (() => window) | 指定滚动的容器。数据类型为 String 时，会被当作选择器处理，进行节点查询。示例：'body' 或 () => document.body。TS 类型：`ScrollContainer` | N
cursor | Slot / Function | - | 用于自定义选中项左侧游标。TS 类型：`TNode`。[通用类型定义](https://github.com/Tencent/tdesign-vue/blob/develop/src/common.ts) | N
size | String | medium | 组件尺寸，small(120px)，medium(200px)，large(320px)。可选项：small / medium / large | N
targetOffset | Number | 0 | 锚点滚动偏移量 | N
onChange | Function | | 锚点改变时触发。`(currentLink: string, prevLink: string) => {}` | N
onClick | Function | | 锚点被点击时触发。`(link: { href: string; title: string; e: MouseEvent }) => {}` | N

### Anchor Events

| 名称 | 参数 | 描述 |
| ------ | -------------------------------------------------------- | ---------------- |
| change | `(currentLink: string, prevLink: string)` | 锚点改变时触发 |
| click | `(link: { href: string; title: string; e: MouseEvent })` | 锚点被点击时触发 |
名称 | 参数 | 描述
-- | -- | --
change | `(currentLink: string, prevLink: string)` | 锚点改变时触发
click | `(link: { href: string; title: string; e: MouseEvent })` | 锚点被点击时触发

### AnchorItem Props

| 名称 | 类型 | 默认值 | 说明 | 必传 |
| ------ | ------------------------ | ------ | ------------------------------------------------- | ----------------------------------------------------------------------------------------- | --- |
| href | String | - | 必需。锚点链接, 如果是 hash 模式需要加上当前 path | Y |
| target | String | \_self | 锚点文本。可选项：\_self/\_blank/\_parent/\_top | N |
| title | String / Slot / Function | '' | 锚点文本。TS 类型：`string | TNode`。[通用类型定义](https://github.com/Tencent/tdesign-vue/blob/develop/src/common.ts) | N |
名称 | 类型 | 默认值 | 说明 | 必传
-- | -- | -- | -- | --
href | String | - | 必需。锚点链接, 如果是 hash 模式需要加上当前 path | Y
target | String | _self | 锚点文本。可选项：_self/_blank/_parent/_top | N
title | String / Slot / Function | '' | 锚点文本。TS 类型：`string | TNode`。[通用类型定义](https://github.com/Tencent/tdesign-vue/blob/develop/src/common.ts) | N

### AnchorTarget Props

| 名称 | 类型 | 默认值 | 说明 | 必传 |
| ---- | ------ | ------ | ----------------- | ---- |
| id | String | - | 必需。目标内容 id | Y |
| tag | String | div | 渲染的标签 | N |
名称 | 类型 | 默认值 | 说明 | 必传
-- | -- | -- | -- | --
id | String | - | 必需。目标内容 id | Y
tag | String | div | 渲染的标签 | N
40 changes: 20 additions & 20 deletions examples/avatar/avatar.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,29 +4,29 @@

### Avatar Props

| 名称 | 类型 | 默认值 | 说明 | 必传 |
| ---------------- | --------------- | ------ | ----------------------------------------------------------------------------------------------------------------------------------------- | ---- |
| alt | String | - | 头像替换文本 | N |
| hideOnLoadFailed | Boolean | false | 加载失败时隐藏图片 | N |
| icon | Slot / Function | - | 图标。TS 类型：`TNode`。[通用类型定义](https://github.com/Tencent/tdesign-vue/blob/develop/src/common.ts) | N |
| image | String | - | 图片地址 | N |
| shape | String | circle | 形状。可选项：circle/round。TS 类型：`ShapeEnum `。[详细类型定义](https://github.com/Tencent/tdesign-vue/tree/develop/src/avatar/type.ts) | N |
| size | String | - | 尺寸，示例值：small/medium/large/24px/38px 等，默认为 large | N |
| onError | Function | | 图片加载失败时触发。`() => {}` | N |
名称 | 类型 | 默认值 | 说明 | 必传
-- | -- | -- | -- | --
alt | String | - | 头像替换文本 | N
hideOnLoadFailed | Boolean | false | 加载失败时隐藏图片 | N
icon | Slot / Function | - | 图标。TS 类型：`TNode`。[通用类型定义](https://github.com/Tencent/tdesign-vue/blob/develop/src/common.ts) | N
image | String | - | 图片地址 | N
shape | String | circle | 形状。可选项：circle/round。TS 类型：`ShapeEnum `。[详细类型定义](https://github.com/Tencent/tdesign-vue/tree/develop/src/avatar/type.ts) | N
size | String | - | 尺寸，示例值：small/medium/large/24px/38px 等，默认为 large | N
onError | Function | | 图片加载失败时触发。`() => {}` | N

### Avatar Events

| 名称 | 参数 | 描述 |
| ----- | ---- | ------------------ |
| error | - | 图片加载失败时触发 |
名称 | 参数 | 描述
-- | -- | --
error | - | 图片加载失败时触发

### AvatarGroup Props

| 名称 | 类型 | 默认值 | 说明 | 必传 |
| -------------- | ------------------------ | ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | --- |
| cascading | String | 'right-up' | 图片之间的层叠关系，可选值：左侧图片在上和右侧图片在上。可选项：left-up/right-up。TS 类型：`CascadingValue`。[详细类型定义](https://github.com/Tencent/tdesign-vue/tree/develop/src/avatar/type.ts) | N |
| collapseAvatar | String / Slot / Function | - | 头像数量超出时，会出现一个头像折叠元素。该元素内容可自定义。默认为 `+N`。示例：`+5`，`...`, `更多`。TS 类型：`string | TNode`。[通用类型定义](https://github.com/Tencent/tdesign-vue/blob/develop/src/common.ts) | N |
| max | Number | - | 能够同时显示的最多头像数量 | N |
| placement | String | - | 超出的头像呈现位置。可选项：left/top/bottom/right。TS 类型：`MaxOverPlacement`。[详细类型定义](https://github.com/Tencent/tdesign-vue/tree/develop/src/avatar/type.ts) | N |
| popupProps | Object | - | 头像右上角提示信息。TS 类型：`PopupProps`。[详细类型定义](https://github.com/Tencent/tdesign-vue/tree/develop/src/avatar/type.ts) | N |
| size | String | medium | 尺寸，示例值：small/medium/large/24px/38px 等。优先级低于 Avatar.size | N |
名称 | 类型 | 默认值 | 说明 | 必传
-- | -- | -- | -- | --
cascading | String | 'right-up' | 图片之间的层叠关系，可选值：左侧图片在上和右侧图片在上。可选项：left-up/right-up。TS 类型：`CascadingValue`。[详细类型定义](https://github.com/Tencent/tdesign-vue/tree/develop/src/avatar/type.ts) | N
collapseAvatar | String / Slot / Function | - | 头像数量超出时，会出现一个头像折叠元素。该元素内容可自定义。默认为 `+N`。示例：`+5`，`...`, `更多`。TS 类型：`string | TNode`。[通用类型定义](https://github.com/Tencent/tdesign-vue/blob/develop/src/common.ts) | N
max | Number | - | 能够同时显示的最多头像数量 | N
placement | String | - | 超出的头像呈现位置。可选项：left/top/bottom/right。TS 类型：`MaxOverPlacement`。[详细类型定义](https://github.com/Tencent/tdesign-vue/tree/develop/src/avatar/type.ts) | N
popupProps | Object | - | 头像右上角提示信息。TS 类型：`PopupProps`。[详细类型定义](https://github.com/Tencent/tdesign-vue/tree/develop/src/avatar/type.ts) | N
size | String | medium | 尺寸，示例值：small/medium/large/24px/38px 等。优先级低于 Avatar.size | N
Loading

0 comments on commit 974d101

Please sign in to comment.