AvailabilityUiInterface
in
Stock availability state UI properties.
Tags
Table of Contents
Methods
- getColor() : string|null
- Returns the color of the availability state.
- getDescription() : Translatable|null
- Returns additional description of the availability state.
- getListText() : Translatable
- Returns title of the availability state that should be displayed in stock listings.
- getTitle() : Translatable
- Returns the title of the availability state.
- getTooltip() : Translatable|null
- Returns text to display in a tooltip when inspecting the availability state.
- isOutlined() : bool
- Indicates whether the availability pill should be outlined instead of filled.
Methods
getColor()
Returns the color of the availability state.
public
getColor() : string|null
Return values
string|null —color identifier or null if no specific color
getDescription()
Returns additional description of the availability state.
public
getDescription() : Translatable|null
The description may contain variable information, such as estimated shipment time.
Return values
Translatable|null —null if no description is available, content otherwise
getListText()
Returns title of the availability state that should be displayed in stock listings.
public
getListText() : Translatable
Return values
Translatable —state title
getTitle()
Returns the title of the availability state.
public
getTitle() : Translatable
Return values
Translatable —state title
getTooltip()
Returns text to display in a tooltip when inspecting the availability state.
public
getTooltip() : Translatable|null
The tooltip may contain variable information, such as estimated shipment time.
Return values
Translatable|null —null if no tooltip should be generated, content otherwise
isOutlined()
Indicates whether the availability pill should be outlined instead of filled.
public
isOutlined() : bool
Return values
bool —true if yes, false otherwise