OpenFin Workspace API
    Preparing search index...

    Interface NotificationIndicator

    interface NotificationIndicator {
        color?: IndicatorColor;
        text?: string;
        type?: NotificationIndicatorType;
    }
    Index
    color? text? type?
    color?: IndicatorColor

    The indicator banner color. Defaults to red.

    Optionaltext

    text?: string

    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.

    type?: NotificationIndicatorType

    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.

    Settings

    On This Page
    Properties