Skip to main content

This module is used to separate plain text into colored text objects to be further rendered.

Example

const text = "$green$Hello, world!$yellow$The rest is yellow.";

// Change the default splitter.
ColorText.SPLITTER = "$";

// Parse the text into colored text objects.
const splitted = ColorText.split(text);

// Expected:
// [
//   {
//     text: "Hello, world!",
//     color: "green"
//   },
//   {
//     text: "The rest is yellow.",
//     color: "yellow"
//   },
// ]

ColorText

Constructors​

constructor​

• new ColorText(): ColorText

Returns​

ColorText

Properties​

SPLITTER​

▪ Static SPLITTER: string = "∆"

The symbol used to separate a text into a colored text object array.

Methods​

split​

▸ split(text, defaultColor?): { color: string ; text: string }[]

Split a text into a colored text object array by ColorText.SPLITTER.

Parameters​

NameTypeDefault valueDescription
textstringundefinedThe text to split.
defaultColorstring"black"The default color to apply to the text.

Returns​

{ color: string ; text: string }[]

An array of colored text objects.