mordant/com.github.ajalt.mordant.rendering/TextColors

TextColors

enum TextColors : Enum<TextColors> , Color, TextStyle

Default text colors that can be used to style text.

These styles are not automatically downsampled. You should print the styled strings with Terminal.println to do so.

Example

import com.github.ajalt.mordant.rendering.TextColors.*

val t = Terminal()
t.println("This text is ${green("colorful")}!")

Entries

Types

Companion

object Companion

Properties

alpha

open override val alpha: Float

open override val bg: TextStyle

Create a with this color as the background.

bgColor

open override val bgColor: Color?

bold

open override val bold: Boolean?

color

open override val color: Color?

dim

open override val dim: Boolean?

entries

val entries: EnumEntries<TextColors>

Returns a representation of an immutable list of all enum entries, in the order they're declared.

hyperlink

open override val hyperlink: String?

hyperlinkId

open override val hyperlinkId: String?

inverse

open override val inverse: Boolean?

italic

open override val italic: Boolean?

name

val name: String

ordinal

val ordinal: Int

space

open override val space: ColorSpace<*>

strikethrough

open override val strikethrough: Boolean?

underline

open override val underline: Boolean?

Functions

invoke

open operator override fun invoke(text: String): String

Apply this style to text.

open infix override fun on(bg: TextStyle): TextStyle

Create a style with the foreground color of bg as the background color of the new style.

plus

open operator override fun plus(other: TextStyle): TextStyle

Return a new style that combines this style with other.

open operator override fun plus(other: TextStyles): TextStyle

toAnsi16

open override fun toAnsi16(): Ansi16

toAnsi256

open override fun toAnsi256(): Ansi256

toArray

open override fun toArray(): FloatArray

toCMYK

open override fun toCMYK(): CMYK

toHPLuv

open override fun toHPLuv(): HPLuv

toHSL

open override fun toHSL(): HSL

toHSLuv

open override fun toHSLuv(): HSLuv

toHSV

open override fun toHSV(): HSV

toHWB

open override fun toHWB(): HWB

toICtCp

open override fun toICtCp(): ICtCp

toJzAzBz

open override fun toJzAzBz(): JzAzBz

toJzCzHz

open override fun toJzCzHz(): JzCzHz

toLAB

open override fun toLAB(): LAB

toLCHab

open override fun toLCHab(): LCHab

toLCHuv

open override fun toLCHuv(): LCHuv

toLUV

open override fun toLUV(): LUV

toOklab

open override fun toOklab(): Oklab

toOklch

open override fun toOklch(): Oklch

toSRGB

open override fun toSRGB(): RGB

toString

open override fun toString(): String

toXYZ

open override fun toXYZ(): XYZ

valueOf

fun valueOf(value: String): TextColors

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

values

fun values(): Array<TextColors>

Returns an array containing the constants of this enum type, in the order they're declared.