struct

Colorize::Object(T)

Inherits Struct / Value / Object

A colorized object. Colors and text decorations can be modified.

Constructors

new(object : T)

Source

Instance methods

ansi_escape(io : IO) : Nil

Same as ansi_escape but writes to a given io.

Source

ansi_escape

Prints the ANSI escape codes for an object. Note that this has no effect on a Colorize::Object with content, only the escape codes.

require "colorize"

Colorize.with.red.ansi_escape        # => "\e[31m"
"hello world".green.bold.ansi_escape # => "\e[32;1m"

Source

back(r : UInt8, g : UInt8, b : UInt8)

Source

back(color : Symbol) : self

Source

back(back : Color) : self

Source

back(back : UInt8)

Source

black

Source

blink

Apply text decoration Mode::Blink.

Source

blink_fast

Apply text decoration Mode::BlinkFast.

Source

blue

Source

bold

Apply text decoration Mode::Bold.

Source

bright

Apply text decoration Mode::Bright.

cyan

dark_gray

default

dim

Apply text decoration Mode::Dim.

Source

double_underline

Apply text decoration Mode::DoubleUnderline.

Source

fore(r : UInt8, g : UInt8, b : UInt8)

Source

fore(color : Symbol) : self

Source

fore(fore : Color) : self

Source

fore(fore : UInt8)

Source

green

Source

hidden

Apply text decoration Mode::Hidden.

Source

inspect(io : IO) : Nil

Inspects this object and makes the ANSI escape codes visible.

Source

italic

Apply text decoration Mode::Italic.

light_blue

light_cyan

light_gray

light_green

light_magenta

light_red

light_yellow

magenta

mode(mode : Mode) : self

Adds mode to the text's decorations.

on(color : Symbol)

on_black

on_blue

on_cyan

on_dark_gray

on_default

on_green

on_light_blue

on_light_cyan

on_light_gray

on_light_green

on_light_magenta

on_light_red

on_light_yellow

on_magenta

on_red

on_white

on_yellow

overline

Apply text decoration Mode::Overline.

Source

red

Source

reverse

Apply text decoration Mode::Reverse.

Source

strikethrough

Apply text decoration Mode::Strikethrough.

Source

surround(io = STDOUT, &)

Surrounds io by the ANSI escape codes and lets you build colored strings:

require "colorize"

io = IO::Memory.new

Colorize.with.red.surround(io) do
  io << "colorful"
  Colorize.with.green.bold.surround(io) do
    io << " hello "
  end
  Colorize.with.blue.surround(io) do
    io << "world"
  end
  io << " string"
end

io.to_s # returns a colorful string where "colorful" is red, "hello" green, "world" blue and " string" red again

Source

to_s(io : IO) : Nil

Appends this object colored and with text decoration to io.

Source

toggle(flag)

Enables or disables colors and text decoration on this object.

Source

underline

Apply text decoration Mode::Underline.

Source

white

Source

yellow

Source