Type Alias AttributeProps

AttributeProps: { -readonly [K in keyof typeof PROP_TO_ATTRIBUTE]: boolean } & {
    backgroundColor: MaybeColor;
    foregroundColor: MaybeColor;
    underlineColor: MaybeColor;
    underlineStyle: UnderlineStyle;
}

SGR attribute props

Example

const attributes: AttributesProps = {
  backgroundColor: BasicColor.Red,
  foregroundColor: BasicColor.Green,
  underlineColor: BasicColor.Blue,
  underlineStyle: UnderlineStyle.Double,
  bold: true,
  italic: true,
};

const style = Style.from(attributes);

Remarks

Excludes some attributes, like basic background and foreground. They are supposed to be handled by the ingesting function via backgroundColor and foregroundColor properties.

See

Style.from

Type Alias AttributeProps

Example

Remarks

See

Settings