Skip to content

Commit

Permalink
feat(globalConfig): support descriptions rate update steps (#4476)
Browse files Browse the repository at this point in the history
* feat(globalConfig): support descriptions rate update  steps

* feat: colonText

* chore: update common

* chore: fix lint

* test: fix colon test case

* chore: update snapshot

---------

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: Uyarn <[email protected]>
  • Loading branch information
3 people authored Aug 18, 2024
1 parent f596d3f commit c6686e9
Show file tree
Hide file tree
Showing 12 changed files with 258 additions and 87 deletions.
16 changes: 16 additions & 0 deletions src/config-provider/config-provider.en-US.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@ cascader | Object | - | Cascader global configs。Typescript:`CascaderConfig`
classPrefix | String | t | \- | N
colorPicker | Object | - | ColorPicker global configs。Typescript:`ColorPickerConfig` | N
datePicker | Object | - | DatePicker global configs。Typescript:`DatePickerConfig` | N
descriptions | Object | - | Descriptions global configs。Typescript:`DescriptionsConfig` | N
dialog | Object | - | Dialog global configs。Typescript:`DialogConfig` | N
drawer | Object | - | Drawer global configs。Typescript:`DrawerConfig` | N
form | Object | - | Form global configs。Typescript:`FormConfig` | N
Expand All @@ -59,6 +60,7 @@ list | Object | - | List global configs。Typescript:`ListConfig` | N
message | Object | - | Message Component global configs。Typescript:`MessageConfig` | N
pagination | Object | - | Pagination global configs。Typescript:`PaginationConfig` | N
popconfirm | Object | - | Popconfirm global configs。Typescript:`PopconfirmConfig` | N
rate | Object | - | Rate global configs。Typescript:`RateConfig` | N
select | Object | - | Select global configs。Typescript:`SelectConfig` | N
steps | Object | - | Steps global configs。Typescript:`StepsConfig` | N
table | Object | - | Table global configs。Typescript:`TableConfig` | N
Expand Down Expand Up @@ -294,6 +296,7 @@ fileStatusText | String | - | \- | N

name | type | default | description | required
-- | -- | -- | -- | --
colonText | String | - | colon on the right of label ":" | N
errorMessage | Object | - | Typescript:`FormErrorMessage`[Form API Documents](./form?tab=api)[see more ts definition](https://github.com/Tencent/tdesign-vue-next/tree/develop/src/config-provider/type.ts) | N
requiredMark | Boolean | true | \- | N

Expand All @@ -307,6 +310,7 @@ closeIcon | Function | - | Typescript:`TNode`。[see more ts definition](https

name | type | default | description | required
-- | -- | -- | -- | --
checkIcon | Slot / Function | - | Typescript:`TNode`[see more ts definition](https://github.com/Tencent/tdesign-vue-next/blob/develop/src/common.ts) | N
errorIcon | Slot / Function | - | Typescript:`TNode`[see more ts definition](https://github.com/Tencent/tdesign-vue-next/blob/develop/src/common.ts) | N

### AlertConfig
Expand All @@ -316,6 +320,12 @@ name | type | default | description | required
collapseText | String | - | \- | N
expandText | String | - | \- | N

### DescriptionsConfig

name | type | default | description | required
-- | -- | -- | -- | --
colonText | String | - | colon on the right of label, ":" | N

### AnchorConfig

name | type | default | description | required
Expand Down Expand Up @@ -354,3 +364,9 @@ finishButtonProps | Object | - | finish button in last step. `{ content: 'Finish
nextButtonProps | Object | - | next step button. `{ content: 'Next Button', theme: 'primary' }`。Typescript:`ButtonProps` | N
prevButtonProps | Object | - | previous step button. `{ content: 'Previous Step', theme: 'default' }`。Typescript:`ButtonProps` | N
skipButtonProps | Object | - | skip button. `{ content: 'Skip', theme: 'default' }`。Typescript:`ButtonProps` | N

### RateConfig

name | type | default | description | required
-- | -- | -- | -- | --
rateText | Array | - | Typescript:`string[]` | N
76 changes: 46 additions & 30 deletions src/config-provider/config-provider.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Vue.createApp({}).use(TDesign)
## API
### GlobalConfigProvider

名称 | 类型 | 默认值 | 说明 | 必传
名称 | 类型 | 默认值 | 描述 | 必传
-- | -- | -- | -- | --
alert | Object | - | 警告全局配置。TS 类型:`AlertConfig` | N
anchor | Object | - | 锚点全局配置。TS 类型:`AnchorConfig` | N
Expand All @@ -46,6 +46,7 @@ cascader | Object | - | 级联选择器全局配置。TS 类型:`CascaderConfi
classPrefix | String | t | CSS 类名前缀 | N
colorPicker | Object | - | 颜色选择器全局配置。TS 类型:`ColorPickerConfig` | N
datePicker | Object | - | 日期选择器全局配置。TS 类型:`DatePickerConfig` | N
descriptions | Object | - | 描述全局配置。TS 类型:`DescriptionsConfig` | N
dialog | Object | - | 对话框全局配置。TS 类型:`DialogConfig` | N
drawer | Object | - | 抽屉全局配置。TS 类型:`DrawerConfig` | N
form | Object | - | 表单组件全局配置。TS 类型:`FormConfig` | N
Expand All @@ -58,6 +59,7 @@ list | Object | - | 列表组件全局配置。TS 类型:`ListConfig` | N
message | Object | - | 消息组件全局配置。TS 类型:`MessageConfig` | N
pagination | Object | - | 分页组件全局配置。TS 类型:`PaginationConfig` | N
popconfirm | Object | - | 气泡确认框全局配置。TS 类型:`PopconfirmConfig` | N
rate | Object | - | 评分全局配置。TS 类型:`RateConfig` | N
select | Object | - | 选择器组件全局配置。TS 类型:`SelectConfig` | N
steps | Object | - | 步骤条组件全局配置。TS 类型:`StepsConfig` | N
table | Object | - | 表格组件全局配置。TS 类型:`TableConfig` | N
Expand All @@ -70,14 +72,14 @@ upload | Object | - | 上传组件全局配置。TS 类型:`UploadConfig` | N

### InputConfig

名称 | 类型 | 默认值 | 说明 | 必传
名称 | 类型 | 默认值 | 描述 | 必传
-- | -- | -- | -- | --
autocomplete | String | - | 是否开启自动填充功能 | N
placeholder | String | - | 语言配置,“请输入”占位符描述文本 | N

### PaginationConfig

名称 | 类型 | 默认值 | 说明 | 必传
名称 | 类型 | 默认值 | 描述 | 必传
-- | -- | -- | -- | --
itemsPerPage | String | - | 语言配置,每页条数文本,示例:`'{size} 条/页'` | N
jumpTo | String | - | 语言配置,页码跳转文本,示例:'跳至' | N
Expand All @@ -86,7 +88,7 @@ total | String | - | 语言配置,数据总条数文本,示例:`'共 {tota

### CalendarConfig

名称 | 类型 | 默认值 | 说明 | 必传
名称 | 类型 | 默认值 | 描述 | 必传
-- | -- | -- | -- | --
cellMonth | String | - | 语言配置,月份描述文本,示例:'一月,二月,三月,四月,五月,六月,七月,八月,九月,十月,十一月,十二月' | N
controllerConfig | Object | - | 日历右上角控制器按钮配置。TS 类型:`CalendarController`[Calendar API Documents](./calendar?tab=api)[详细类型定义](https://github.com/Tencent/tdesign-vue-next/tree/develop/src/config-provider/type.ts) | N
Expand All @@ -104,31 +106,31 @@ yearSelection | String | - | 语言配置,“年”选择描述文本,示例

### CascaderConfig

名称 | 类型 | 默认值 | 说明 | 必传
名称 | 类型 | 默认值 | 描述 | 必传
-- | -- | -- | -- | --
empty | String | - | 语言配置,“暂无数据”描述文本 | N
loadingText | String | - | 语言配置,“加载中”描述文本 | N
placeholder | String | - | 语言配置,“请选择”占位描述文本 | N

### ColorPickerConfig

名称 | 类型 | 默认值 | 说明 | 必传
名称 | 类型 | 默认值 | 描述 | 必传
-- | -- | -- | -- | --
clearConfirmText | String | - | 语言配置,“确定清空最近使用的颜色吗?”清空颜色确认文案 | N
recentColorTitle | String | - | 语言配置,“最近使用颜色” 区域标题文本 | N
swatchColorTitle | String | - | 语言配置,\"系统预设颜色\" 区域标题文本 | N

### TransferConfig

名称 | 类型 | 默认值 | 说明 | 必传
名称 | 类型 | 默认值 | 描述 | 必传
-- | -- | -- | -- | --
empty | String | - | 语言配置,“暂无数据”空数据描述文本 | N
placeholder | String | - | 语言配置,“请输入关键词搜索”占位符描述文本 | N
title | String | - | 语言配置,穿梭框标题描述文本,示例:“{checked} / {total} 项” | N

### TimePickerConfig

名称 | 类型 | 默认值 | 说明 | 必传
名称 | 类型 | 默认值 | 描述 | 必传
-- | -- | -- | -- | --
anteMeridiem | String | - | 语言配置,“上午”描述文本 | N
confirm | String | - | 语言配置,“确定”描述文本 | N
Expand All @@ -138,7 +140,7 @@ postMeridiem | String | - | 语言配置,“下午”描述文本 | N

### DatePickerConfig

名称 | 类型 | 默认值 | 说明 | 必传
名称 | 类型 | 默认值 | 描述 | 必传
-- | -- | -- | -- | --
confirm | String | - | 语言配置,“确定” 描述文本 | N
dayAriaLabel | String | - | 语言配置,“日” 描述文本 | N
Expand Down Expand Up @@ -167,7 +169,7 @@ yearAriaLabel | String | - | 语言配置,“年” 描述文本 | N

### DialogConfig

名称 | 类型 | 默认值 | 说明 | 必传
名称 | 类型 | 默认值 | 描述 | 必传
-- | -- | -- | -- | --
cancel | Object | - | 取消按钮风格。TS 类型:`string \| ButtonProps`[Button API Documents](./button?tab=api)[详细类型定义](https://github.com/Tencent/tdesign-vue-next/tree/develop/src/config-provider/type.ts) | N
closeOnEscKeydown | Boolean | true | 按下 ESC 时是否触发对话框关闭事件 | N
Expand All @@ -177,7 +179,7 @@ confirmBtnTheme | Object | - | 确认按钮主题色,即 Dialog 的 `theme`

### DrawerConfig

名称 | 类型 | 默认值 | 说明 | 必传
名称 | 类型 | 默认值 | 描述 | 必传
-- | -- | -- | -- | --
cancel | String | - | 语言配置,“取消”描述文本。TS 类型:`string \| ButtonProps` | N
closeOnEscKeydown | Boolean | true | 按下 ESC 时是否触发抽屉关闭事件 | N
Expand All @@ -187,15 +189,15 @@ size | String | 'small' | 尺寸配置,配置Drawer尺寸 | N

### PopconfirmConfig

名称 | 类型 | 默认值 | 说明 | 必传
名称 | 类型 | 默认值 | 描述 | 必传
-- | -- | -- | -- | --
cancel | String / Object | - | 语言配置,“取消”描述文本。TS 类型:`string \| ButtonProps`[Button API Documents](./button?tab=api)[详细类型定义](https://github.com/Tencent/tdesign-vue-next/tree/develop/src/config-provider/type.ts) | N
confirm | String / Object | - | 语言配置,“确定”描述文本。TS 类型:`string \| ButtonProps` | N
confirmBtnTheme | Object | - | 确认按钮主题色,即 Popconfirm 的 `theme` 和 确认按钮的 `theme` 映射关系。示例:{ danger: 'danger' }。TS 类型:`{ default: string; warning: string; danger: string; }` | N

### TableConfig

名称 | 类型 | 默认值 | 说明 | 必传
名称 | 类型 | 默认值 | 描述 | 必传
-- | -- | -- | -- | --
cancelText | String | - | 语言配置,“取消” 描述文本 | N
clearFilterResultButtonText | String | - | 语言配置,过滤功能中,“清空筛选” 描述文本 | N
Expand All @@ -221,7 +223,7 @@ treeExpandAndFoldIcon | Function | undefined | 树形结构,展开和折叠图

### SelectConfig

名称 | 类型 | 默认值 | 说明 | 必传
名称 | 类型 | 默认值 | 描述 | 必传
-- | -- | -- | -- | --
clearIcon | Function | - | 清除图标,【注意】使用渲染函数输出图标组件。TS 类型:`TNode`[通用类型定义](https://github.com/Tencent/tdesign-vue-next/blob/develop/src/common.ts) | N
empty | String | - | 语言配置,“暂无数据”描述文本 | N
Expand All @@ -231,29 +233,29 @@ placeholder | String | - | 语言配置,“请选择”占位符描述文本 |

### TreeConfig

名称 | 类型 | 默认值 | 说明 | 必传
名称 | 类型 | 默认值 | 描述 | 必传
-- | -- | -- | -- | --
empty | String | - | 语言配置,“暂无数据”描述文本 | N
folderIcon | Function | - | 目录层级图标,传入收起状态图标即可。【注意】使用渲染函数输出图标组件。TS 类型:`TNode`[通用类型定义](https://github.com/Tencent/tdesign-vue-next/blob/develop/src/common.ts) | N

### TreeSelectConfig

名称 | 类型 | 默认值 | 说明 | 必传
名称 | 类型 | 默认值 | 描述 | 必传
-- | -- | -- | -- | --
empty | String | - | 语言配置,“暂无数据”描述文本 | N
loadingText | String | - | 语言配置,“加载中”描述文本 | N
placeholder | String | - | 语言配置,“请选择”占位符描述文本 | N

### ListConfig

名称 | 类型 | 默认值 | 说明 | 必传
名称 | 类型 | 默认值 | 描述 | 必传
-- | -- | -- | -- | --
loadingMoreText | String | - | 语言配置,'点击加载更多' 描述文本 | N
loadingText | String | - | 语言配置,'正在加载中,请稍后' 描述文本 | N

### UploadConfig

名称 | 类型 | 默认值 | 说明 | 必传
名称 | 类型 | 默认值 | 描述 | 必传
-- | -- | -- | -- | --
cancelUploadText | String | - | 语言配置,“取消上传” 描述文本 | N
dragger | Object | - | 语言配置,拖拽相关。示例:{ dragDropText: '释放图标', draggingText: '拖拽到此区域', clickAndDragText: '点击上方“选择文件”或将文件拖到此区域' }。TS 类型:`UploadConfigDragger` | N
Expand All @@ -264,7 +266,7 @@ triggerUploadText | Object | - | 语言配置,上传功能触发文案。示

### UploadConfigProgress

名称 | 类型 | 默认值 | 说明 | 必传
名称 | 类型 | 默认值 | 描述 | 必传
-- | -- | -- | -- | --
failText | String | - | 语言配置,“上传失败”文本描述 | N
successText | String | - | 语言配置,“上传成功”文本描述 | N
Expand All @@ -273,15 +275,15 @@ waitingText | String | - | 语言配置,“待上传”文本描述 | N

### UploadConfigDragger

名称 | 类型 | 默认值 | 说明 | 必传
名称 | 类型 | 默认值 | 描述 | 必传
-- | -- | -- | -- | --
clickAndDragText | String | - | 语言配置,“ 点击上方“选择文件”或将文件拖到此区域 ” 描述文本 | N
dragDropText | String | - | 语言配置,“释放图标” 描述文本 | N
draggingText | String | - | 语言配置,'拖拽到此区域' 描述文本 | N

### UploadConfigFileList

名称 | 类型 | 默认值 | 说明 | 必传
名称 | 类型 | 默认值 | 描述 | 必传
-- | -- | -- | -- | --
fileNameText | String | - | 语言配置,“文件名” 描述文本 | N
fileOperationDateText | String | - | 语言配置,“上传日期” 描述文本 | N
Expand All @@ -291,54 +293,62 @@ fileStatusText | String | - | 语言配置,“状态” 描述文本 | N

### FormConfig

名称 | 类型 | 默认值 | 说明 | 必传
名称 | 类型 | 默认值 | 描述 | 必传
-- | -- | -- | -- | --
colonText | String | - | 字段旁边的冒号,中文为“:” | N
errorMessage | Object | - | 表单错误信息配置,示例:`{ idcard: '请输入正确的身份证号码', max: '字符长度不能超过 ${max}' }`。TS 类型:`FormErrorMessage`[Form API Documents](./form?tab=api)[详细类型定义](https://github.com/Tencent/tdesign-vue-next/tree/develop/src/config-provider/type.ts) | N
requiredMark | Boolean | true | 是否显示必填符号(*),默认显示 | N

### TagConfig

名称 | 类型 | 默认值 | 说明 | 必传
名称 | 类型 | 默认值 | 描述 | 必传
-- | -- | -- | -- | --
closeIcon | Function | - | 关闭图标,【注意】使用渲染函数输出图标组件。TS 类型:`TNode`[通用类型定义](https://github.com/Tencent/tdesign-vue-next/blob/develop/src/common.ts) | N

### StepsConfig

名称 | 类型 | 默认值 | 说明 | 必传
名称 | 类型 | 默认值 | 描述 | 必传
-- | -- | -- | -- | --
checkIcon | Slot / Function | - | 已完成步骤图标,【注意】使用渲染函数输出图标组件。TS 类型:`TNode`[通用类型定义](https://github.com/Tencent/tdesign-vue-next/blob/develop/src/common.ts) | N
errorIcon | Slot / Function | - | 错误步骤图标,【注意】使用渲染函数输出图标组件。TS 类型:`TNode`[通用类型定义](https://github.com/Tencent/tdesign-vue-next/blob/develop/src/common.ts) | N

### AlertConfig

名称 | 类型 | 默认值 | 说明 | 必传
名称 | 类型 | 默认值 | 描述 | 必传
-- | -- | -- | -- | --
collapseText | String | - | 语言配置,“收起”描述文本 | N
expandText | String | - | 语言配置,“展开更多”描述文本 | N

### DescriptionsConfig

名称 | 类型 | 默认值 | 描述 | 必传
-- | -- | -- | -- | --
colonText | String | - | 字段旁边的冒号,中文为“:” | N

### AnchorConfig

名称 | 类型 | 默认值 | 说明 | 必传
名称 | 类型 | 默认值 | 描述 | 必传
-- | -- | -- | -- | --
copySuccessText | String | - | 语言配置,“链接复制成功”描述文本 | N
copyText | String | - | 语言配置,“复制链接” 描述文本 | N

### MessageConfig

名称 | 类型 | 默认值 | 说明 | 必传
名称 | 类型 | 默认值 | 描述 | 必传
-- | -- | -- | -- | --
`MessageOptions` | \- | - | 继承 `MessageOptions` 中的全部属性 | N

### ImageConfig

名称 | 类型 | 默认值 | 说明 | 必传
名称 | 类型 | 默认值 | 描述 | 必传
-- | -- | -- | -- | --
errorText | String | - | 图片加载失败显示的文本,中文默认为“图片无法显示” | N
loadingText | String | - | 图片加载中显示的文本,中文默认为“图片加载中” | N
replaceImageSrc | Function | - | 统一替换图片 `src` 地址,参数为组件的全部属性,返回值为新的图片地址。TS 类型:`(params: ImageProps) => string`[Image API Documents](./image?tab=api)[详细类型定义](https://github.com/Tencent/tdesign-vue-next/tree/develop/src/config-provider/type.ts) | N

### ImageViewerConfig

名称 | 类型 | 默认值 | 说明 | 必传
名称 | 类型 | 默认值 | 描述 | 必传
-- | -- | -- | -- | --
errorText | String | - | 全局语言配置,默认为 “图片加载失败,可尝试重新加载” | N
mirrorTipText | String | - | 全局语言配置,默认为 “镜像” | N
Expand All @@ -347,9 +357,15 @@ rotateTipText | String | - | 全局语言配置,默认为 “旋转” | N

### GuideConfig

名称 | 类型 | 默认值 | 说明 | 必传
名称 | 类型 | 默认值 | 描述 | 必传
-- | -- | -- | -- | --
finishButtonProps | Object | - | 最后一步中的完成按钮,示例:`{ content: '完成', theme: 'primary' }`。TS 类型:`ButtonProps` | N
nextButtonProps | Object | - | 下一步按钮,示例:`{ content: '下一步', theme: 'primary' }`。TS 类型:`ButtonProps` | N
prevButtonProps | Object | - | 上一步按钮,示例:`{ content: '上一步', theme: 'default' }`。TS 类型:`ButtonProps` | N
skipButtonProps | Object | - | 跳过按钮,示例:`{ content: '跳过', theme: 'default' }`。TS 类型:`ButtonProps` | N

### RateConfig

名称 | 类型 | 默认值 | 描述 | 必传
-- | -- | -- | -- | --
rateText | Array | - | 评分描述,默认值:['极差', '失望', '一般', '满意', '惊喜']。TS 类型:`string[]` | N
Loading

0 comments on commit c6686e9

Please sign in to comment.