IAttributeFilterDropdownButtonProps
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
The interface of the AttributeFilter dropdown button.
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 |
|---|---|---|---|
string | (BETA) (Optional) Overrides the accessible name of the button. When omitted, the name is derived from the rendered title. | ||
string | (BETA) (Optional) Id of the dropdown trigger button. | ||
Ref<HTMLElement> | (BETA) (Optional) Ref to the dropdown button component. | ||
string | (BETA) (Optional) Classnames to add to the dropdown button component. | ||
(ALPHA) (Optional) Represents a custom icon along with a tooltip. | |||
boolean | (ALPHA) (Optional) Specifies the visibility mode of the filter. | ||
string | (BETA) (Optional) Id of the Attribute filter dropdown body. | ||
boolean | (BETA) (Optional) Hides the open/close chevron. | ||
ReactNode | (BETA) (Optional) Icon of the AttributeFilterDropdownButton. | ||
boolean | (BETA) (Optional) If true, the button supports drag and drop operations. | ||
boolean | (BETA) (Optional) | ||
boolean | (BETA) (Optional) If true, the AttributeFilter is filtering its elements by parent filters. | ||
boolean | (BETA) (Optional) If true, all the initialization has finished. | ||
boolean | (BETA) (Optional) If true, the AttributeFilter is initializing Attribute elements and its internal data. | ||
boolean | (BETA) (Optional) If true, the AttributeFilter dropdown is open. | ||
“stacked” | “row” | (BETA) (Optional) Visual layout of the chip. “row” is the full-width single-line variant used in the mobile view. | ||
() => void | (BETA) (Optional) Callback to open or close AttributeFilter dropdown. | ||
number | (BETA) (Optional) Selected items count | ||
boolean | (BETA) (Optional) | ||
string | (BETA) (Optional) Comma-separated list of selected element titles. | ||
string | (BETA) (Optional) Title of the attribute IAttributeFilter and its related display form IAttributeDisplayFormMetadataObject. | ||
ReactNode | (ALPHA) (Optional) Allows adding content to the button after the title. | ||
ComponentType | (BETA) (Optional) Customize content of the attribute filter tooltip component. | ||
number | (BETA) (Optional) Total items count. Shown beside the selected items count if showSelectionCount is true. |
Property details
IAttributeFilterDropdownButtonProps.ariaLabelpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Overrides the accessible name of the button. When omitted, the name is derived from the rendered title.
ariaLabel?: string;
IAttributeFilterDropdownButtonProps.buttonIdpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Id of the dropdown trigger button.
buttonId?: string;
IAttributeFilterDropdownButtonProps.buttonRefpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Ref to the dropdown button component.
buttonRef?: Ref<HTMLElement>;
IAttributeFilterDropdownButtonProps.classNamepropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Classnames to add to the dropdown button component.
className?: string;
IAttributeFilterDropdownButtonProps.customIconpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Represents a custom icon along with a tooltip.
customIcon?: IFilterButtonCustomIcon;
IAttributeFilterDropdownButtonProps.disabledpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Specifies the visibility mode of the filter.
disabled?: boolean;
IAttributeFilterDropdownButtonProps.dropdownIdpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Id of the Attribute filter dropdown body.
dropdownId?: string;
IAttributeFilterDropdownButtonProps.hideChevronpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Hides the open/close chevron.
hideChevron?: boolean;
IAttributeFilterDropdownButtonProps.iconpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Icon of the AttributeFilterDropdownButton.
icon?: ReactNode;
IAttributeFilterDropdownButtonProps.isDraggablepropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
If true, the button supports drag and drop operations.
isDraggable?: boolean;
IAttributeFilterDropdownButtonProps.isErrorpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
isError?: boolean;
IAttributeFilterDropdownButtonProps.isFilteringpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
If true, the AttributeFilter is filtering its elements by parent filters.
isFiltering?: boolean;
IAttributeFilterDropdownButtonProps.isLoadedpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
If true, all the initialization has finished.
isLoaded?: boolean;
IAttributeFilterDropdownButtonProps.isLoadingpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
If true, the AttributeFilter is initializing Attribute elements and its internal data.
isLoading?: boolean;
IAttributeFilterDropdownButtonProps.isOpenpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
If true, the AttributeFilter dropdown is open.
isOpen?: boolean;
IAttributeFilterDropdownButtonProps.layoutpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Visual layout of the chip. “row” is the full-width single-line variant used in the mobile view.
layout?: "stacked" | "row";
IAttributeFilterDropdownButtonProps.onClickpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Callback to open or close AttributeFilter dropdown.
onClick?: () => void;
IAttributeFilterDropdownButtonProps.selectedItemsCountpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Selected items count
selectedItemsCount?: number;
Remarks
If value is 0 for IPositiveAttributeFilter means NONE items are selected
If value is 0 for INegativeAttributeFilter means ALL items are selected
IAttributeFilterDropdownButtonProps.showSelectionCountpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
showSelectionCount?: boolean;
IAttributeFilterDropdownButtonProps.subtitlepropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Comma-separated list of selected element titles.
subtitle?: string;
IAttributeFilterDropdownButtonProps.titlepropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Title of the attribute IAttributeFilter and its related display form IAttributeDisplayFormMetadataObject.
title?: string;
IAttributeFilterDropdownButtonProps.titleExtensionpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Allows adding content to the button after the title.
titleExtension?: ReactNode;
IAttributeFilterDropdownButtonProps.TooltipContentComponentpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Customize content of the attribute filter tooltip component.
TooltipContentComponent?: ComponentType;
IAttributeFilterDropdownButtonProps.totalItemsCountpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Total items count. Shown beside the selected items count if showSelectionCount is true.
totalItemsCount?: number;