mooncakes.io

Terminal string styling support for MoonBit.

string

chalk

color

moon add moonbit-community/chalk@0.0.1

Download zip

Author

moonbit-community

Version

0.0.1

License

MIT

Repository

github.com/moonbit-community/chalk.mbt

Last updated

2 months ago

Downloads

284

README

#MoonBit-Chalk

MoonBit-Chalk provides some APIs for terminal color rendering, including rendering APIs for formatting, background color, and font color.

#Usage

Use chalk() to construct a Chalk object and attach properties to it through chain calls.

Chalk provides three types of enum internally for setting properties: text color(Color enum), background color(BackGroundColors enum), and format(Modifier enum).

Chalk is an immutable variable, which allows you to easily reuse and combine it, and finally use Render to render any value that conforms to the Show Trait.

let str = chalk().background(BgRed).modifier(Bold).color(Red).render("hello")

#
BackGroundColors

source

pub(all) enum BackGroundColors {
  BgBlack
  BgRed
  BgGreen
  BgYellow
  BgBlue
  BgMagenta
  BgCyan
  BgWhite
  BgBlackBright
  BgRedBright
  BgGreenBright
  BgYellowBright
  BgBlueBright
  BgMagentaBright
  BgCyanBright
  BgWhiteBright
}

#
Chalk

source

pub(all) enum Chalk {
  Cons(Chalk, Render)
  Nil
}

#
Chalk::background

source

fn Chalk::background(self : Chalk, color : BackGroundColors) -> Chalk

#
Chalk::color

source

fn Chalk::color(self : Chalk, color : Colors) -> Chalk

#
Chalk::modifier

source

fn Chalk::modifier(self : Chalk, modifier : Modifier) -> Chalk

#
Chalk::render

source

fn[T : Show] Chalk::render(self : Chalk, to_render : T) -> String

#
Colors

source

pub(all) enum Colors {
  Black
  Red
  Green
  Yellow
  Blue
  Magenta
  Cyan
  White
  BlackBright
  RedBright
  GreenBright
  YellowBright
  BlueBright
  MagentaBright
  CyanBright
  WhiteBright
}

#
Modifier

source

pub(all) enum Modifier {
  Reset
  Bold
  Dim
  Italic
  Underline
  Overline
  Inverse
  Hidden
  Strikethrough
}

#
Render

source

pub(all) enum Render {
  RenderBackGround(BackGroundColors)
  RenderColor(Colors)
  RenderModifier(Modifier)
}

#
chalk

source

fn chalk() -> Chalk

Source Files

Site source Report issue Packages Build queue Skills Statistics

chalk

#MoonBit-Chalk

#Usage

#BackGroundColors

#Chalk

#Chalk::background

#Chalk::color

#Chalk::modifier

#Chalk::render

#Colors

#Modifier

#Render

#chalk

Source Files

#
BackGroundColors

#
Chalk

#
Chalk::background

#
Chalk::color

#
Chalk::modifier

#
Chalk::render

#
Colors

#
Modifier

#
Render

#
chalk