PropertyFilterBuilderProps Interface

Beta  

Props for PropertyFilterBuilder component.

Methods

Name Description
onFilterChanged(filter?: PropertyFilter): void Callback that is invoked when filter changes.  
onRulePropertySelected(property: PropertyDescription): void Optional Callback that is invoked when property is selected in any rule.  
propertyRenderer(name: string): ReactNode Optional Custom renderer for property selector in rule.  
ruleOperatorRenderer(props: ): ReactNode Optional Custom renderer for rule operator selector.  
ruleValueRenderer(props: ): ReactNode Optional Custom renderer for rule value input.  

Properties

Name Type Description
initialFilter undefined | PropertyFilter Initial filter that should be shown when component is mounted.  
isDisabled undefined | boolean Specifies whether component is disabled or not.  
properties PropertyDescription[] List of properties available to be used in filter rules.  
ruleGroupDepthLimit undefined | number Specifies how deep rule groups can be nested.  

Defined in

Last Updated: 30 November, 2023