PropertyFilterBuilderProps Interface
Props for PropertyFilterBuilder component.
Extends
- Omit<PropertyFilterBuilderRendererProps, "actions" | "rootGroup">
- UsePropertyFilterBuilderProps
Properties
| Name | Type | Description | |
|---|---|---|---|
| onFilterChanged | (filter?: PropertyFilter) => void | Callback that is invoked when filter changes. |
Inherited properties
| Name | Type | Inherited from | Description |
|---|---|---|---|
| allowLastRuleDelete | boolean | undefined | Omit | Controls whether the last rule remaining in a group is deletable |
| initialFilter | PropertyFilter | undefined | UsePropertyFilterBuilderProps | Initial filter for PropertyFilterBuilder |
| isDisabled | boolean | undefined | Omit | Specifies whether component is disabled or not. |
| isGroupOperatorDisabled | boolean | undefined | Omit | Controls whether the group operator is toggle-able. |
| onRulePropertySelected | (property: PropertyDescription) => void | undefined | Omit | Callback that is invoked when property is selected in any rule. |
| properties | PropertyDescription[] | Omit | List of properties available to be used in filter rules. |
| propertyRenderer | (name: string) => React.ReactNode | undefined | Omit | Custom renderer for property selector in rule. |
| ruleGroupDepthLimit | number | undefined | Omit | Specifies how deep rule groups can be nested. |
| ruleOperatorRenderer | (props: PropertyFilterBuilderRuleOperatorProps) => React.ReactNode | undefined | Omit | Custom renderer for rule operator selector. |
| ruleValidator | (rule: PropertyFilterBuilderRule) => undefined | string | undefined | UsePropertyFilterBuilderProps | Custom rule validator to be used when buildFilter is invoked. |
| ruleValueRenderer | (props: PropertyFilterBuilderRuleValueRendererProps) => React.ReactNode | undefined | Omit | Custom renderer for rule value input. |
Defined in
Last Updated: 17 December, 2024
Found something wrong, missing, or unclear on this page?Raise an issue in our repo.