Variable colors

Type declaration

• BackgroundColor: BackgroundColor

• Color: Color

• ForegroundColor: ForegroundColor

• Instance: Core.colors.Instance

  Return a new Chalk instance.

• Level: Core.colors.Level

• Modifiers: Modifiers

• Readonly bgBlack: Core.colors.Chalk

• Readonly bgBlackBright: Core.colors.Chalk

• Readonly bgBlue: Core.colors.Chalk

• Readonly bgBlueBright: Core.colors.Chalk

• Readonly bgCyan: Core.colors.Chalk

• Readonly bgCyanBright: Core.colors.Chalk

• Readonly bgGray: Core.colors.Chalk

• Readonly bgGreen: Core.colors.Chalk

• Readonly bgGreenBright: Core.colors.Chalk

• Readonly bgGrey: Core.colors.Chalk

• Readonly bgMagenta: Core.colors.Chalk

• Readonly bgMagentaBright: Core.colors.Chalk

• Readonly bgRed: Core.colors.Chalk

• Readonly bgRedBright: Core.colors.Chalk

• Readonly bgWhite: Core.colors.Chalk

• Readonly bgWhiteBright: Core.colors.Chalk

• Readonly bgYellow: Core.colors.Chalk

• Readonly bgYellowBright: Core.colors.Chalk

• Readonly black: Core.colors.Chalk

• Readonly blackBright: Core.colors.Chalk

• Readonly blue: Core.colors.Chalk

• Readonly blueBright: Core.colors.Chalk

• Readonly bold: Core.colors.Chalk

  Modifier: Make text bold.

• Readonly cyan: Core.colors.Chalk

• Readonly cyanBright: Core.colors.Chalk

• Readonly dim: Core.colors.Chalk

  Modifier: Emitting only a small amount of light.

• Readonly gray: Core.colors.Chalk

• Readonly green: Core.colors.Chalk

• Readonly greenBright: Core.colors.Chalk

• Readonly grey: Core.colors.Chalk

• Readonly hidden: Core.colors.Chalk

  Modifier: Prints the text, but makes it invisible.

• Readonly inverse: Core.colors.Chalk

  Modifier: Inverse background and foreground colors.

• Readonly italic: Core.colors.Chalk

  Modifier: Make text italic. (Not widely supported)

• level: Core.colors.Level

  The color support for Chalk.

  By default, color support is automatically detected based on the environment.

  Levels:

  • 0 - All colors disabled.
  • 1 - Basic 16 colors support.
  • 2 - ANSI 256 colors support.
  • 3 - Truecolor 16 million colors support.

• Readonly magenta: Core.colors.Chalk

• Readonly magentaBright: Core.colors.Chalk

• Readonly red: Core.colors.Chalk

• Readonly redBright: Core.colors.Chalk

• Readonly reset: Core.colors.Chalk

  Modifier: Resets the current color chain.

• stderr: Core.colors.Chalk & {
      supportsColor: false | Core.colors.ColorSupport;
  }

• Readonly strikethrough: Core.colors.Chalk

  Modifier: Puts a horizontal line through the center of the text. (Not widely supported)

• supportsColor: false | Core.colors.ColorSupport

• Readonly underline: Core.colors.Chalk

  Modifier: Make text underline. (Not widely supported)

• Readonly visible: Core.colors.Chalk

  Modifier: Prints the text only when Chalk has a color support level > 0. Can be useful for things that are purely cosmetic.

• Readonly white: Core.colors.Chalk

• Readonly whiteBright: Core.colors.Chalk

• Readonly yellow: Core.colors.Chalk

• Readonly yellowBright: Core.colors.Chalk

• ansi:function

  • ansi(code): Core.colors.Chalk

  • Use a Select/Set Graphic Rendition (SGR) color code number to set text color.

    30 <= code && code < 38 || 90 <= code && code < 98 For example, 31 for red, 91 for redBright.

    Parameters

    • code: number

    Returns Core.colors.Chalk

• ansi256:function

  • ansi256(index): Core.colors.Chalk

  • Use a 8-bit unsigned number to set text color.

    Parameters

    • index: number

    Returns Core.colors.Chalk

