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.

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: 支持季度国际化配置 #1267

Merged
merged 1 commit into from
Aug 10, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
11 changes: 9 additions & 2 deletions examples/config-provider/config-provider.en-US.md
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 @@ -35,6 +34,7 @@ upload | Object | - | Upload global configs。Typescript:`UploadConfig` | N

name | type | default | description | required
-- | -- | -- | -- | --
autocomplete | String | - | \- | N
placeholder | String | - | \- | N

### PaginationConfig
Expand Down Expand Up @@ -116,8 +116,9 @@ now | String | - | now text | N
placeholder | Object | - | Typescript:`{ date?: string; month?: string; year?: string }` | N
preDecade | String | - | pre decade text | N
preMonth | String | - | pre month text | N
presets | Object | - | Typescript:`ConfigPresetDate` `interface ConfigPresetDate { [name: string]: DateConfigValue | (() => DateConfigValue) }` `type DateConfigValue = string | Date | Array<DateConfigValue>`。[see more ts definition](https://github.com/Tencent/tdesign-vue/tree/develop/src/config-provider/type.ts) | N
preYear | String | - | pre year text | N
presets | Object | - | Typescript:`ConfigPresetDate` `interface ConfigPresetDate { [name: string]: DateConfigValue | (() => DateConfigValue) }` `type DateConfigValue = string | Date | Array<DateConfigValue>`。[see more ts definition](https://github.com/Tencent/tdesign-vue/tree/develop/src/config-provider/type.ts) | N
quarters | Array | - | Typescript:`string[]` | N
rangeSeparator | String | - | range separator text | N
selectDate | String | - | select date text | N
selectTime | String | - | select time text | N
Expand All @@ -130,6 +131,8 @@ 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/tree/develop/src/config-provider/type.ts) | N
closeOnEscKeydown | Boolean | true | \- | 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 @@ -138,7 +141,10 @@ confirmBtnTheme | Object | - | Typescript:`{ default: string; info: string; wa
name | type | default | description | required
-- | -- | -- | -- | --
cancel | String | - | Typescript:`string | ButtonProps` | N
closeOnEscKeydown | Boolean | true | \- | N
closeOnOverlayClick | Boolean | true | \- | N
confirm | String | - | Typescript:`string | ButtonProps` | N
size | String | small | \- | N

### PopconfirmConfig

Expand Down Expand Up @@ -179,6 +185,7 @@ name | type | default | description | required
-- | -- | -- | -- | --
clearIcon | Function | - | Typescript:`TNode`。[see more ts definition](https://github.com/Tencent/tdesign-vue/blob/develop/src/common.ts) | N
empty | String | - | \- | N
filterable | Boolean | false | \- | N
loadingText | String | - | \- | N
placeholder | String | - | placeholder text | N

Expand Down
23 changes: 12 additions & 11 deletions examples/config-provider/config-provider.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ fillWithZero | Boolean | true | 当日期数字小于 10 时,是否使用 '0'
firstDayOfWeek | Number | 1 | 第一天从星期几开始。可选项:1/2/3/4/5/6/7 | N
hideWeekend | String | - | 语言配置,“隐藏周末”描述文本 | N
monthRadio | String | - | 语言配置,模式切换时的“月”描述文本 | N
monthSelection | String | - | 语言配置,"月"选择描述文本。示例:`'{month} 月'` | N
monthSelection | String | - | 语言配置,\"月\"选择描述文本。示例:`'{month} 月'` | N
showWeekend | String | - | 语言配置,“显示周末”描述文本 | N
thisMonth | String | - | 语言配置,“本月”描述文本 | N
today | String | - | 语言配置,“今天”描述文本 | N
Expand All @@ -78,7 +78,7 @@ placeholder | String | - | 语言配置,“请选择”占位描述文本 | N
-- | -- | -- | -- | --
clearConfirmText | String | - | 语言配置,“确定清空最近使用的颜色吗?”清空颜色确认文案 | N
recentColorTitle | String | - | 语言配置,“最近使用颜色” 区域标题文本 | N
swatchColorTitle | String | - | 语言配置,"系统预设颜色" 区域标题文本 | N
swatchColorTitle | String | - | 语言配置,\"系统预设颜色\" 区域标题文本 | N

### TransferConfig

Expand All @@ -95,7 +95,7 @@ title | String | - | 语言配置,穿梭框标题描述文本,示例:“{c
anteMeridiem | String | - | 语言配置,“上午”描述文本 | N
confirm | String | - | 语言配置,“确定”描述文本 | N
now | String | - | 语言配置,“此刻”描述文本 | N
placeholder | String | - | 语言配置,"请选择时间"占位符描述文本 | N
placeholder | String | - | 语言配置,\"请选择时间\"占位符描述文本 | N
postMeridiem | String | - | 语言配置,“下午”描述文本 | N

### DatePickerConfig
Expand All @@ -108,16 +108,17 @@ direction | String | 'ltr' | 日期方向,'ltr' 表示从左往右 | N
firstDayOfWeek | Number | 7 | 第一天从星期几开始。可选项:1/2/3/4/5/6/7 | N
format | String | 'YYYY-MM-DD' | 日期格式化规则 | N
monthAriaLabel | String | - | 语言配置,“月” 描述文本 | N
months | Array | - | 星期文本描述,默认值:['一月', '二月', '三月', '四月', '五月', '六月', '七月', '八月', '九月', '十月', '十一月', '十二月']。TS 类型:`string[]` | N
months | Array | - | 星期文本描述,默认值:['1 月', '2 月', '3 月', '4 月', '5 月', '6 月', '7 月', '8 月', '9 月', '10 月', '11 月', '12 月']。TS 类型:`string[]` | N
nextDecade | String | - | 语言配置,“下个十年” 描述文本 | N
nextMonth | String | - | 语言配置,“下个月” 描述文本 | N
nextYear | String | - | 语言配置,“下一年” 描述文本 | N
now | String | - | 语言配置,“此刻” 描述文本 | N
placeholder | Object | - | 占位符文本提示,默认值:`{ date: '请选择日期', month: '请选择月份', year: '请选择年份' }`。TS 类型:`{ date?: string; month?: string; year?: string }` | N
preDecade | String | - | 语言配置,“上个十年” 描述文本 | N
preMonth | String | - | 语言配置,“上个月” 描述文本 | N
presets | Object | - | 【暂不支持,讨论确认中】预设快捷日期选择,示例:`{ '元旦': '2021-01-01', '昨天': dayjs().subtract(1, 'day').format('YYYY-MM-DD'), '特定日期': () => ['2021-02-01'] }`。TS 类型:`ConfigPresetDate` `interface ConfigPresetDate { [name: string]: DateConfigValue | (() => DateConfigValue) }` `type DateConfigValue = string | Date | Array<DateConfigValue>`。[详细类型定义](https://github.com/Tencent/tdesign-vue/tree/develop/src/config-provider/type.ts) | N
preYear | String | - | 语言配置,“上一年” 描述文本 | N
presets | Object | - | 【暂不支持,讨论确认中】预设快捷日期选择,示例:`{ '元旦': '2021-01-01', '昨天': dayjs().subtract(1, 'day').format('YYYY-MM-DD'), '特定日期': () => ['2021-02-01'] }`。TS 类型:`ConfigPresetDate` `interface ConfigPresetDate { [name: string]: DateConfigValue | (() => DateConfigValue) }` `type DateConfigValue = string | Date | Array<DateConfigValue>`。[详细类型定义](https://github.com/Tencent/tdesign-vue/tree/develop/src/config-provider/type.ts) | N
quarters | Array | - | 季度文本描述,默认值:['1 季度', '2 季度', '3 季度', '4 季度']。TS 类型:`string[]` | N
rangeSeparator | String | - | 语言配置,“ 至 ” 范围分隔符描述文本,示例:' ~ ' | N
selectDate | String | - | 语言配置,“选择日期” 描述文本 | N
selectTime | String | - | 语言配置,“选择时间” 描述文本 | N
Expand All @@ -130,8 +131,8 @@ yearAriaLabel | String | - | 语言配置,“年” 描述文本 | N
名称 | 类型 | 默认值 | 说明 | 必传
-- | -- | -- | -- | --
cancel | Object | - | 取消按钮风格。TS 类型:`string | ButtonProps`,[Button API Documents](./button?tab=api)。[详细类型定义](https://github.com/Tencent/tdesign-vue/tree/develop/src/config-provider/type.ts) | N
closeOnEscKeydown | Boolean | - | 按下 ESC 时是否触发对话框关闭事件 | N
closeOnOverlayClick | Boolean | - | 点击蒙层时是否触发关闭事件 | N
closeOnEscKeydown | Boolean | true | 按下 ESC 时是否触发对话框关闭事件 | N
closeOnOverlayClick | Boolean | true | 点击蒙层时是否触发关闭事件 | N
confirm | Object | - | 确认按钮风格。TS 类型:`string | ButtonProps` | N
confirmBtnTheme | Object | - | 确认按钮主题色,即 Dialog 的 `theme` 和 确认按钮的 `theme` 映射关系。示例:{ danger: 'danger' }。TS 类型:`{ default: string; info: string; warning: string; danger: string; success: string; }` | N

Expand All @@ -140,10 +141,10 @@ confirmBtnTheme | Object | - | 确认按钮主题色,即 Dialog 的 `theme`
名称 | 类型 | 默认值 | 说明 | 必传
-- | -- | -- | -- | --
cancel | String | - | 语言配置,“取消”描述文本。TS 类型:`string | ButtonProps` | N
closeOnEscKeydown | Boolean | - | 按下 ESC 时是否触发抽屉关闭事件 | N
closeOnOverlayClick | Boolean | - | 点击蒙层时是否触发关闭事件 | N
closeOnEscKeydown | Boolean | true | 按下 ESC 时是否触发抽屉关闭事件 | N
closeOnOverlayClick | Boolean | true | 点击蒙层时是否触发关闭事件 | N
confirm | String | - | 语言配置,“确认”描述文本。TS 类型:`string | ButtonProps` | N
size | String | - | 尺寸配置,配置Drawer尺寸 | N
size | String | small | 尺寸配置,配置Drawer尺寸 | N

### PopconfirmConfig

Expand Down Expand Up @@ -184,7 +185,7 @@ treeExpandAndFoldIcon | Function | undefined | 树形结构,展开和折叠图
-- | -- | -- | -- | --
clearIcon | Function | - | 清除图标,【注意】使用渲染函数输出图标组件。TS 类型:`TNode`。[通用类型定义](https://github.com/Tencent/tdesign-vue/blob/develop/src/common.ts) | N
empty | String | - | 语言配置,“暂无数据”描述文本 | N
filterable | Boolean | - | 全局配置是否可筛选 | N
filterable | Boolean | false | 全局配置是否可筛选 | N
loadingText | String | - | 语言配置,“加载中”描述文本 | N
placeholder | String | - | 语言配置,“请选择”占位符描述文本 | N

Expand Down
25 changes: 17 additions & 8 deletions src/config-provider/type.ts
Original file line number Diff line number Diff line change
Expand Up @@ -176,7 +176,7 @@ export interface CalendarConfig {
*/
monthRadio?: string;
/**
* 语言配置,"月"选择描述文本。示例:`'{month} 月'`
* 语言配置,\"月\"选择描述文本。示例:`'{month} 月'`
* @default ''
*/
monthSelection?: string;
Expand Down Expand Up @@ -242,7 +242,7 @@ export interface ColorPickerConfig {
*/
recentColorTitle?: string;
/**
* 语言配置,"系统预设颜色" 区域标题文本
* 语言配置,\"系统预设颜色\" 区域标题文本
* @default ''
*/
swatchColorTitle?: string;
Expand Down Expand Up @@ -283,7 +283,7 @@ export interface TimePickerConfig {
*/
now?: string;
/**
* 语言配置,"请选择时间"占位符描述文本
* 语言配置,\"请选择时间\"占位符描述文本
* @default ''
*/
placeholder?: string;
Expand Down Expand Up @@ -326,7 +326,7 @@ export interface DatePickerConfig {
*/
monthAriaLabel?: string;
/**
* 星期文本描述,默认值:['一月', '二月', '三月', '四月', '五月', '六月', '七月', '八月', '九月', '十月', '十一月', '十二月']
* 星期文本描述,默认值:['1 月', '2 月', '3 月', '4 月', '5 月', '6 月', '7 月', '8 月', '9 月', '10 月', '11 月', '12 月']
*/
months?: string[];
/**
Expand Down Expand Up @@ -363,15 +363,19 @@ export interface DatePickerConfig {
* @default ''
*/
preMonth?: string;
/**
* 语言配置,“上一年” 描述文本
* @default ''
*/
preYear?: string;
/**
* 【暂不支持,讨论确认中】预设快捷日期选择,示例:`{ '元旦': '2021-01-01', '昨天': dayjs().subtract(1, 'day').format('YYYY-MM-DD'), '特定日期': () => ['2021-02-01'] }`
*/
presets?: ConfigPresetDate;
/**
* 语言配置,“上一年” 描述文本
* @default ''
* 季度文本描述,默认值:['1 季度', '2 季度', '3 季度', '4 季度']
*/
preYear?: string;
quarters?: string[];
/**
* 语言配置,“ 至 ” 范围分隔符描述文本,示例:' ~ '
* @default ''
Expand Down Expand Up @@ -410,10 +414,12 @@ export interface DialogConfig {
cancel?: string | ButtonProps;
/**
* 按下 ESC 时是否触发对话框关闭事件
* @default true
*/
closeOnEscKeydown?: boolean;
/**
* 点击蒙层时是否触发关闭事件
* @default true
*/
closeOnOverlayClick?: boolean;
/**
Expand All @@ -434,10 +440,12 @@ export interface DrawerConfig {
cancel?: string | ButtonProps;
/**
* 按下 ESC 时是否触发抽屉关闭事件
* @default true
*/
closeOnEscKeydown?: boolean;
/**
* 点击蒙层时是否触发关闭事件
* @default true
*/
closeOnOverlayClick?: boolean;
/**
Expand All @@ -447,7 +455,7 @@ export interface DrawerConfig {
confirm?: string | ButtonProps;
/**
* 尺寸配置,配置Drawer尺寸
* @default ''
* @default small
*/
size?: string;
}
Expand Down Expand Up @@ -577,6 +585,7 @@ export interface SelectConfig {
empty?: string;
/**
* 全局配置是否可筛选
* @default false
*/
filterable?: boolean;
/**
Expand Down
1 change: 1 addition & 0 deletions src/date-picker/hooks/useTableData.ts
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ export default function useTableData(props: any) {
disableDate: props.disableDate,
firstDayOfWeek: props.firstDayOfWeek ?? global.value.firstDayOfWeek,
monthLocal: global.value.months,
quarterLocal: global.value.quarters,
showWeekOfYear: props.mode === 'week',
};

Expand Down