Theia API Documentation v1.66.0
    Preparing search index...

    Interface Data

    Encapsulates styling information that has to be applied on the widget which we decorate.

    interface Data {
        backgroundColor?: string;
        badge?: number;
        captionPrefixes?: CaptionAffix[];
        captionSuffixes?: CaptionAffix[];
        fontData?: FontData;
        highlight?: WidgetDecoration.CaptionHighlight;
        iconColor?: string;
        iconOverlay?: IconOverlay | IconClassOverlay;
        priority?: number;
        tailDecorations?: (
            | WidgetDecoration.TailDecoration
            | TailDecorationIcon
            | TailDecorationIconClass
        )[];
        tooltip?: string;
    }
    Index

    Properties

    backgroundColor? badge? captionPrefixes? captionSuffixes? fontData? highlight? iconColor? iconOverlay? priority? tailDecorations? tooltip?

    Properties

    backgroundColor?: string

    The background color of the entire row.

    badge?: number

    A count badge for widgets.

    captionPrefixes?: CaptionAffix[]

    Optional, leading prefixes right before the caption.

    captionSuffixes?: CaptionAffix[]

    Suffixes that might come after the caption as an additional information.

    fontData?: FontData

    The font data for the caption.

    highlight?: WidgetDecoration.CaptionHighlight

    An array of ranges to highlight the caption.

    iconColor?: string

    Sets the color of the icon. Ignored if the decorated item has no icon.

    iconOverlay?: IconOverlay | IconClassOverlay

    Has not effect if given, but the widget does not have an associated image.

    priority?: number

    The higher number has higher priority. If not specified, treated as 0. When multiple decorators are available for the same item, and decoration data cannot be merged together, then the higher priority item will be applied on the decorated element and the lower priority will be ignored.

    tailDecorations?: (
        | WidgetDecoration.TailDecoration
        | TailDecorationIcon
        | TailDecorationIconClass
    )[]

    Optional right-aligned decorations that appear after the widget caption and after the caption suffixes (is any).

    tooltip?: string

    Custom tooltip for the decorated item. Tooltip will be appended to the original tooltip, if any.

    Settings

    Member Visibility

    On This Page

    Properties