PropertyFilterBuilderRendererProps Interface
Props for PropertyFilterBuilderRenderer component.
Properties
| Name | Type | Description | |
|---|---|---|---|
| actions | PropertyFilterBuilderActions | Actions for modifying PropertyFilterBuilder state. | |
| allowLastRuleDelete | boolean | undefined | Controls whether the last rule remaining in a group is deletable | |
| isDisabled | boolean | undefined | Specifies whether component is disabled or not. | |
| isGroupOperatorDisabled | boolean | undefined | Controls whether the group operator is toggle-able. | |
| onRulePropertySelected | (property: PropertyDescription) => void | undefined | Callback that is invoked when property is selected in any rule. | |
| properties | PropertyDescription[] | List of properties available to be used in filter rules. | |
| propertyRenderer | (name: string) => React.ReactNode | undefined | Custom renderer for property selector in rule. | |
| rootGroup | PropertyFilterBuilderRuleGroup | Root group of rules in PropertyFilterBuilder component. | |
| ruleGroupDepthLimit | number | undefined | Specifies how deep rule groups can be nested. | Deprecated |
| ruleOperatorRenderer | (props: PropertyFilterBuilderRuleOperatorProps) => React.ReactNode | undefined | Custom renderer for rule operator selector. | |
| ruleValueRenderer | (props: PropertyFilterBuilderRuleValueRendererProps) => React.ReactNode | undefined | Custom renderer for rule value input. |
Defined in
Last Updated: 20 November, 2024
Found something wrong, missing, or unclear on this page?Raise an issue in our repo.