text

@skeldjs/text

This package contains a text building API for the Rich Text formatter used in Among Us, meant to be installed separately with npm install --save @skeldjs/text or yarn add @skeldjs/text, and is one package of a bigger project, skeldjs.

You can view auto-updating documentation for this package hosted at github pages at https://skeld.js.org/modules/text.html

Basic Usage

Creating a basic document

const formatted = tb()
    .bold(
        color("red", "Hello")
    );

console.log(formatted.toString()); // <b><color="red">Hello</color></b>

or you can define a boilerplate for the document, where the children of the elements in the tb function are not considered.

const formatted = tb(bold(), color("red"))
    .text("Hello");

console.log(formatted.toString()); // <b><color="red">Hello</color></b>

You can also create elements standalone.

const formatted = bold("Hello");

console.log(formatted.toString()); // <b>Hello</b>

Parse RichText

The package also provides a way to parse the Rich Text format.

const parsed = parseTMP("<b><color=red>Hello</color></b>");

console.log(parsed);
/*
TMPElement {
  tagName: 'doc',
  attributes: {},
  children: [
    TMPElement {
      tagName: 'b',
      attributes: {},
      children: [
        TMPElement {
          tagName: 'color',
          attributes: { color: 'red' },
          children: [ 'Hello' ]
        }
      ]
    }
  ]
}
*/

Generate HTML

It also provides a way to convert roughly to HTML where possible.

const parsed = parseTMP("<b><color=red>Hello</color></b>");

console.log(toHTML(parsed));
/*
<div style="width:100%;height:100%;">
    <b>
        <div style="display:inline-block;color:red">
            <span>Hello</span>
        </div>
    </b>
</div>
*/

Index

Enumerations

Interfaces

Classes

Type aliases

Functions

Type aliases

ParsePart

ParsePart: BaseParsePart | TagParsePart | TextParsePart

TMPColorName

TMPColorName: "black" | "blue" | "green" | "orange" | "purple"

TMPNode

TMPNode: TMPElement | string

TMPRGBA

TMPRGBA: [number, number, number, number]

TMPTag

Functions

align

align(align: Align, ...content: TMPNode[]): TMPElement

- Defined in text/lib/factories.ts:29
Create an alignment element.

Parameters
- align: Align
- Rest ...content: TMPNode[]
Returns TMPElement

alpha

alpha(alpha: string | number, ...content: TMPNode[]): TMPElement

- Defined in text/lib/factories.ts:36
Create an alpha modulator element.

Parameters
- alpha: string | number
- Rest ...content: TMPNode[]
Returns TMPElement

bold

bold(...content: TMPNode[]): TMPElement

- Defined in text/lib/factories.ts:58
Create a bold element.

Parameters
- Rest ...content: TMPNode[]
Returns TMPElement

color

color(clr: string | [number, number, number, number], ...content: TMPNode[]): TMPElement

- Defined in text/lib/factories.ts:43
Create a colour element.

Parameters
- clr: string | [number, number, number, number]
- Rest ...content: TMPNode[]
Returns TMPElement

font

font(face: string, ...content: TMPNode[]): TMPElement

- Defined in text/lib/factories.ts:85
Create a font element.

Parameters
- face: string
- Rest ...content: TMPNode[]
Returns TMPElement

highlight

highlight(color: string | [number, number, number, number], ...content: TMPNode[]): TMPElement

- Defined in text/lib/factories.ts:148
Create a highlight element.

Parameters
- color: string | [number, number, number, number]
- Rest ...content: TMPNode[]
Returns TMPElement

indent

indent(indent: string | number, ...content: TMPNode[]): TMPElement

- Defined in text/lib/factories.ts:92
Create an indentation element.

Parameters
- indent: string | number
- Rest ...content: TMPNode[]
Returns TMPElement

italics

italics(...content: TMPNode[]): TMPElement

- Defined in text/lib/factories.ts:67
Create an italics element.

Parameters
- Rest ...content: TMPNode[]
Returns TMPElement

link

link(resource: string, ...content: TMPNode[]): TMPElement

- Defined in text/lib/factories.ts:113
Create a link element.

Parameters
- resource: string
- Rest ...content: TMPNode[]
Returns TMPElement

lnheight

lnheight(height: string | number, ...content: TMPNode[]): TMPElement

- Defined in text/lib/factories.ts:99
Create a line height element.

Parameters
- height: string | number
- Rest ...content: TMPNode[]
Returns TMPElement

lnindent

lnindent(indent: string | number, ...content: TMPNode[]): TMPElement

- Defined in text/lib/factories.ts:106
Create a line indent element.

Parameters
- indent: string | number
- Rest ...content: TMPNode[]
Returns TMPElement

lowercase

lowercase(...content: TMPNode[]): TMPElement

- Defined in text/lib/factories.ts:120
Create a lowercase element.

Parameters
- Rest ...content: TMPNode[]
Returns TMPElement

margin

margin(margin: string | number, ...content: TMPNode[]): TMPElement

- Defined in text/lib/factories.ts:141
Create a margin element.

Parameters
- margin: string | number
- Rest ...content: TMPNode[]
Returns TMPElement

monospace

monospace(spacing: string | number, ...content: TMPNode[]): TMPElement

- Defined in text/lib/factories.ts:165
Create a monospace element.

Parameters
- spacing: string | number
- Rest ...content: TMPNode[]
Returns TMPElement

