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

    Interface ThemableDecorationRenderOptions

    Represents theme specific rendering styles for a text editor decoration.

    interface ThemableDecorationRenderOptions {
        after?: ThemableDecorationAttachmentRenderOptions;
        backgroundColor?: string | ThemeColor;
        before?: ThemableDecorationAttachmentRenderOptions;
        border?: string;
        borderColor?: string | ThemeColor;
        borderRadius?: string;
        borderSpacing?: string;
        borderStyle?: string;
        borderWidth?: string;
        color?: string | ThemeColor;
        cursor?: string;
        fontStyle?: string;
        fontWeight?: string;
        gutterIconPath?: string | Uri;
        gutterIconSize?: string;
        letterSpacing?: string;
        opacity?: string;
        outline?: string;
        outlineColor?: string | ThemeColor;
        outlineStyle?: string;
        outlineWidth?: string;
        overviewRulerColor?: string | ThemeColor;
        textDecoration?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    after? backgroundColor? before? border? borderColor? borderRadius? borderSpacing? borderStyle? borderWidth? color? cursor? fontStyle? fontWeight? gutterIconPath? gutterIconSize? letterSpacing? opacity? outline? outlineColor? outlineStyle? outlineWidth? overviewRulerColor? textDecoration?

    Properties

    after?: ThemableDecorationAttachmentRenderOptions

    Defines the rendering options of the attachment that is inserted after the decorated text

    backgroundColor?: string | ThemeColor

    Background color of the decoration. Use rgba() and define transparent background colors to play well with other decorations. Alternatively a color from the color registry can be referenced.

    before?: ThemableDecorationAttachmentRenderOptions

    Defines the rendering options of the attachment that is inserted before the decorated text

    border?: string

    CSS styling property that will be applied to text enclosed by a decoration.

    borderColor?: string | ThemeColor

    CSS styling property that will be applied to text enclosed by a decoration. Better use 'border' for setting one or more of the individual border properties.

    borderRadius?: string

    CSS styling property that will be applied to text enclosed by a decoration. Better use 'border' for setting one or more of the individual border properties.

    borderSpacing?: string

    CSS styling property that will be applied to text enclosed by a decoration. Better use 'border' for setting one or more of the individual border properties.

    borderStyle?: string

    CSS styling property that will be applied to text enclosed by a decoration. Better use 'border' for setting one or more of the individual border properties.

    borderWidth?: string

    CSS styling property that will be applied to text enclosed by a decoration. Better use 'border' for setting one or more of the individual border properties.

    color?: string | ThemeColor

    CSS styling property that will be applied to text enclosed by a decoration.

    cursor?: string

    CSS styling property that will be applied to text enclosed by a decoration.

    fontStyle?: string

    CSS styling property that will be applied to text enclosed by a decoration.

    fontWeight?: string

    CSS styling property that will be applied to text enclosed by a decoration.

    gutterIconPath?: string | Uri

    An absolute path or an URI to an image to be rendered in the gutter.

    gutterIconSize?: string

    Specifies the size of the gutter icon. Available values are 'auto', 'contain', 'cover' and any percentage value. For further information: https://msdn.microsoft.com/en-us/library/jj127316(v=vs.85).aspx

    letterSpacing?: string

    CSS styling property that will be applied to text enclosed by a decoration.

    opacity?: string

    CSS styling property that will be applied to text enclosed by a decoration.

    outline?: string

    CSS styling property that will be applied to text enclosed by a decoration.

    outlineColor?: string | ThemeColor

    CSS styling property that will be applied to text enclosed by a decoration. Better use 'outline' for setting one or more of the individual outline properties.

    outlineStyle?: string

    CSS styling property that will be applied to text enclosed by a decoration. Better use 'outline' for setting one or more of the individual outline properties.

    outlineWidth?: string

    CSS styling property that will be applied to text enclosed by a decoration. Better use 'outline' for setting one or more of the individual outline properties.

    overviewRulerColor?: string | ThemeColor

    The color of the decoration in the overview ruler. Use rgba() and define transparent colors to play well with other decorations.

    textDecoration?: string

    CSS styling property that will be applied to text enclosed by a decoration.

    Settings

    Member Visibility

    On This Page

    Properties