IAttributeFilterDropdownButtonProps
Home > @gooddata/sdk-ui-filters > IAttributeFilterDropdownButtonProps
IAttributeFilterDropdownButtonProps interface
This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
The interface of the AttributeFilter dropdown button.
Signature:
export interface IAttributeFilterDropdownButtonProps
Remarks
It opens Attribute filter dropdown and displaying title or subtitle, selection details and attribute filter statuses like loading or filtering. Note: for rendering error status see IAttributeFilterErrorProps.
Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| className? | string | (BETA) (Optional) Classnames to add to the dropdown button component. | |
| customIcon? | IFilterButtonCustomIcon | (ALPHA) (Optional) Represents a custom icon along with a tooltip. | |
| disabled? | boolean | (ALPHA) (Optional) Specifies the visibility mode of the filter. | |
| icon? | ReactNode | (BETA) (Optional) Icon of the AttributeFilterDropdownButton. | |
| isDraggable? | boolean | (BETA) (Optional) If true, the button supports drag and drop operations. | |
| isError? | boolean | (BETA) (Optional) | |
| isFiltering? | boolean | (BETA) (Optional) If true, the AttributeFilter is filtering its elements by parent filters. | |
| isLoaded? | boolean | (BETA) (Optional) If true, all the initialization has finished. | |
| isLoading? | boolean | (BETA) (Optional) If true, the AttributeFilter is initializing Attribute elements and its internal data. | |
| isOpen? | boolean | (BETA) (Optional) If true, the AttributeFilter dropdown is open. | |
| onClick? | () => void | (BETA) (Optional) Callback to open or close AttributeFilter dropdown. | |
| selectedItemsCount? | number | (BETA) (Optional) Selected items count | |
| showSelectionCount? | boolean | (BETA) (Optional) | |
| subtitle? | string | (BETA) (Optional) Comma-separated list of selected element titles. | |
| title? | string | (BETA) (Optional) Title of the attribute IAttributeFilter and its related display form IAttributeDisplayFormMetadataObject. | |
| titleExtension? | ReactNode | (ALPHA) (Optional) Allows adding content to the button after the title. | |
| TooltipContentComponent? | React.ComponentType | (BETA) (Optional) Customize content of the attribute filter tooltip component. |