nbspace

nbspace(...content: TMPNode[]): TMPElement

- Defined in text/lib/factories.ts:174
Create a non-breaking space element.

Parameters
- Rest ...content: TMPNode[]
Returns TMPElement

nextpage(): TMPElement

- Defined in text/lib/factories.ts:181
Create a page break element.

Returns TMPElement

parseTMP

parseTMP(content: string): any

- Defined in text/lib/parser.ts:156
Parameters
- content: string
Returns any

pos

pos(x: string | number, ...content: TMPNode[]): TMPElement

- Defined in text/lib/factories.ts:188
Create a position element.

Parameters
- x: string | number
- Rest ...content: TMPNode[]
Returns TMPElement

size

size(size: string | number, ...content: TMPNode[]): TMPElement

- Defined in text/lib/factories.ts:195
Create a font size element.

Parameters
- size: string | number
- Rest ...content: TMPNode[]
Returns TMPElement

smallcaps

smallcaps(...content: TMPNode[]): TMPElement

- Defined in text/lib/factories.ts:134
Create a smallcaps element.

Parameters
- Rest ...content: TMPNode[]
Returns TMPElement

space

space(space: string | number): TMPElement

- Defined in text/lib/factories.ts:202
Create a space element.

Parameters
- space: string | number
Returns TMPElement

spacing

spacing(spacing: string | number, ...content: TMPNode[]): TMPElement

- Defined in text/lib/factories.ts:76
Create a spacing element.

Parameters
- spacing: string | number
- Rest ...content: TMPNode[]
Returns TMPElement

st

st(...content: TMPNode[]): TMPElement

- Defined in text/lib/factories.ts:209
Create a strikethrough element.

Parameters
- Rest ...content: TMPNode[]
Returns TMPElement

strikethrough

strikethrough(...content: TMPNode[]): TMPElement

- Defined in text/lib/factories.ts:209
Create a strikethrough element.

Parameters
- Rest ...content: TMPNode[]
Returns TMPElement

subscript

subscript(...content: TMPNode[]): TMPElement

- Defined in text/lib/factories.ts:227
Create a subscript element.

Parameters
- Rest ...content: TMPNode[]
Returns TMPElement

superscript

superscript(...content: TMPNode[]): TMPElement

- Defined in text/lib/factories.ts:236
Create a superscript element.

Parameters
- Rest ...content: TMPNode[]
Returns TMPElement

Const tb

tb(...nodes: TMPElement[]): DocElement

- Defined in text/lib/builder.ts:625
Parameters
- Rest ...nodes: TMPElement[]
Returns DocElement

text(node: TMPNode, parse?: boolean): string | TMPElement

- Defined in text/lib/factories.ts:14
Create a text element.

Parameters
- node: TMPNode
- parse: boolean = false
Returns string | TMPElement

toHTML

toHTML(elem: TMPNode | TMPNode[]): string

- Defined in text/lib/html.ts:3
Parameters
- elem: TMPNode | TMPNode[]
Returns string

underline

underline(...content: TMPNode[]): TMPElement

- Defined in text/lib/factories.ts:218
Create an underline element.

Parameters
- Rest ...content: TMPNode[]
Returns TMPElement

uppercase

uppercase(...content: TMPNode[]): TMPElement

- Defined in text/lib/factories.ts:127
Create an uppercase element.

Parameters
- Rest ...content: TMPNode[]
Returns TMPElement

voffset

voffset(offset: string | number, ...content: TMPNode[]): TMPElement

- Defined in text/lib/factories.ts:245
Create a vertical offset element.

Parameters
- offset: string | number
- Rest ...content: TMPNode[]
Returns TMPElement

width

width(width: string | number, ...content: TMPNode[]): TMPElement

- Defined in text/lib/factories.ts:252
Create a width element.

Parameters
- width: string | number
- Rest ...content: TMPNode[]
Returns TMPElement

@skeldjs/text

Basic Usage

Creating a basic document

Parse RichText

Generate HTML

Index

Enumerations

Interfaces

Classes

Type aliases

Functions

Type aliases

ParsePart

TMPColorName

TMPNode

TMPRGBA

TMPTag

Functions

align

Parameters

align: Align

Rest ...content: TMPNode[]

Returns TMPElement

alpha

Parameters

alpha: string | number

Rest ...content: TMPNode[]

Returns TMPElement

bold

Parameters

Rest ...content: TMPNode[]

Returns TMPElement

color

Parameters

clr: string | [number, number, number, number]

Rest ...content: TMPNode[]

Returns TMPElement

font

Parameters

face: string

Rest ...content: TMPNode[]

Returns TMPElement

highlight

Parameters

color: string | [number, number, number, number]

Rest ...content: TMPNode[]

Returns TMPElement

indent

Parameters

indent: string | number

Rest ...content: TMPNode[]

Returns TMPElement

italics

Parameters

Rest ...content: TMPNode[]

Returns TMPElement

link

Parameters

resource: string

Rest ...content: TMPNode[]

Returns TMPElement

lnheight

Parameters

height: string | number

Rest ...content: TMPNode[]

Returns TMPElement

lnindent

Parameters

indent: string | number

Rest ...content: TMPNode[]

Returns TMPElement

lowercase

Parameters

Rest ...content: TMPNode[]

Returns TMPElement

margin

Parameters

margin: string | number

Rest ...content: TMPNode[]

Returns TMPElement