Class Style

An interface for style-able objects.

See

Implements

Styled

Index

Constructors

Properties

attributes background foreground background empty foreground

Accessors

Constructors

constructor

new Style(attributes?: Attributes): Style
Parameters
- Optionalattributes: Attributes
Returns Style
- Defined in src/sgr/style.ts:39

Properties

`Readonly`attributes

attributes: Attributes

Bitfield for style attributes

background

background: (color: MaybeColor) => Style = ...

Type declaration

- (color: MaybeColor): Style
- Add a background color attribute to the style.
  Parameters
  - color: MaybeColor
  Returns Style

foreground

foreground: (color: MaybeColor) => Style = ...

Type declaration

- (color: MaybeColor): Style
- Add a foreground color attribute to the style.
  Parameters
  - color: MaybeColor
  Returns Style

`Static`background

background: (color: MaybeColor) => Style = ...

`Static` `Readonly`empty

empty: Style = ...

Empty Style

`Static`foreground

foreground: (color: MaybeColor) => Style = ...

Accessors

bg

get bg(): number
Returns number
- Defined in src/sgr/style.ts:20

fg

get fg(): number
Returns number
- Defined in src/sgr/style.ts:24

ul

get ul(): number
Returns number
- Defined in src/sgr/style.ts:28

us

get us(): UnderlineStyle
Returns UnderlineStyle
- Defined in src/sgr/style.ts:32

Methods

backgroundColor

backgroundColor(color: MaybeColor): Style
Add a background color attribute to the style.
Parameters
- color: MaybeColor
Returns Style
- Defined in src/sgr/style.ts:329

blink

blink(): Style
Add a blink attribute to the style (alias for slowBlink).

Returns Style
- Defined in src/sgr/style.ts:186

bold

bold(): Style
Add a bold attribute to the style.

Returns Style
- Defined in src/sgr/style.ts:57

conceal

conceal(): Style
Add a conceal attribute to the style.

Returns Style
- Defined in src/sgr/style.ts:230

copy

copy(): Style
Copy this style.

Returns Style
- Defined in src/sgr/style.ts:556

curlyUnderline

curlyUnderline(): Style
Add a curly underline attribute to the style.

Returns Style
- Defined in src/sgr/style.ts:153

dashedUnderline

dashedUnderline(): Style
Add a dashed underline attribute to the style.

Returns Style
- Defined in src/sgr/style.ts:175

defaultBackgroundColor

defaultBackgroundColor(): Style
Add a default background color attribute to the style.

Returns Style
- Defined in src/sgr/style.ts:353

defaultForegroundColor

defaultForegroundColor(): Style
Add a default foreground color attribute to the style.

Returns Style
- Defined in src/sgr/style.ts:388

defaultUnderlineColor

defaultUnderlineColor(): Style
Add a default underline color attribute to the style.

Returns Style
- Defined in src/sgr/style.ts:120

dottedUnderline

dottedUnderline(): Style
Add a dotted underline attribute to the style.

Returns Style
- Defined in src/sgr/style.ts:164

doubleUnderline

doubleUnderline(): Style
Add a double underline attribute to the style.

Returns Style
- Defined in src/sgr/style.ts:142

faint

faint(): Style
Add a faint attribute to the style.

Returns Style
- Defined in src/sgr/style.ts:68

foregroundColor

foregroundColor(color: MaybeColor): Style
Add a foreground color attribute to the style.
Parameters
- color: MaybeColor
Returns Style
- Defined in src/sgr/style.ts:364

format

format(string: string): string
Formats a string with this style applied.
Parameters
- string: string
Returns string
Implementation of Styled.format
- Defined in src/sgr/style.ts:399

isEmpty

isEmpty(): boolean
Returns boolean
- Defined in src/sgr/style.ts:564

italic

italic(): Style
Add an italic attribute to the style.

Returns Style
- Defined in src/sgr/style.ts:79

noBlink

noBlink(): Style
Add a no blink attribute to the style.

Returns Style
- Defined in src/sgr/style.ts:285

noConceal

noConceal(): Style
Add a no conceal attribute to the style.

Returns Style
- Defined in src/sgr/style.ts:307

noItalic

noItalic(): Style
Add a no italic attribute to the style.

Returns Style
- Defined in src/sgr/style.ts:263

noReverse

noReverse(): Style
Add a no reverse attribute to the style.

Returns Style
- Defined in src/sgr/style.ts:296

normalIntensity

normalIntensity(): Style
Add a normal intensity attribute to the style.

Returns Style
- Defined in src/sgr/style.ts:252

noStrikethrough

noStrikethrough(): Style
Add a no strikethrough attribute to the style.

Returns Style
- Defined in src/sgr/style.ts:318

noUnderline

noUnderline(): Style
Add a no underline attribute to the style.

Returns Style
- Defined in src/sgr/style.ts:274

rapidBlink

rapidBlink(): Style
Add a rapid blink attribute to the style.

Returns Style
- Defined in src/sgr/style.ts:208

reset

reset(): Style
Add a reset attribute to the style.

Returns Style
- Defined in src/sgr/style.ts:46

reverse

