Skip to content

Commit

Permalink
feat(table): support TableColumnFilter.attrs
Browse files Browse the repository at this point in the history
  • Loading branch information
chaishi committed Jul 27, 2023
1 parent dbcd0d7 commit d4c7a6c
Show file tree
Hide file tree
Showing 6 changed files with 18 additions and 7 deletions.
2 changes: 1 addition & 1 deletion src/checkbox/group.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -209,7 +209,7 @@ export default defineComponent({
props={option}
index={index}
data={option}
checked={this.innerValue.includes(option.value)}
checked={this.innerValue?.includes(option.value)}
storeKey={this.storeKey}
scopedSlots={this.$scopedSlots}
></Checkbox>
Expand Down
3 changes: 3 additions & 0 deletions src/table/_example/filter-controlled.vue
Original file line number Diff line number Diff line change
Expand Up @@ -173,6 +173,9 @@ export default {
props: {
firstDayOfWeek: 7,
},
attrs: {
'data-id': 'attribute-id-value',
},
// 是否显示重置取消按钮,一般情况不需要显示
showConfirmAndReset: true,
// 日期范围是一个组件,重置时需赋值为 []
Expand Down
6 changes: 4 additions & 2 deletions src/table/filter-controller.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -134,16 +134,18 @@ export default defineComponent({
const isVueComponent = component.install && component.component;
if (typeof component === 'function' && !isVueComponent) {
return component((v: FirstParams, b: SecondParams) => {
const tProps = typeof b === 'object' && 'attrs' in b ? b.attrs : {};
const attributes = typeof b === 'object' && 'attrs' in b ? b.attrs : {};
return h(v, {
props: { ...filterComponentProps, ...tProps },
props: { ...filterComponentProps },
attrs: attributes,
on,
});
});
}
return (
<component
value={this.innerFilterValue?.[column.colKey]}
attrs={this.column.filter?.attrs}
props={{ ...filterComponentProps }}
on={{ ...on }}
></component>
Expand Down
1 change: 1 addition & 0 deletions src/table/table.en-US.md
Original file line number Diff line number Diff line change
Expand Up @@ -261,6 +261,7 @@ rowIndex | Number | - | required | Y

name | type | default | description | required
-- | -- | -- | -- | --
attrs | Array | - | html attributes of component。Typescript:`HTMLElementAttributes`[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
list | Array | - | Typescript:`Array<OptionData>`[see more ts definition](https://github.com/Tencent/tdesign-vue/blob/develop/src/common.ts) | N
Expand Down
5 changes: 3 additions & 2 deletions src/table/table.md
Original file line number Diff line number Diff line change
Expand Up @@ -261,14 +261,15 @@ rowIndex | Number | - | 必需。表格行下标,值为 `-1` 标识当前行

名称 | 类型 | 默认值 | 说明 | 必传
-- | -- | -- | -- | --
attrs | Array | - | 用于透传筛选器属性到自定义组件 `component`,HTML 原生属性。TS 类型:`HTMLElementAttributes`[通用类型定义](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
list | Array | - | 用于配置当前筛选器可选值有哪些,仅当 `filter.type` 等于 `single``multiple` 时有效。TS 类型:`Array<OptionData>`[通用类型定义](https://github.com/Tencent/tdesign-vue/blob/develop/src/common.ts) | N
popupProps | Object | - | 透传 Popup 组件全部属性到筛选器浮层。TS 类型:`PopupProps`[Popup API Documents](./popup?tab=api)[详细类型定义](https://github.com/Tencent/tdesign-vue/tree/develop/src/table/type.ts) | N
props | Array | - | 用于透传筛选器属性,可以对筛选器进行任何原组件支持的属性配置。TS 类型:`FilterProps` `type FilterProps = RadioProps \| CheckboxProps \| InputProps \| { [key: string]: any }`[Input API Documents](./input?tab=api)[详细类型定义](https://github.com/Tencent/tdesign-vue/tree/develop/src/table/type.ts) | N
props | Array | - | 用于透传筛选器属性到自定义组件 `component`,可以对筛选器进行任何原组件支持的属性配置。TS 类型:`FilterProps` `type FilterProps = RadioProps \| CheckboxProps \| InputProps \| { [key: string]: any }`[Input API Documents](./input?tab=api)[详细类型定义](https://github.com/Tencent/tdesign-vue/tree/develop/src/table/type.ts) | N
resetValue | \- | - | 重置时设置的值,示例:'' 或 []。TS 类型:`any` | N
showConfirmAndReset | Boolean | false | 是否显示重置和确认。值为真,过滤事件(filter-change)会在确定时触发;值为假,则数据变化时会立即触发过滤事件 | N
type | String | - | 用于设置筛选器类型:单选按钮筛选器、复选框筛选器、输入框筛选器。TS 类型:`FilterType` `type FilterType = 'input' \| 'single' \| 'multiple'`[详细类型定义](https://github.com/Tencent/tdesign-vue/tree/develop/src/table/type.ts) | N
type | String | - | 用于设置筛选器类型:单选按钮筛选器、复选框筛选器、输入框筛选器。更多复杂组件,请更为使用 `component` 自定义任意组件。TS 类型:`FilterType` `type FilterType = 'input' \| 'single' \| 'multiple'`[详细类型定义](https://github.com/Tencent/tdesign-vue/tree/develop/src/table/type.ts) | N

### TableColumnController

Expand Down
8 changes: 6 additions & 2 deletions src/table/type.ts
Original file line number Diff line number Diff line change
Expand Up @@ -772,6 +772,10 @@ export interface TableRowState<T extends TableRowData = TableRowData> {
}

export interface TableColumnFilter {
/**
* 用于透传筛选器属性到自定义组件 `component`,HTML 原生属性
*/
attrs?: HTMLElementAttributes;
/**
* 用于自定义筛选器,只要保证自定义筛选器包含 value 属性 和 change 事件,即可像内置筛选器一样正常使用。示例:`component: DatePicker`
*/
Expand All @@ -789,7 +793,7 @@ export interface TableColumnFilter {
*/
popupProps?: PopupProps;
/**
* 用于透传筛选器属性,可以对筛选器进行任何原组件支持的属性配置
* 用于透传筛选器属性到自定义组件 `component`,可以对筛选器进行任何原组件支持的属性配置
*/
props?: FilterProps;
/**
Expand All @@ -802,7 +806,7 @@ export interface TableColumnFilter {
*/
showConfirmAndReset?: boolean;
/**
* 用于设置筛选器类型:单选按钮筛选器、复选框筛选器、输入框筛选器
* 用于设置筛选器类型:单选按钮筛选器、复选框筛选器、输入框筛选器。更多复杂组件,请更为使用 `component` 自定义任意组件
* @default ''
*/
type?: FilterType;
Expand Down

0 comments on commit d4c7a6c

Please sign in to comment.