Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat(global-config): add descriptions and colon rename colonText #368

Merged
merged 4 commits into from
Aug 14, 2024
Merged

feat(global-config): add descriptions and colon rename colonText #368

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
12f1321
feat(global-config): add descriptions
liweijie0812 Aug 14, 2024
484f296
chore: resolve conflict
github-actions[bot] Aug 14, 2024
e2c7fae
feat: colon rename colonText
liweijie0812 Aug 14, 2024
0ae0782
chore: resolve conflict
github-actions[bot] Aug 14, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file modified db/TDesign.db
View file
Open in desktop
Binary file not shown.
6 changes: 4 additions & 2 deletions packages/products/tdesign-react/src/config-provider/config-provider.en-US.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
:: BASE_DOC ::

## API

### GlobalConfigProvider

name | type | default | description | required
Expand All @@ -14,6 +15,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
empty | Object | - | Empty global configs。Typescript：`EmptyConfig` | N
Expand Down Expand Up @@ -264,7 +266,7 @@ fileStatusText | String | - | \- | N

name | type | default | description | required
-- | -- | -- | -- | --
colon | String | - | colon on the right of label ":" | N
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-react/blob/develop/src/config-provider/type.ts) | N
requiredMark | Boolean | true | \- | N

Expand Down Expand Up @@ -292,7 +294,7 @@ expandText | String | - | \- | N

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

### AnchorConfig

Expand Down
6 changes: 4 additions & 2 deletions packages/products/tdesign-react/src/config-provider/config-provider.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
:: BASE_DOC ::

## API

### GlobalConfigProvider

名称 | 类型 | 默认值 | 描述 | 必传
Expand All @@ -14,6 +15,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
empty | Object | - | 空状态全局配置。TS 类型：`EmptyConfig` | N
Expand Down Expand Up @@ -264,7 +266,7 @@ fileStatusText | String | - | 语言配置，“状态” 描述文本 | N

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

Expand Down Expand Up @@ -292,7 +294,7 @@ expandText | String | - | 语言配置，“展开更多”描述文本 | N

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

### AnchorConfig