• bgAnsi:function

  • bgAnsi(code): Core.colors.Chalk

  • Use a Select/Set Graphic Rendition (SGR) color code number to set background color.

    30 <= code && code < 38 || 90 <= code && code < 98 For example, 31 for red, 91 for redBright. Use the foreground code, not the background code (for example, not 41, nor 101).

    Parameters

    • code: number

    Returns Core.colors.Chalk

• bgAnsi256:function

  • bgAnsi256(index): Core.colors.Chalk

  • Use a 8-bit unsigned number to set background color.

    Parameters

    • index: number

    Returns Core.colors.Chalk

• bgHex:function

  • bgHex(color): Core.colors.Chalk

  • Use HEX value to set background color.

    Parameters

    • color: string

      Hexadecimal value representing the desired color.

    Returns Core.colors.Chalk

    Example

    import chalk = require('chalk');
    
    chalk.bgHex('#DEADED');
    Copy

• bgHsl:function

  • bgHsl(hue, saturation, lightness): Core.colors.Chalk

  • Use HSL values to set background color.

    Parameters

    • hue: number

    • saturation: number

    • lightness: number

    Returns Core.colors.Chalk

• bgHsv:function

  • bgHsv(hue, saturation, value): Core.colors.Chalk

  • Use HSV values to set background color.

    Parameters

    • hue: number

    • saturation: number

    • value: number

    Returns Core.colors.Chalk

• bgHwb:function

  • bgHwb(hue, whiteness, blackness): Core.colors.Chalk

  • Use HWB values to set background color.

    Parameters

    • hue: number

    • whiteness: number

    • blackness: number

    Returns Core.colors.Chalk

• bgKeyword:function

  • bgKeyword(color): Core.colors.Chalk

  • Use keyword color value to set background color.

    Parameters

    • color: string

      Keyword value representing the desired color.

    Returns Core.colors.Chalk

    Example

    import chalk = require('chalk');
    
    chalk.bgKeyword('orange');
    Copy

• bgRgb:function

  • bgRgb(red, green, blue): Core.colors.Chalk

  • Use RGB values to set background color.

    Parameters

    • red: number

    • green: number

    • blue: number

    Returns Core.colors.Chalk

• default:function

  • default(text, ...placeholders): string

  • Use a template string.

    Parameters

    • text: TemplateStringsArray

    • Rest ...placeholders: unknown[]

    Returns string

    Remarks

    Template literals are unsupported for nested calls (see issue #341)

    Example

    import chalk = require('chalk');
    
    log(chalk`
    CPU: {red ${cpu.totalPercent}%}
    RAM: {green ${ram.used / ram.total * 100}%}
    DISK: {rgb(255,131,0) ${disk.used / disk.total * 100}%}
    `);
    Copy

    Example

    import chalk = require('chalk');
    
    log(chalk.red.bgBlack`2 + 3 = {bold ${2 + 3}}`)
    Copy

  • default(...text): string

  • Parameters

    • Rest ...text: unknown[]

    Returns string

• hex:function

  • hex(color): Core.colors.Chalk

  • Use HEX value to set text color.

    Parameters

    • color: string

      Hexadecimal value representing the desired color.

    Returns Core.colors.Chalk

    Example

    import chalk = require('chalk');
    
    chalk.hex('#DEADED');
    Copy

• hsl:function

  • hsl(hue, saturation, lightness): Core.colors.Chalk

  • Use HSL values to set text color.

    Parameters

    • hue: number

    • saturation: number

    • lightness: number

    Returns Core.colors.Chalk

• hsv:function

  • hsv(hue, saturation, value): Core.colors.Chalk

  • Use HSV values to set text color.

    Parameters

    • hue: number

    • saturation: number

    • value: number

    Returns Core.colors.Chalk

• hwb:function

  • hwb(hue, whiteness, blackness): Core.colors.Chalk

  • Use HWB values to set text color.

    Parameters

    • hue: number

    • whiteness: number

    • blackness: number

    Returns Core.colors.Chalk

• keyword:function

  • keyword(color): Core.colors.Chalk

  • Use keyword color value to set text color.

    Parameters

    • color: string

      Keyword value representing the desired color.

    Returns Core.colors.Chalk

    Example

    import chalk = require('chalk');
    
    chalk.keyword('orange');
    Copy

• rgb:function

  • rgb(red, green, blue): Core.colors.Chalk

  • Use RGB values to set text color.

    Parameters

    • red: number

    • green: number

    • blue: number

    Returns Core.colors.Chalk