class Cor

• Cor
• Reference
• Object

Overview

Cor (which means color in Portuguese) is a library for more easily working with colors in Crystal. You can think of it as a more powerful version of Colorize. Cor allows you to very easily convert RGB(A) values to hex and back again for use in CSS and HTML. It also provides a set of chainable methods for creting colorful strings for the terminal using truecolor.

For full usage instructions see the README.

Included Modules

• Comparable(Cor)
• Cor::Colors

Defined in:

cor.cr
cor/colors.cr
cor/cor.cr
cor/version.cr

Constant Summary

ANSI_COLOR_REGEXP = /\x1b+(\[|\[\[)[0-9;:?]+m/m

VERSION = "0.1.0"

Constructors

• .new(red, green, blue, alpha = 255)

  Creates a new Cor instance from #red, #green, #blue and #alpha values.

• .new(hex : String)

  Creates a new Cor instance from a hex string.

Class Method Summary

• .color(color)

  Gets one of the many color values defined in COLORS as a Cor instance.

• .from_hsb(h, s, b)

  Create a new Cor instance from hue, saturation, and brightness.

• .from_hsl(h, s, l)

  Create a new Cor instance from hue, saturation, and lightness.

• .from_hsv(h, s, v)

  Create a new Cor instance from hue, saturation, and value.

• .strip(string)

  Strip ANSI color codes from a string.

• .truecolor_string(string : String, fore = nil, back = nil, bold = false, faint = false, italic = false, underline = false, blink = false, strike = false, overline = false)

  Converts string to an ANSI escape sequence for use with truecolor enabled terminals.

Instance Method Summary

• #*(other : Cor)
• #+(other : Cor)
• #-(other : Cor)
• #/(other : Cor)
• #<=>(other)

  Implements the comparison operator for Cor.

• #alpha : Int32

  alpha (opacity) value for this color

• #alpha=(value)

  Set the alpha value for this color.

• #blue : Int32

  blue value for this color

• #blue=(value)

  Set the blue value for this color

• #green : Int32

  green value for this color

• #green=(value)

  Set the green value for this color

• #hex_string(prefix = false, alpha = false, upcase = false)

  Outputs this Cor instance as a hex string.

• #inverse

  Returns a new Cor that's the inverse of self.

• #pretty_print(pp)

  Pretty print (it's a rainbow!)

• #red : Int32

  red value for this color

• #red=(value)

  Set the red value for this color

• #rgb_string(alpha = false)

  Outputs this Cor instance as a css rgb(a) string.

• #to_a

  Convert the Cor to an array.

• #to_h

  Convert the Cor to a hash.

• #to_hsb

  The HSb (hue / saturation / brightness) of the color

• #to_hsl

  The HSV (hue / saturation / lightness) of the color

• #to_hsv

  The HSV (hue / saturation / value) of the color

• #to_s

  Convert to a string

• #to_tuple

  Convert the Cor to a tuple.

Constructor Detail

Class Method Detail

Instance Method Detail