Skip to content

feat: table filter display #749

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

Open
Wesley-0808 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat: table filter display #749

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.
1 change: 1 addition & 0 deletions packages/products/tdesign-react/packages/components/table/table.en-US.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -250,6 +250,7 @@ attrs | Object | - | html attributes of component。Typescript：`HTMLElementAtt
classNames | String | - | component class names。Typescript：`ClassName`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N
component | TElement | - | Typescript：`ComponentType`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N
confirmEvents | Array | - | Typescript：`string[]` | N
filterDisplay | String / Function | - | Typescript：`string \| TNode<PrimaryTableFilterDisplay<T>>` `interface PrimaryTableFilterDisplay<T> { row: T; value: any }`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/table/type.ts) | N
label | String / Function | - | filter column title text, used to be showed in filter row。Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N
list | Array | - | Typescript：`Array<OptionData>`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N
listFilterConfig | Object | false | config of `filter.list`, used to filter `list`. `listFilterConfig=true` means default filter function used. `listFilterConfig.filterMethod` used to custom filter rules。Typescript：`boolean \| ListFilterConfig` `interface ListFilterConfig { filterMethod?: (item: OptionData, keyword: string) => boolean; props?: InputProps; className?: string; style?: Styles; slots?: { [key: string]: () => JSX.Element }}`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/table/type.ts) | N
Expand Down
1 change: 1 addition & 0 deletions packages/products/tdesign-react/packages/components/table/table.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -250,6 +250,7 @@ attrs | Object | - | 用于透传筛选器属性到自定义组件 `component`
classNames | String | - | 透传类名到自定义组件 `component`。TS 类型：`ClassName`。[通用类型定义](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N
component | TElement | - | 用于自定义筛选器，只要保证自定义筛选器包含 value 属性 和 change 事件，即可像内置筛选器一样正常使用。示例：`component: DatePicker`。TS 类型：`ComponentType`。[通用类型定义](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N
confirmEvents | Array | - | 哪些事件触发后会进行过滤搜索（确认按钮无需配置，会默认触发搜索）。输入框组件示例：`confirmEvents: ['onEnter']`。TS 类型：`string[]` | N
filterDisplay | String / Function | - | 自定义筛选后的文本内容。泛型 T 指表格数据类型。TS 类型：`string \| TNode<PrimaryTableFilterDisplay<T>>` `interface PrimaryTableFilterDisplay<T> { row: T; value: any }`。[通用类型定义](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts)。[详细类型定义](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/table/type.ts) | N
label | String / Function | - | 过滤项标题文本，显示在“过滤结果行”中的列标题描述。一般用于表头标题和过滤文本行中的列标题不一样的场景。TS 类型：`string \| TNode`。[通用类型定义](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N
list | Array | - | 用于配置当前筛选器可选值有哪些，仅当 `filter.type` 等于 `single` 或 `multiple` 时有效。TS 类型：`Array<OptionData>`。[通用类型定义](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N
listFilterConfig | Object | false | 选项过滤功能配置，`listFilterConfig=true` 表示使用默认过滤功能和组件风格，`listFilterConfig.filterMethod` 用于自定义过滤方法，其中 `props/className/style` 分别表示透传属性、类名、样式到输入框组件。TS 类型：`boolean \| ListFilterConfig` `interface ListFilterConfig { filterMethod?: (item: OptionData, keyword: string) => boolean; props?: InputProps; className?: string; style?: Styles; slots?: { [key: string]: () => JSX.Element }}`。[通用类型定义](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts)。[详细类型定义](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/table/type.ts) | N
Expand Down
9 changes: 9 additions & 0 deletions packages/products/tdesign-react/packages/components/table/type.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -829,6 +829,10 @@ export interface TableColumnFilter {
* 哪些事件触发后会进行过滤搜索（确认按钮无需配置，会默认触发搜索）。输入框组件示例：`confirmEvents: ['onEnter']`
*/
confirmEvents?: string[];
/**
* 自定义筛选后的文本内容。泛型 T 指表格数据类型
*/
filterDisplay?: string | TNode<PrimaryTableFilterDisplay<T>>;
/**
* 过滤项标题文本，显示在“过滤结果行”中的列标题描述。一般用于表头标题和过滤文本行中的列标题不一样的场景
*/
Expand Down Expand Up @@ -1226,6 +1230,11 @@ export interface SwapParams<T> {
targetIndex: number;
}

export interface PrimaryTableFilterDisplay<T> {
row: T;
value: any;
}

export interface ListFilterConfig {
filterMethod?: (item: OptionData, keyword: string) => boolean;
props?: InputProps;
Expand Down
1 change: 1 addition & 0 deletions packages/products/tdesign-vue-next/packages/components/table/table.en-US.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -287,6 +287,7 @@ attrs | Object | - | html attributes of component。Typescript：`HTMLElementAtt
classNames | String | - | component class names。Typescript：`ClassName`。[see more ts definition](https://github.com/Tencent/tdesign-vue-next/blob/develop/packages/components/common.ts) | N
component | Slot / Function | - | Typescript：`ComponentType`。[see more ts definition](https://github.com/Tencent/tdesign-vue-next/blob/develop/packages/components/common.ts) | N
confirmEvents | Array | - | Typescript：`string[]` | N
filterDisplay | String / Function | - | Typescript：`string \| TNode<PrimaryTableFilterDisplay<T>>` `interface PrimaryTableFilterDisplay<T> { row: T; value: any }`。[see more ts definition](https://github.com/Tencent/tdesign-vue-next/blob/develop/packages/components/common.ts)。[see more ts definition](https://github.com/Tencent/tdesign-vue-next/blob/develop/packages/components/table/type.ts) | N
label | String / Function | - | filter column title text, used to be showed in filter row。Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-vue-next/blob/develop/packages/components/common.ts) | N
list | Array | - | Typescript：`Array<OptionData>`。[see more ts definition](https://github.com/Tencent/tdesign-vue-next/blob/develop/packages/components/common.ts) | N
listFilterConfig | Object | false | config of `filter.list`, used to filter `list`. `listFilterConfig=true` means default filter function used. `listFilterConfig.filterMethod` used to custom filter rules。Typescript：`boolean \| ListFilterConfig` `interface ListFilterConfig { filterMethod?: (item: OptionData, keyword: string) => boolean; props?: InputProps; className?: string; style?: Styles; slots?: { [key: string]: () => JSX.Element }}`。[see more ts definition](https://github.com/Tencent/tdesign-vue-next/blob/develop/packages/components/common.ts)。[see more ts definition](https://github.com/Tencent/tdesign-vue-next/blob/develop/packages/components/table/type.ts) | N
Expand Down
1 change: 1 addition & 0 deletions packages/products/tdesign-vue-next/packages/components/table/table.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -287,6 +287,7 @@ attrs | Object | - | 用于透传筛选器属性到自定义组件 `component`
classNames | String | - | 透传类名到自定义组件 `component`。TS 类型：`ClassName`。[通用类型定义](https://github.com/Tencent/tdesign-vue-next/blob/develop/packages/components/common.ts) | N
component | Slot / Function | - | 用于自定义筛选器，只要保证自定义筛选器包含 value 属性 和 change 事件，即可像内置筛选器一样正常使用。示例：`component: DatePicker`。TS 类型：`ComponentType`。[通用类型定义](https://github.com/Tencent/tdesign-vue-next/blob/develop/packages/components/common.ts) | N
confirmEvents | Array | - | 哪些事件触发后会进行过滤搜索（确认按钮无需配置，会默认触发搜索）。输入框组件示例：`confirmEvents: ['onEnter']`。TS 类型：`string[]` | N
filterDisplay | String / Function | - | 自定义筛选后的文本内容。泛型 T 指表格数据类型。TS 类型：`string \| TNode<PrimaryTableFilterDisplay<T>>` `interface PrimaryTableFilterDisplay<T> { row: T; value: any }`。[通用类型定义](https://github.com/Tencent/tdesign-vue-next/blob/develop/packages/components/common.ts)。[详细类型定义](https://github.com/Tencent/tdesign-vue-next/blob/develop/packages/components/table/type.ts) | N
label | String / Function | - | 过滤项标题文本，显示在“过滤结果行”中的列标题描述。一般用于表头标题和过滤文本行中的列标题不一样的场景。TS 类型：`string \| TNode`。[通用类型定义](https://github.com/Tencent/tdesign-vue-next/blob/develop/packages/components/common.ts) | N
list | Array | - | 用于配置当前筛选器可选值有哪些，仅当 `filter.type` 等于 `single` 或 `multiple` 时有效。TS 类型：`Array<OptionData>`。[通用类型定义](https://github.com/Tencent/tdesign-vue-next/blob/develop/packages/components/common.ts) | N
listFilterConfig | Object | false | 选项过滤功能配置，`listFilterConfig=true` 表示使用默认过滤功能和组件风格，`listFilterConfig.filterMethod` 用于自定义过滤方法，其中 `props/className/style` 分别表示透传属性、类名、样式到输入框组件。TS 类型：`boolean \| ListFilterConfig` `interface ListFilterConfig { filterMethod?: (item: OptionData, keyword: string) => boolean; props?: InputProps; className?: string; style?: Styles; slots?: { [key: string]: () => JSX.Element }}`。[通用类型定义](https://github.com/Tencent/tdesign-vue-next/blob/develop/packages/components/common.ts)。[详细类型定义](https://github.com/Tencent/tdesign-vue-next/blob/develop/packages/components/table/type.ts) | N
Expand Down
9 changes: 9 additions & 0 deletions packages/products/tdesign-vue-next/packages/components/table/type.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -827,6 +827,10 @@ export interface TableColumnFilter {
* 哪些事件触发后会进行过滤搜索（确认按钮无需配置，会默认触发搜索）。输入框组件示例：`confirmEvents: ['onEnter']`
*/
confirmEvents?: string[];
/**
* 自定义筛选后的文本内容。泛型 T 指表格数据类型
*/
filterDisplay?: string | TNode<PrimaryTableFilterDisplay<T>>;
/**
* 过滤项标题文本，显示在“过滤结果行”中的列标题描述。一般用于表头标题和过滤文本行中的列标题不一样的场景
*/
Expand Down Expand Up @@ -1224,6 +1228,11 @@ export interface SwapParams<T> {
targetIndex: number;
}

export interface PrimaryTableFilterDisplay<T> {
row: T;
value: any;
}

export interface ListFilterConfig {
filterMethod?: (item: OptionData, keyword: string) => boolean;
props?: InputProps;
Expand Down
1 change: 1 addition & 0 deletions packages/products/tdesign-vue/src/table/table.en-US.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -287,6 +287,7 @@ attrs | Object | - | html attributes of component。Typescript：`HTMLElementAtt
classNames | String | - | component class names。Typescript：`ClassName`。[see more ts definition](https://github.com/Tencent/tdesign-vue/blob/develop/src/common.ts) | N
component | Slot / Function | - | Typescript：`ComponentType`。[see more ts definition](https://github.com/Tencent/tdesign-vue/blob/develop/src/common.ts) | N
confirmEvents | Array | - | Typescript：`string[]` | N
filterDisplay | String / Function | - | Typescript：`string \| TNode<PrimaryTableFilterDisplay<T>>` `interface PrimaryTableFilterDisplay<T> { row: T; value: any }`。[see more ts definition](https://github.com/Tencent/tdesign-vue/blob/develop/src/common.ts)。[see more ts definition](https://github.com/Tencent/tdesign-vue/tree/develop/src/table/type.ts) | N
label | String / Function | - | filter column title text, used to be showed in filter row。Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-vue/blob/develop/src/common.ts) | N
list | Array | - | Typescript：`Array<OptionData>`。[see more ts definition](https://github.com/Tencent/tdesign-vue/blob/develop/src/common.ts) | N
listFilterConfig | Object | false | config of `filter.list`, used to filter `list`. `listFilterConfig=true` means default filter function used. `listFilterConfig.filterMethod` used to custom filter rules。Typescript：`boolean \| ListFilterConfig` `interface ListFilterConfig { filterMethod?: (item: OptionData, keyword: string) => boolean; props?: InputProps; className?: string; style?: Styles; slots?: { [key: string]: () => JSX.Element }}`。[see more ts definition](https://github.com/Tencent/tdesign-vue/blob/develop/src/common.ts)。[see more ts definition](https://github.com/Tencent/tdesign-vue/tree/develop/src/table/type.ts) | N
Expand Down
1 change: 1 addition & 0 deletions packages/products/tdesign-vue/src/table/table.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -287,6 +287,7 @@ attrs | Object | - | 用于透传筛选器属性到自定义组件 `component`
classNames | String | - | 透传类名到自定义组件 `component`。TS 类型：`ClassName`。[通用类型定义](https://github.com/Tencent/tdesign-vue/blob/develop/src/common.ts) | N
component | Slot / Function | - | 用于自定义筛选器，只要保证自定义筛选器包含 value 属性 和 change 事件，即可像内置筛选器一样正常使用。示例：`component: DatePicker`。TS 类型：`ComponentType`。[通用类型定义](https://github.com/Tencent/tdesign-vue/blob/develop/src/common.ts) | N
confirmEvents | Array | - | 哪些事件触发后会进行过滤搜索（确认按钮无需配置，会默认触发搜索）。输入框组件示例：`confirmEvents: ['onEnter']`。TS 类型：`string[]` | N
filterDisplay | String / Function | - | 自定义筛选后的文本内容。泛型 T 指表格数据类型。TS 类型：`string \| TNode<PrimaryTableFilterDisplay<T>>` `interface PrimaryTableFilterDisplay<T> { row: T; value: any }`。[通用类型定义](https://github.com/Tencent/tdesign-vue/blob/develop/src/common.ts)。[详细类型定义](https://github.com/Tencent/tdesign-vue/tree/develop/src/table/type.ts) | N
label | String / Function | - | 过滤项标题文本，显示在“过滤结果行”中的列标题描述。一般用于表头标题和过滤文本行中的列标题不一样的场景。TS 类型：`string \| TNode`。[通用类型定义](https://github.com/Tencent/tdesign-vue/blob/develop/src/common.ts) | N
list | Array | - | 用于配置当前筛选器可选值有哪些，仅当 `filter.type` 等于 `single` 或 `multiple` 时有效。TS 类型：`Array<OptionData>`。[通用类型定义](https://github.com/Tencent/tdesign-vue/blob/develop/src/common.ts) | N
listFilterConfig | Object | false | 选项过滤功能配置，`listFilterConfig=true` 表示使用默认过滤功能和组件风格，`listFilterConfig.filterMethod` 用于自定义过滤方法，其中 `props/className/style` 分别表示透传属性、类名、样式到输入框组件。TS 类型：`boolean \| ListFilterConfig` `interface ListFilterConfig { filterMethod?: (item: OptionData, keyword: string) => boolean; props?: InputProps; className?: string; style?: Styles; slots?: { [key: string]: () => JSX.Element }}`。[通用类型定义](https://github.com/Tencent/tdesign-vue/blob/develop/src/common.ts)。[详细类型定义](https://github.com/Tencent/tdesign-vue/tree/develop/src/table/type.ts) | N
Expand Down
9 changes: 9 additions & 0 deletions packages/products/tdesign-vue/src/table/type.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -827,6 +827,10 @@ export interface TableColumnFilter {
* 哪些事件触发后会进行过滤搜索（确认按钮无需配置，会默认触发搜索）。输入框组件示例：`confirmEvents: ['onEnter']`
*/
confirmEvents?: string[];
/**
* 自定义筛选后的文本内容。泛型 T 指表格数据类型
*/
filterDisplay?: string | TNode<PrimaryTableFilterDisplay<T>>;
/**
* 过滤项标题文本，显示在“过滤结果行”中的列标题描述。一般用于表头标题和过滤文本行中的列标题不一样的场景
*/
Expand Down Expand Up @@ -1224,6 +1228,11 @@ export interface SwapParams<T> {
targetIndex: number;
}

export interface PrimaryTableFilterDisplay<T> {
row: T;
value: any;
}

export interface ListFilterConfig {
filterMethod?: (item: OptionData, keyword: string) => boolean;
props?: InputProps;
Expand Down
41 changes: 41 additions & 0 deletions packages/scripts/api.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119220,6 +119220,47 @@
"Array"
]
},
{
"id": 1761571998,
"platform_framework": [
"1",
"2"
],
"component": "TableColumnFilter",
"field_category": 1,
"field_name": "filterDisplay",
"field_type": [
"1",
"32"
],
"field_default_value": "",
"field_enum": "",
"field_desc_zh": "自定义筛选后的文本内容。泛型 T 指表格数据类型",
"field_desc_en": null,
"field_required": 0,
"event_input": "",
"create_time": "2025-10-27 13:33:18",
"update_time": "2025-10-27 13:33:18",
"event_output": null,
"custom_field_type": "string | TNode<PrimaryTableFilterDisplay<T>>【interface PrimaryTableFilterDisplay<T> { row: T; value: any }】",
"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)"
],
"field_type_text": [
"String",
"Function"
]
},
{
"id": 1693805055,
"platform_framework": [
Expand Down