IAttributeFilterElementsSelectItemProps
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
It represents an Attribute Filter item. It displays element label, it allow user to add/remove element to/from selection. It allows users to clear selection and add only it into selection.
export interface IAttributeFilterElementsSelectItemProps
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
string | (BETA) (Optional) Indicates which element of the list item is focused by keyboard. | ||
boolean | (BETA) (Optional) Shown as fullscreen on mobile | ||
number | (BETA) (Optional) The index of the item in the list. Used for accessibility purposes. | ||
boolean | (BETA) Indicate that item is selected | ||
(BETA) Item of list | |||
number | (BETA) (Optional) The number of items in the list. Used for accessibility purposes. | ||
RefObject<HTMLElement> | (BETA) (Optional) The ref for the parent list element. Used for focus management. | ||
() => void | (BETA) Remove item from selection | ||
() => void | (BETA) Add item to selection callback | ||
() => void | (BETA) Select item only | ||
string | (BETA) (Optional) Title of attribute’s primary label | ||
string | (BETA) (Optional) Raw value of a number-formatted element, when its displayed value says more than the raw value with separators (e.g. it is rounded or scaled). Shown in the item tooltip, like the primary label value. |
Property details
IAttributeFilterElementsSelectItemProps.focusedActionpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Indicates which element of the list item is focused by keyboard.
focusedAction?: string;
IAttributeFilterElementsSelectItemProps.fullscreenOnMobilepropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Shown as fullscreen on mobile
fullscreenOnMobile?: boolean;
IAttributeFilterElementsSelectItemProps.indexpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
The index of the item in the list. Used for accessibility purposes.
index?: number;
IAttributeFilterElementsSelectItemProps.isSelectedpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Indicate that item is selected
isSelected: boolean;
IAttributeFilterElementsSelectItemProps.itempropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Item of list
item: IAttributeElement;
IAttributeFilterElementsSelectItemProps.itemsCountpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
The number of items in the list. Used for accessibility purposes.
itemsCount?: number;
IAttributeFilterElementsSelectItemProps.listRefpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
The ref for the parent list element. Used for focus management.
listRef?: RefObject<HTMLElement>;
IAttributeFilterElementsSelectItemProps.onDeselectpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Remove item from selection
onDeselect: () => void;
IAttributeFilterElementsSelectItemProps.onSelectpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Add item to selection callback
onSelect: () => void;
IAttributeFilterElementsSelectItemProps.onSelectOnlypropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Select item only
onSelectOnly: () => void;
IAttributeFilterElementsSelectItemProps.primaryLabelTitlepropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Title of attribute’s primary label
primaryLabelTitle?: string;
IAttributeFilterElementsSelectItemProps.rawValueTitlepropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Raw value of a number-formatted element, when its displayed value says more than the raw value with separators (e.g. it is rounded or scaled). Shown in the item tooltip, like the primary label value.
rawValueTitle?: string;