RichTextEngine
Defined in: src/render/rich/text.ts:76
Builds styled text from inline markup into Spans (the engine behind RichText; exported as RichTextEngine).
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new RichTextEngine(
plain,spans?):RichText
Defined in: src/render/rich/text.ts:82
Parameters
Section titled “Parameters”string
spans?
Section titled “spans?”Span[] = []
Returns
Section titled “Returns”RichText
Properties
Section titled “Properties”
readonlyplain:string
Defined in: src/render/rich/text.ts:78
The text with markup stripped.
readonlyspans:Span[]
Defined in: src/render/rich/text.ts:80
Styled ranges over plain.
Methods
Section titled “Methods”toSegments()
Section titled “toSegments()”toSegments(
baseStyle?):Segment[]
Defined in: src/render/rich/text.ts:185
Convert the RichText structure to rendering Segments.
Parameters
Section titled “Parameters”baseStyle?
Section titled “baseStyle?”Style = Style.DEFAULT
Returns
Section titled “Returns”Segment[]
fromMarkup()
Section titled “fromMarkup()”
staticfromMarkup(markup):RichText
Defined in: src/render/rich/text.ts:91
Parse console markup (e.g., “[bold red]hello[/bold red]” or “[bold]hello[/]”) into a RichText instance. Supports escaping with backslashes.
Parameters
Section titled “Parameters”markup
Section titled “markup”string
Returns
Section titled “Returns”RichText