gitlabEdit

penConsole Writers

We need to write to the console

Terminaux provides a vast amount of console writers for different purposes, like the progress bar writer, writing console output in color, etc. Also, you can use their Render() functions found in basically every static writer (not those that are dynamic, such as wrapped writers).

circle-info

The Render() functions are made primarily for plain writing operations. You can use them with TextWriterRaw writers.


Markups

Terminaux provides you with a simple BBCode-inspired markup syntax intended to style your own text without resorting to complicated string concatenations. It allows you to seamlessly apply formatting to different parts of text designed to be printed to the console.

You can use the markup to convert your markup text to a raw text using the following methods:

  • Creating a Mark instance with your text and calling ParseMarkup().

  • Calling ParseMarkup() from MarkupTools.

This is all found in the Terminaux.Writer.CyclicWriters.Renderer.Markup namespace. This maintains compatibility with Spectre.Console markup syntaxarrow-up-right to some degree.

Supported syntaxes

You can use the following syntaxes:

  • Text formatting that you can use with this syntax: [format]Hello![/]

  • Color specifiers that Terminaux can parse, such as Red, #FF0000, or 255;0;0.

Text formatting

As for text formatting, here are the supported formatting specifiers:

Specifier
Description

bold

Makes the surrounding text bold

conceal

Makes the surrounding text hidden

dim

Makes the surrounding text dimmer

invert

Makes the surrounding text's foreground and background color inverted

italic

Makes the surrounding text italic

rapidblink

Makes the surrounding text blink rapidly

slowblink

Makes the surrounding text blink slowly

standout

Makes the surrounding text stand out

strikethrough

Makes the surrounding text crossed out

underline

Makes the surrounding text underlined

Last updated