Skip to content

Full Text Functions for Text Effects and Styling#

Examples#

Effect Full Text Function Example
Bold effect_bold("text") This is BOLD
Dim effect_dim("text") This is DIMMED
Underline effect_underline("text") This is UNDERLINED
Blink effect_blink("text") This is BLINKING
Reverse effect_reverse("text") This is REVERSED
Hide effect_hide("text") This is HIDDEN

Functions#

Prints full line of text with blink effect.

Parameters:

Name Type Description Default
text str

Text to be printed with blink effect.

required
color Color | BrightColor | ColorRGB | ColorHSL | ColorHex | BgColor | BgBrightColor | BgColorRGB | BgColorHSL | BgColorHex | str | None

Optionally add color to text.

None
Example
1
2
3
4
5
6
from colorist import effect_blink, BrightColor, BgColor

effect_blink("This is BLINKING")
effect_blink("This is BLINKING", BrightColor.YELLOW)
effect_blink("This is BLINKING", BgColor.GREEN)
effect_blink("This is BLINKING", BgColorRGB(70, 130, 180))

How it appears in the terminal:

% This is BLINKING
% This is BLINKING
% This is BLINKING
% This is BLINKING

effect_bold(text, color=None) #

Prints full line of text with bold styling.

Parameters:

Name Type Description Default
text str

Text to be printed with bold styling.

required
color Color | BrightColor | ColorRGB | ColorHSL | ColorHex | BgColor | BgBrightColor | BgColorRGB | BgColorHSL | BgColorHex | str | None

Optionally add color to text.

None
Example
1
2
3
4
5
6
from colorist import effect_bold, Color, BgColor

effect_bold("This is BOLD")
effect_bold("This is BOLD", Color.BLUE)
effect_bold("This is BOLD", BgColor.RED)
effect_bold("This is BOLD", BgColorHSL(190, 2, 49))

How it appears in the terminal:

% This is BOLD
% This is BOLD
% This is BOLD
% This is BOLD

effect_dim(text, color=None) #

Prints full line of text with dim styling.

Parameters:

Name Type Description Default
text str

Text to be printed with dim effect.

required
color Color | BrightColor | ColorRGB | ColorHSL | ColorHex | BgColor | BgBrightColor | BgColorRGB | BgColorHSL | BgColorHex | str | None

Optionally add color to text.

None
Example
1
2
3
4
5
6
from colorist import effect_dim, BrightColor, BgColor

effect_dim("This is DIMMED")
effect_dim("This is DIMMED", BrightColor.GREEN)
effect_dim("This is DIMMED", BgColor.MAGENTA)
effect_dim("This is DIMMED", ColorHex("#ff5733"))

How it appears in the terminal:

% This is DIMMED
% This is DIMMED
% This is DIMMED
% This is DIMMED

effect_hide(text, color=None) #

Prints full line of text with hide effect.

Parameters:

Name Type Description Default
text str

Text to be printed with hide effect.

required
color Color | BrightColor | ColorRGB | ColorHSL | ColorHex | BgColor | BgBrightColor | BgColorRGB | BgColorHSL | BgColorHex | str | None

Optionally add color to text.

None
Example
1
2
3
4
5
6
from colorist import effect_hide, Color, BgColor

effect_hide("This is HIDDEN")
effect_hide("This is HIDDEN", Color.BLUE)
effect_hide("This is HIDDEN", BgColor.RED)
effect_hide("This is HIDDEN", BgColorHex("#99ff99"))

How it appears in the terminal:

% This is HIDDEN
% This is HIDDEN
% This is HIDDEN
% This is HIDDEN

effect_reverse(text, color=None) #

Prints full line of text with reversed foreground and background color effect.

Parameters:

Name Type Description Default
text str

Text to be printed with reverse effect.

required
color Color | BrightColor | ColorRGB | ColorHSL | ColorHex | BgColor | BgBrightColor | BgColorRGB | BgColorHSL | BgColorHex | str | None

Optionally add color to text.

None
Example
1
2
3
4
5
6
from colorist import effect_reverse, Color, BgColor

effect_reverse("This is REVERSED")
effect_reverse("This is REVERSED", Color.CYAN)
effect_reverse("This is REVERSED", BgColor.RED)
effect_reverse("This is REVERSED", ColorRGB(194, 145, 164))

How it appears in the terminal:

% This is REVERSED
% This is REVERSED
% This is REVERSED
% This is REVERSED

effect_underline(text, color=None) #

Prints full line of text with underline styling.

Parameters:

Name Type Description Default
text str

Text to be printed with underline styling.

required
color Color | BrightColor | ColorRGB | ColorHSL | ColorHex | BgColor | BgBrightColor | BgColorRGB | BgColorHSL | BgColorHex | str | None

Optionally add color to text.

None
Example
1
2
3
4
5
6
from colorist import effect_underline, Color, BgBrightColor

effect_underline("This is UNDERLINED")
effect_underline("This is UNDERLINED", Color.CYAN)
effect_underline("This is UNDERLINED", BgBrightColor.BLUE)
effect_underline("This is UNDERLINED", ColorHSL(60, 56, 43))

How it appears in the terminal:

% This is UNDERLINED
% This is UNDERLINED
% This is UNDERLINED
% This is UNDERLINED