PropertyFilterBuilderProps Interface
Props for PropertyFilterBuilder component.
Extends
- Omit<PropertyFilterBuilderRendererProps, "actions" | "rootGroup">
- UsePropertyFilterBuilderProps
Properties
| Name | Type | Description | |
|---|---|---|---|
| onFilterChanged | (filter?: PropertyFilter) => void |
Inherited properties
| Name | Type | Inherited from | Description |
|---|---|---|---|
| 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 | |
| properties | PropertyDescription[] | Omit | List of properties available to be used in filter rules. |
| propertyRenderer | (name: string) => ReactNode | undefined | Omit | |
| ruleGroupDepthLimit | number | undefined | Omit | Specifies how deep rule groups can be nested. |
| ruleOperatorRenderer | (props: PropertyFilterBuilderRuleOperatorProps) => ReactNode | undefined | Omit | |
| ruleValidator | (rule: PropertyFilterBuilderRule) => undefined | string | undefined | UsePropertyFilterBuilderProps | |
| ruleValueRenderer | (props: PropertyFilterBuilderRuleValueRendererProps) => ReactNode | undefined | Omit |
Defined in
Last Updated: 13 May, 2024
Found something wrong, missing, or unclear on this page?Raise an issue in our repo.