reverse(): Style
Add a reverse video attribute to the style.

Returns Style
- Defined in src/sgr/style.ts:219

slowBlink

slowBlink(): Style
Add a slow blink attribute to the style.

Returns Style
- Defined in src/sgr/style.ts:197

strikethrough

strikethrough(): Style
Add a strikethrough attribute to the style.

Returns Style
- Defined in src/sgr/style.ts:241

toString

toString(): string
Returns the ANSI SGR (Select Graphic Rendition) string representation of the style.

Returns string
Implementation of Styled.toString
- Defined in src/sgr/style.ts:407

underline

underline(style?: UnderlineStyle): Style
Add an underline to the style.
Parameters
- style: UnderlineStyle = UnderlineStyle.Single
Returns Style
- Defined in src/sgr/style.ts:90

underlineColor

underlineColor(color: MaybeColor): Style
Add an underline color attribute to the style.
Parameters
- color: MaybeColor
Returns Style
- Defined in src/sgr/style.ts:101

underlineStyle

underlineStyle(style: UnderlineStyle): Style
Add a specific underline style to the style.
Parameters
- style: UnderlineStyle
Returns Style
- Defined in src/sgr/style.ts:131

`Static`backgroundColor

backgroundColor(color: MaybeColor): Style
Parameters
- color: MaybeColor
Returns Style
- Defined in src/sgr/style.ts:342

`Static`blink

blink(): Style
Returns Style
- Defined in src/sgr/style.ts:190

`Static`bold

bold(): Style
Returns Style
- Defined in src/sgr/style.ts:61

`Static`conceal

conceal(): Style
Returns Style
- Defined in src/sgr/style.ts:234

`Static`copy

copy(style: Style): Style
Parameters
- style: Style
Returns Style
- Defined in src/sgr/style.ts:560

`Static`curlyUnderline

curlyUnderline(): Style
Returns Style
- Defined in src/sgr/style.ts:157

`Static`dashedUnderline

dashedUnderline(): Style
Returns Style
- Defined in src/sgr/style.ts:179

`Static`defaultBackgroundColor

defaultBackgroundColor(): Style
Returns Style
- Defined in src/sgr/style.ts:357

`Static`defaultForegroundColor

defaultForegroundColor(): Style
Returns Style
- Defined in src/sgr/style.ts:392

`Static`defaultUnderlineColor

defaultUnderlineColor(): Style
Returns Style
- Defined in src/sgr/style.ts:124

`Static`dottedUnderline

dottedUnderline(): Style
Returns Style
- Defined in src/sgr/style.ts:168

`Static`doubleUnderline

doubleUnderline(): Style
Returns Style
- Defined in src/sgr/style.ts:146

`Static`faint

faint(): Style
Returns Style
- Defined in src/sgr/style.ts:72

`Static`foregroundColor

foregroundColor(color: MaybeColor): Style
Parameters
- color: MaybeColor
Returns Style
- Defined in src/sgr/style.ts:377

`Static`from

from(props: AttributesProps): Style
Create a Style from an object of attributes properties.
Parameters
- props: AttributesProps
Returns Style
- Defined in src/sgr/style.ts:575

`Static`isEmpty

isEmpty(style: Style): boolean
Parameters
- style: Style
Returns boolean
- Defined in src/sgr/style.ts:568

`Static`italic

italic(): Style
Returns Style
- Defined in src/sgr/style.ts:83

`Static`noBlink

noBlink(): Style
Returns Style
- Defined in src/sgr/style.ts:289

`Static`noConceal

noConceal(): Style
Returns Style
- Defined in src/sgr/style.ts:311

`Static`noItalic

noItalic(): Style
Returns Style
- Defined in src/sgr/style.ts:267

`Static`noReverse

noReverse(): Style
Returns Style
- Defined in src/sgr/style.ts:300

`Static`normalIntensity

normalIntensity(): Style
Returns Style
- Defined in src/sgr/style.ts:256

`Static`noStrikethrough

noStrikethrough(): Style
Returns Style
- Defined in src/sgr/style.ts:322

`Static`noUnderline

noUnderline(): Style
Returns Style
- Defined in src/sgr/style.ts:278

`Static`rapidBlink

rapidBlink(): Style
Returns Style
- Defined in src/sgr/style.ts:212

`Static`reset

reset(): Style
Returns Style
- Defined in src/sgr/style.ts:50

`Static`reverse

reverse(): Style
Returns Style
- Defined in src/sgr/style.ts:223

`Static`slowBlink

slowBlink(): Style
Returns Style
- Defined in src/sgr/style.ts:201

`Static`strikethrough

strikethrough(): Style
Returns Style
- Defined in src/sgr/style.ts:245

`Static`underline

underline(): Style
Returns Style
- Defined in src/sgr/style.ts:94

`Static`underlineColor

underlineColor(color: MaybeColor): Style
Parameters
- color: MaybeColor
Returns Style
- Defined in src/sgr/style.ts:113

`Static`underlineStyle

underlineStyle(style: UnderlineStyle): Style
Parameters
- style: UnderlineStyle
Returns Style
- Defined in src/sgr/style.ts:135