/** * @module Notifications */ /** * @deprecated * Lists possible semantic use-cases for notifications, which can alter how the notification is presented to the user. */ export declare enum IndicatorType { FAILURE = "failure", WARNING = "warning", SUCCESS = "success" } /** * Lists possible colors available for use as NotificationIndicator background color. */ export declare enum IndicatorColor { RED = "red", GREEN = "green", YELLOW = "yellow", BLUE = "blue", PURPLE = "purple", GRAY = "gray", ORANGE = "orange", MAGENTA = "magenta", TEAL = "teal" } export interface NotificationIndicator { /** * @deprecated * * Deprecated - use the priority field instead. * * Indicates the semantic intent behind the indicator - this determines the visual styling of the indicator when * seen by the user. * * For example - an indicator could be used to: * - `IndicatorType.FAILURE`: Indicate a failure has occurred from an action the user has taken. * - `IndicatorType.WARNING`: Warn a user that they have a limited amount of time to buy. * - `IndicatorType.SUCCESS`: Inform the user that an item has been successfully ordered. */ type?: IndicatorType; /** * The indicator banner color. Defaults to red. */ color?: IndicatorColor; /** * Customized text to be displayed in the indicator. When set, this will override the default indicator text. * Text is limited to 32 characters including spaces. */ text?: string; } export interface NotificationIndicatorWithCustomColor extends Omit { /** * Custom color string for indicator banner. This string must be defined in `theme` during Workspace Platform initialization. */ color: string; /** * Fallback color if custom color could not be found in theme. */ fallback: IndicatorColor; }