Interface Decorator

A decorator that is applied to a content string value in order to create rich text.

interface Decorator {
    depth?: number;
    length?: number;
    offset?: number;
    type?: DecoratorType;
}

depth?: number

The relative intensity or variation of this decorator. Decorators, such as bullet-points, can have multiple indentation depths.

length?: number

The number of content characters to alter with this decorator. Decorators, such as line breaks, can have zero length and fit between characters.

offset?: number

The starting value of this decorator within the content string. Use zero (0) for the first value.

Properties