Expand Down
8 changes: 6 additions & 2 deletions packages/products/tdesign-react/src/config-provider/type.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,10 @@ export interface GlobalConfigProvider {
* 日期选择器全局配置
*/
datePicker?: DatePickerConfig;
/**
* 描述全局配置
*/
descriptions?: DescriptionsConfig;
/**
* 对话框全局配置
*/
Expand Down Expand Up @@ -795,7 +799,7 @@ export interface FormConfig {
* 字段旁边的冒号，中文为“：”
* @default ''
*/
colon?: string;
colonText?: string;
/**
* 表单错误信息配置，示例：`{ idcard: '请输入正确的身份证号码', max: '字符长度不能超过 ${max}' }`
*/
Expand Down Expand Up @@ -843,7 +847,7 @@ export interface DescriptionsConfig {
* 字段旁边的冒号，中文为“：”
* @default ''
*/
colon?: string;
colonText?: string;
}

export interface AnchorConfig {
Expand Down
6 changes: 4 additions & 2 deletions packages/products/tdesign-vue-next/src/config-provider/config-provider.en-US.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
:: BASE_DOC ::

## API

### GlobalConfigProvider

name | type | default | description | required
Expand All @@ -14,6 +15,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
empty | Object | - | Empty global configs。Typescript：`EmptyConfig` | N
Expand Down Expand Up @@ -264,7 +266,7 @@ fileStatusText | String | - | \- | N

name | type | default | description | required
-- | -- | -- | -- | --
colon | String | - | colon on the right of label ":" | N
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 Down Expand Up @@ -292,7 +294,7 @@ expandText | String | - | \- | N

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

### AnchorConfig

Expand Down
6 changes: 4 additions & 2 deletions packages/products/tdesign-vue-next/src/config-provider/config-provider.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
:: BASE_DOC ::

## API

### GlobalConfigProvider

名称 | 类型 | 默认值 | 描述 | 必传
Expand All @@ -14,6 +15,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
empty | Object | - | 空状态全局配置。TS 类型：`EmptyConfig` | N
Expand Down Expand Up @@ -264,7 +266,7 @@ fileStatusText | String | - | 语言配置，“状态” 描述文本 | N

名称 | 类型 | 默认值 | 描述 | 必传
-- | -- | -- | -- | --
colon | String | - | 字段旁边的冒号，中文为“：” | N
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

Expand Down Expand Up @@ -292,7 +294,7 @@ expandText | String | - | 语言配置，“展开更多”描述文本 | N

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

### AnchorConfig

Expand Down
8 changes: 6 additions & 2 deletions packages/products/tdesign-vue-next/src/config-provider/type.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,10 @@ export interface GlobalConfigProvider {
* 日期选择器全局配置
*/
datePicker?: DatePickerConfig;
/**
* 描述全局配置
*/
descriptions?: DescriptionsConfig;
/**
* 对话框全局配置
*/
Expand Down Expand Up @@ -795,7 +799,7 @@ export interface FormConfig {
* 字段旁边的冒号，中文为“：”
* @default ''
*/
colon?: string;
colonText?: string;
/**
* 表单错误信息配置，示例：`{ idcard: '请输入正确的身份证号码', max: '字符长度不能超过 ${max}' }`
*/
Expand Down Expand Up @@ -843,7 +847,7 @@ export interface DescriptionsConfig {
* 字段旁边的冒号，中文为“：”
* @default ''
*/
colon?: string;
colonText?: string;
}

export interface AnchorConfig {
Expand Down
6 changes: 4 additions & 2 deletions packages/products/tdesign-vue/src/config-provider/config-provider.en-US.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
:: BASE_DOC ::

## API

### GlobalConfigProvider

name | type | default | description | required
Expand All @@ -14,6 +15,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
empty | Object | - | Empty global configs。Typescript：`EmptyConfig` | N
Expand Down Expand Up @@ -264,7 +266,7 @@ fileStatusText | String | - | \- | N

name | type | default | description | required
-- | -- | -- | -- | --
colon | String | - | colon on the right of label ":" | N
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/tree/develop/src/config-provider/type.ts) | N
requiredMark | Boolean | true | \- | N

Expand Down Expand Up @@ -292,7 +294,7 @@ expandText | String | - | \- | N

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

### AnchorConfig

Expand Down
6 changes: 4 additions & 2 deletions packages/products/tdesign-vue/src/config-provider/config-provider.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
:: BASE_DOC ::

## API

### GlobalConfigProvider

名称 | 类型 | 默认值 | 描述 | 必传
Expand All @@ -14,6 +15,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
empty | Object | - | 空状态全局配置。TS 类型：`EmptyConfig` | N
Expand Down Expand Up @@ -264,7 +266,7 @@ fileStatusText | String | - | 语言配置，“状态” 描述文本 | N

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

Expand Down Expand Up @@ -292,7 +294,7 @@ expandText | String | - | 语言配置，“展开更多”描述文本 | N

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

### AnchorConfig

Expand Down
8 changes: 6 additions & 2 deletions packages/products/tdesign-vue/src/config-provider/type.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,10 @@ export interface GlobalConfigProvider {
* 日期选择器全局配置
*/
datePicker?: DatePickerConfig;
/**
* 描述全局配置
*/
descriptions?: DescriptionsConfig;
/**
* 对话框全局配置
*/
Expand Down Expand Up @@ -795,7 +799,7 @@ export interface FormConfig {
* 字段旁边的冒号，中文为“：”
* @default ''
*/
colon?: string;
colonText?: string;
/**
* 表单错误信息配置，示例：`{ idcard: '请输入正确的身份证号码', max: '字符长度不能超过 ${max}' }`
*/
Expand Down Expand Up @@ -843,7 +847,7 @@ export interface DescriptionsConfig {
* 字段旁边的冒号，中文为“：”
* @default ''
*/
colon?: string;
colonText?: string;
}

export interface AnchorConfig {
Expand Down
45 changes: 43 additions & 2 deletions packages/scripts/api.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37971,7 +37971,7 @@
],
"component": "DescriptionsConfig",
"field_category": 1,
"field_name": "colon",
"field_name": "colonText",
"field_type": [
"1"
],
Expand Down Expand Up @@ -50172,7 +50172,7 @@
],
"component": "FormConfig",
"field_category": 1,
"field_name": "colon",
"field_name": "colonText",
"field_type": [
"1"
],
Expand Down Expand Up @@ -53281,6 +53281,47 @@
"Object"
]
},
{
"id": 1723620343,
"platform_framework": [
"1",
"2",
"4"
],
"component": "GlobalConfigProvider",
"field_category": 1,
"field_name": "descriptions",
"field_type": [
"8"
],
"field_default_value": "",
"field_enum": "",
"field_desc_zh": "描述全局配置",
"field_desc_en": "Descriptions global configs",
"field_required": 0,
"event_input": "",
"create_time": "2024-08-14 07:25:43",
"update_time": "2024-08-14 07:25:43",
"event_output": null,
"custom_field_type": "DescriptionsConfig",
"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(PC)",
"React(PC)",
"Angular(PC)"
],
"field_type_text": [
"Object"
]
},
{
"id": 1878,
"platform_framework": [
Expand Down
Loading