Filter options and change events
columnFiltering filters a parent-owned array on the client. Its presence disables row drag even with an empty model. Connect both controlled values and callbacks for the filter button and editor.
Operators and values
Section titled “Operators and values”| kind | Supported operators |
|---|---|
| text | contains, notContains, startsWith, endsWith, equals, notEquals, isEmpty, isNotEmpty |
| number / date | equals, notEquals, greaterThan, greaterThanOrEqual, lessThan, lessThanOrEqual, between, isEmpty, isNotEmpty |
| boolean | equals, notEquals, isEmpty, isNotEmpty |
Dates use UTC calendar days. Invalid dates, values, and operator rules are ignored; no valid rules means all rows are shown. For text, whitespace is a value; only null/undefined/empty strings are empty. Filtering does not reorder source data. Hidden selected row IDs are retained, while cell/range selections that depend on visible coordinates may be cleared.
CominsColumnFilteringConfig
Section titled “CominsColumnFilteringConfig”model: CominsColumnFilterModel;Required complete rule array. Empty means no filters. Different columns combine with AND; only the first valid rule per column applies.
onChangeModel
Section titled “onChangeModel”onChangeModel?: (model: CominsColumnFilterRule[]) => void;Receives the full next model after editing/removal. The editor is read-only without it.
openColumnId
Section titled “openColumnId”openColumnId?: string | null;Currently open column ID or null. No filter is open when omitted.
onChangeOpenColumnId
Section titled “onChangeOpenColumnId”onChangeOpenColumnId?: (columnId: string | null) => void;Receives the next ID or null when opening/closing. The header filter button is disabled without it. Apply the result to openColumnId.
CominsColumnFilterConfig
Section titled “CominsColumnFilterConfig”kind: CominsColumnFilterKind;Required value kind: text, number, date, or boolean.
caseSensitive
Section titled “caseSensitive”caseSensitive?: boolean;Defaults to false for text. true makes comparisons case-sensitive.
getValue
Section titled “getValue”getValue?: (params: CominsCellFormatParams<TData, TValue>) => unknown;Defaults to the raw field value. Provide a resolver to customize the filter value only.
CominsColumnFilterRule
Section titled “CominsColumnFilterRule”columnId
Section titled “columnId”columnId: string;Required ID of a filter-enabled column. Unknown-column rules are ignored.
operator
Section titled “operator”operator: CominsColumnConditionFilterOperator;Required supported operator for the kind below. Invalid combinations are ignored.
value?: CominsColumnFilterValue;Comparison value; omit for isEmpty/isNotEmpty. Use finite numbers, YYYY-MM-DD date strings, or booleans for the corresponding kinds.
valueTo
Section titled “valueTo”valueTo?: null | number | string;Other endpoint for between. Both endpoints are inclusive and reversed bounds are normalized.
Related API
Section titled “Related API”getOptionLabel
Section titled “getOptionLabel”getOptionLabel?: (value: CominsColumnFilterValue) => string;See the value-list filtering guide for rendering precedence and return values.
mode?: "condition" | "values";See the value-list filtering guide for rendering precedence and return values.
trigger
Section titled “trigger”trigger?: CominsValueFilterPart<CominsValueFilterTriggerRenderParams<TData>>;See the value-list filtering guide for rendering precedence and return values.
option
Section titled “option”option?: CominsValueFilterPart<CominsValueFilterOptionRenderParams<TData>>;See the value-list filtering guide for rendering precedence and return values.
panel?: CominsValueFilterPart<CominsValueFilterPanelRenderParams<TData>>;See the value-list filtering guide for rendering precedence and return values.
values
Section titled “values”values?: never;See the value-list filtering guide for rendering precedence and return values.
export type CominsColumnFilterRule = CominsColumnConditionFilterRule | CominsColumnValueFilterRule;