Skip to content

useTableFilterState

@astryxdesign/core v0.7.1 · useTableFilterState

参数 ​

useTableFilterState() 只有一个可选参数,两种写法都行。

名称类型默认值说明
initialTableFilterState{}直接给初始过滤映射。它是浅拷贝的,你传进去的对象不会被写。
initial.initialStateTableFilterState{}把同一份映射放在 initialState 键里:useTableFilterState({ initialState })。过滤值不可能是对象,所以键名叫 initialState 且值是对象时,只可能是这种写法。

返回值 ​

名称类型说明
filtersRef<TableFilterState>活的过滤映射。读 filters.value 拿到当前状态。
onFilterChange(key: string, value: TableFilterValue | null) => void设置或清掉一个字段。映射会换成新对象,所以用 getter 读它的地方会跟着更新。
clearAll() => void清空整张映射。所有过滤一起关掉。

TableFilterState ​

名称类型说明
[fieldKey]TableFilterValue字段 key 到过滤值的映射。TableFilterValue 是 string | number | string[]。