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

feat: table global size config #236

Merged
merged 1 commit into from
Mar 1, 2024
Merged

feat: table global size config #236

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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.
17 changes: 12 additions & 5 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,7 +1,6 @@
:: BASE_DOC ::

## API

### GlobalConfigProvider

name | type | default | description | required
Expand Down Expand Up @@ -59,7 +58,7 @@ name | type | default | description | required
cellMonth | String | - | \- | N
controllerConfig | Object | - | Typescript：`CalendarController`，[Calendar API Documents](./calendar?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/src/config-provider/type.ts) | N
fillWithZero | Boolean | true | \- | N
firstDayOfWeek | Number | 1 | options：1/2/3/4/5/6/7 | N
firstDayOfWeek | Number | 1 | options: 1/2/3/4/5/6/7 | N
hideWeekend | String | - | \- | N
monthRadio | String | - | \- | N
monthSelection | String | - | \- | N
Expand Down Expand Up @@ -112,7 +111,7 @@ confirm | String | - | confirm text | N
dayAriaLabel | String | - | date text | N
dayjsLocale | String | - | dayjs language international configuration | N
direction | String | 'ltr' | range separator text | N
firstDayOfWeek | Number | 7 | options：1/2/3/4/5/6/7 | N
firstDayOfWeek | Number | 7 | options: 1/2/3/4/5/6/7 | N
format | String | 'YYYY-MM-DD' | date format rules | N
monthAriaLabel | String | - | month text | N
months | Array | - | Typescript：`string[]` | N
Expand All @@ -138,7 +137,7 @@ yearAriaLabel | String | - | year text | N
name | type | default | description | required
-- | -- | -- | -- | --
cancel | Object | - | Typescript：`string \| ButtonProps`，[Button API Documents](./button?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/src/config-provider/type.ts) | N
closeOnEscKeydown | Boolean | true | \- | N
closeOnEscKeydown | Boolean | true | trigger dialog close on `ESC` keydown | N
closeOnOverlayClick | Boolean | true | \- | N
confirm | Object | - | Typescript：`string \| ButtonProps` | N
confirmBtnTheme | Object | - | Typescript：`{ default: string; info: string; warning: string; danger: string; success: string; }` | N
Expand All @@ -148,7 +147,7 @@ confirmBtnTheme | Object | - | Typescript：`{ default: string; info: string; wa
name | type | default | description | required
-- | -- | -- | -- | --
cancel | String | - | Typescript：`string \| ButtonProps` | N
closeOnEscKeydown | Boolean | true | \- | N
closeOnEscKeydown | Boolean | true | trigger drawer close event on `ESC` keydown | N
closeOnOverlayClick | Boolean | true | \- | N
confirm | String | - | Typescript：`string \| ButtonProps` | N
size | String | 'small' | \- | N
Expand Down Expand Up @@ -180,6 +179,7 @@ loadingText | String | - | \- | N
resetText | String | - | \- | N
searchResultText | String | - | \- | N
selectAllText | String | - | \- | N
size | String | medium | options: small/medium/large。Typescript：`SizeEnum`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/src/common.ts) | N
sortAscendingOperationText | String | - | \- | N
sortCancelOperationText | String | - | \- | N
sortDescendingOperationText | String | - | \- | N
Expand Down Expand Up @@ -260,6 +260,7 @@ fileStatusText | String | - | \- | N

name | type | default | description | required
-- | -- | -- | -- | --
colon | 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 All @@ -282,6 +283,12 @@ name | type | default | description | required
collapseText | String | - | \- | N
expandText | String | - | \- | N

### DescriptionsConfig

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

### AnchorConfig

name | type | default | description | required
Expand Down
9 changes: 8 additions & 1 deletion 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,7 +1,6 @@
:: BASE_DOC ::

## API

### GlobalConfigProvider

名称 | 类型 | 默认值 | 说明 | 必传
Expand Down Expand Up @@ -180,6 +179,7 @@ loadingText | String | - | 语言配置，“正在加载中，请稍后” 描
resetText | String | - | 语言配置，“重置” 描述文本 | N
searchResultText | String | - | 语言配置，过滤功能中，过滤条件和结果描述文本，示例：'搜索“{result}”，找到 {count} 条结果' | N
selectAllText | String | - | 语言配置，'全选' 描述文本 | N
size | String | medium | 全局表格尺寸配置。可选项：small/medium/large。TS 类型：`SizeEnum`。[通用类型定义](https://github.com/Tencent/tdesign-react/blob/develop/src/common.ts) | N
sortAscendingOperationText | String | - | 语言配置，'点击升序' 描述文本 | N
sortCancelOperationText | String | - | 语言配置，'点击取消排序' 描述文本 | N
sortDescendingOperationText | String | - | 语言配置，'点击降序' 描述文本 | N
Expand Down Expand Up @@ -260,6 +260,7 @@ fileStatusText | String | - | 语言配置，“状态” 描述文本 | N

名称 | 类型 | 默认值 | 说明 | 必传
-- | -- | -- | -- | --
colon | 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 All @@ -282,6 +283,12 @@ errorIcon | TElement | - | 错误步骤图标，【注意】使用渲染函数
collapseText | String | - | 语言配置，“收起”描述文本 | N
expandText | String | - | 语言配置，“展开更多”描述文本 | N

### DescriptionsConfig

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

### AnchorConfig

名称 | 类型 | 默认值 | 说明 | 必传
Expand Down
42 changes: 38 additions & 4 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
Expand Up @@ -18,6 +18,8 @@ drawer | Object | - | Drawer global configs。Typescript：`DrawerConfig` | N
form | Object | - | Form global configs。Typescript：`FormConfig` | N
guide | Object | - | Guide global configs。Typescript：`GuideConfig` | N
icon | Object | - | icon config。Typescript：`IconConfig` `type IconConfig = GlobalIconConfig` `import { GlobalIconConfig } from '@icon'`。[see more ts definition](https://github.com/Tencent/tdesign-vue-next/tree/develop/src/config-provider/type.ts) | N
image | Object | - | image global configs。Typescript：`ImageConfig` | N
imageViewer | Object | - | imageViewer global configs。Typescript：`ImageViewerConfig` | N
input | Object | - | Input global configs。Typescript：`InputConfig` | N
list | Object | - | List global configs。Typescript：`ListConfig` | N
message | Object | - | Message Component global configs。Typescript：`MessageConfig` | N
Expand Down Expand Up @@ -56,7 +58,7 @@ name | type | default | description | required
cellMonth | String | - | \- | N
controllerConfig | Object | - | Typescript：`CalendarController`，[Calendar API Documents](./calendar?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-vue-next/tree/develop/src/config-provider/type.ts) | N
fillWithZero | Boolean | true | \- | N
firstDayOfWeek | Number | 1 | options：1/2/3/4/5/6/7 | N
firstDayOfWeek | Number | 1 | options: 1/2/3/4/5/6/7 | N
hideWeekend | String | - | \- | N
monthRadio | String | - | \- | N
monthSelection | String | - | \- | N
Expand Down Expand Up @@ -107,8 +109,9 @@ name | type | default | description | required
-- | -- | -- | -- | --
confirm | String | - | confirm text | N
dayAriaLabel | String | - | date text | N
dayjsLocale | String | - | dayjs language international configuration | N
direction | String | 'ltr' | range separator text | N
firstDayOfWeek | Number | 7 | options：1/2/3/4/5/6/7 | N
firstDayOfWeek | Number | 7 | options: 1/2/3/4/5/6/7 | N
format | String | 'YYYY-MM-DD' | date format rules | N
monthAriaLabel | String | - | month text | N
months | Array | - | Typescript：`string[]` | N
Expand All @@ -134,7 +137,7 @@ yearAriaLabel | String | - | year text | N
name | type | default | description | required
-- | -- | -- | -- | --
cancel | Object | - | Typescript：`string \| ButtonProps`，[Button API Documents](./button?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-vue-next/tree/develop/src/config-provider/type.ts) | N
closeOnEscKeydown | Boolean | true | \- | N
closeOnEscKeydown | Boolean | true | trigger dialog close on `ESC` keydown | N
closeOnOverlayClick | Boolean | true | \- | N
confirm | Object | - | Typescript：`string \| ButtonProps` | N
confirmBtnTheme | Object | - | Typescript：`{ default: string; info: string; warning: string; danger: string; success: string; }` | N
Expand All @@ -144,7 +147,7 @@ confirmBtnTheme | Object | - | Typescript：`{ default: string; info: string; wa
name | type | default | description | required
-- | -- | -- | -- | --
cancel | String | - | Typescript：`string \| ButtonProps` | N
closeOnEscKeydown | Boolean | true | \- | N
closeOnEscKeydown | Boolean | true | trigger drawer close event on `ESC` keydown | N
closeOnOverlayClick | Boolean | true | \- | N
confirm | String | - | Typescript：`string \| ButtonProps` | N
size | String | 'small' | \- | N
Expand Down Expand Up @@ -176,6 +179,7 @@ loadingText | String | - | \- | N
resetText | String | - | \- | N
searchResultText | String | - | \- | N
selectAllText | String | - | \- | N
size | String | medium | options: small/medium/large。Typescript：`SizeEnum`。[see more ts definition](https://github.com/Tencent/tdesign-vue-next/blob/develop/src/common.ts) | N
sortAscendingOperationText | String | - | \- | N
sortCancelOperationText | String | - | \- | N
sortDescendingOperationText | String | - | \- | N
Expand Down Expand Up @@ -256,6 +260,7 @@ fileStatusText | String | - | \- | N

name | type | default | description | required
-- | -- | -- | -- | --
colon | 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 @@ -278,13 +283,42 @@ name | type | default | description | required
collapseText | String | - | \- | N
expandText | String | - | \- | N

### DescriptionsConfig

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

### AnchorConfig

name | type | default | description | required
-- | -- | -- | -- | --
copySuccessText | String | - | \- | N
copyText | String | - | \- | N

### MessageConfig

name | type | default | description | required
-- | -- | -- | -- | --
`MessageOptions` | \- | - | extends `MessageOptions` | N

### ImageConfig

name | type | default | description | required
-- | -- | -- | -- | --
errorText | String | - | loading text, default value is "Error" | N
loadingText | String | - | loading text, default value is "loading" | N
replaceImageSrc | Function | - | replace all `src` attribute of images。Typescript：`(params: ImageProps) => string`，[Image API Documents](./image?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-vue-next/tree/develop/src/config-provider/type.ts) | N

### ImageViewerConfig

name | type | default | description | required
-- | -- | -- | -- | --
errorText | String | - | \- | N
mirrorTipText | String | - | mirror operation text | N
originalSizeTipText | String | - | original size tips | N
rotateTipText | String | - | rotate operation text | N

### GuideConfig

name | type | default | description | required
Expand Down
34 changes: 34 additions & 0 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
Expand Up @@ -18,6 +18,8 @@ drawer | Object | - | 抽屉全局配置。TS 类型：`DrawerConfig` | N
form | Object | - | 表单组件全局配置。TS 类型：`FormConfig` | N
guide | Object | - | 引导全局配置。TS 类型：`GuideConfig` | N
icon | Object | - | 图标全局配置。TS 类型：`IconConfig` `type IconConfig = GlobalIconConfig` `import { GlobalIconConfig } from '@icon'`。[详细类型定义](https://github.com/Tencent/tdesign-vue-next/tree/develop/src/config-provider/type.ts) | N
image | Object | - | 图片全局配置。TS 类型：`ImageConfig` | N
imageViewer | Object | - | 图片预览器全局配置。TS 类型：`ImageViewerConfig` | N
input | Object | - | 输入框组件全局配置。TS 类型：`InputConfig` | N
list | Object | - | 列表组件全局配置。TS 类型：`ListConfig` | N
message | Object | - | 消息组件全局配置。TS 类型：`MessageConfig` | N
Expand Down Expand Up @@ -107,6 +109,7 @@ postMeridiem | String | - | 语言配置，“下午”描述文本 | N
-- | -- | -- | -- | --
confirm | String | - | 语言配置，“确定” 描述文本 | N
dayAriaLabel | String | - | 语言配置，“日” 描述文本 | N
dayjsLocale | String | - | dayjs 语言国际化配置 | N
direction | String | 'ltr' | 日期方向，'ltr' 表示从左往右 | N
firstDayOfWeek | Number | 7 | 第一天从星期几开始。可选项：1/2/3/4/5/6/7 | N
format | String | 'YYYY-MM-DD' | 日期格式化规则 | N
Expand Down Expand Up @@ -176,6 +179,7 @@ loadingText | String | - | 语言配置，“正在加载中，请稍后” 描
resetText | String | - | 语言配置，“重置” 描述文本 | N
searchResultText | String | - | 语言配置，过滤功能中，过滤条件和结果描述文本，示例：'搜索“{result}”，找到 {count} 条结果' | N
selectAllText | String | - | 语言配置，'全选' 描述文本 | N
size | String | medium | 全局表格尺寸配置。可选项：small/medium/large。TS 类型：`SizeEnum`。[通用类型定义](https://github.com/Tencent/tdesign-vue-next/blob/develop/src/common.ts) | N
sortAscendingOperationText | String | - | 语言配置，'点击升序' 描述文本 | N
sortCancelOperationText | String | - | 语言配置，'点击取消排序' 描述文本 | N
sortDescendingOperationText | String | - | 语言配置，'点击降序' 描述文本 | N
Expand Down Expand Up @@ -256,6 +260,7 @@ fileStatusText | String | - | 语言配置，“状态” 描述文本 | N

名称 | 类型 | 默认值 | 说明 | 必传
-- | -- | -- | -- | --
colon | 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 All @@ -278,13 +283,42 @@ errorIcon | Slot / Function | - | 错误步骤图标，【注意】使用渲染
collapseText | String | - | 语言配置，“收起”描述文本 | N
expandText | String | - | 语言配置，“展开更多”描述文本 | N

### DescriptionsConfig

名称 | 类型 | 默认值 | 说明 | 必传
-- | -- | -- | -- | --
colon | 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
originalSizeTipText | String | - | 全局语言配置，默认为 “原始大小” | N
rotateTipText | String | - | 全局语言配置，默认为 “旋转” | N

### GuideConfig

名称 | 类型 | 默认值 | 说明 | 必传
Expand Down
Loading
Loading