TMPElement | SkeldJS

Hierarchy

TMPElement

Index

Properties

Methods

Constructors

constructor

Properties

Static SINGLES

SINGLES: TMPTag[] = ...

Readonly attributes

attributes: Record<string, string | number>

children

children: TMPNode[]

Readonly tagName

tagName: TMPTag

Methods

align

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

- Defined in text/lib/builder.ts:203
Set the alignment of the text.
example
```
const formatted = tb().align(Align.Center, "center content moment");
```
Parameters
- alignment: Align
- Rest ...content: TMPNode[]
Returns TMPElement

alpha

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

- Defined in text/lib/builder.ts:215
Set the opacity of the text.
example
```
const formatted = tb().alpha("AA");
```
Parameters
- opacity: string | number
- Rest ...content: TMPNode[]
Returns TMPElement

bold

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

- Defined in text/lib/builder.ts:246
Make the text bold.
example
```
const formatted = tb().bold("bold text....");
```
Parameters
- Rest ...content: TMPNode[]
Returns TMPElement

clone

clone(): TMPElement

Deep clone the tree.

example

const formatted = tb(color("blue"), italics())
  .text("Deep clone!!!");

const clone = formatted.clone();

Returns TMPElement

color

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

- Defined in text/lib/builder.ts:231
Set the colour of the text
example
```
const formatted = tb().color("ff0000ff", "Red text.");
```
Or using RGBA:
```
const formatted = tb().color([255, 0, 0, 255], "RGBA red text.");
```
Parameters
- clr: string | [number, number, number, number]
- Rest ...content: TMPNode[]
Returns TMPElement

font

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

- Defined in text/lib/builder.ts:282
Change the font face of the text.
example
```
const formatted = tb().font("Comic Sans MS", "funeral service.");
```
Parameters
- face: string
- Rest ...content: TMPNode[]
Returns TMPElement

getAttributes

getAttributes(): string

- Defined in text/lib/builder.ts:132
Get the representation of the element attributes as a string.

Returns string

getClosing

getClosing(): string

- Defined in text/lib/builder.ts:172
Get the representation of the element closing tag as a string.

Returns string

getInner

getInner(): string

- Defined in text/lib/builder.ts:113
Get the inner representation of the element structure as a string.

Returns string

getOuter

getOuter(): string

- Defined in text/lib/builder.ts:106
Get the outer representation of the element structure as a string.

Returns string

getTag

getTag(): string

- Defined in text/lib/builder.ts:161
Get the representation of the element tag as a string.

Returns string

highlight

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

Change the background colour of the text.

example

const formatted = tb().highlight("00ff00aa", "This text has a green background.");

Or using RGBA:

const formatted = tb().highlight([0, 255, 0, 255], "This text has a green background.");

Parameters

color: string | [number, number, number, number]
Rest ...content: TMPNode[]

Returns void

indent

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

- Defined in text/lib/builder.ts:294
Change the left indentation of the text.
example
```
const formatted = tb().indent("5em", "I am indented by 5.");
```
Parameters
- indentation: string | number
- Rest ...content: TMPNode[]
Returns TMPElement

italics

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

- Defined in text/lib/builder.ts:258
Make the text italic.
example
```
const formatted = tb().italics("italic text....");
```
Parameters
- Rest ...content: TMPNode[]
Returns TMPElement

link

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

- Defined in text/lib/builder.ts:330
Create a link to a resource (Not necessarily related to anything).
example
```
const formatted = tb().link("https://google.com", "click here to get tracked.");
```
Parameters
- resource: string
- Rest ...content: TMPNode[]
Returns boolean

lnheight

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

- Defined in text/lib/builder.ts:306
Change the line height of the text.
example
```
const formatted = tb().indent("2em", "I have huge line spacing like a boss.");
```
Parameters
- height: string | number
- Rest ...content: TMPNode[]
Returns boolean

lnindent

lnindent(indentation: string | number, ...content: TMPNode[]): boolean

- Defined in text/lib/builder.ts:318
Change only the indentation for the first line of the text.
example
```
const formatted = tb().indent("2em", "Only this line is indented, any other line will not be indented as displayed by this long piece of text.");
```
Parameters
- indentation: string | number
- Rest ...content: TMPNode[]
Returns boolean

lowercase

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

- Defined in text/lib/builder.ts:342
Force the text to be rendered as lowercase.
example
```
const formatted = tb().lowercase("THIS TEXT WILL BE IN LOWERCASE."):
```
Parameters
- Rest ...content: TMPNode[]
Returns TMPElement

margin

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

- Defined in text/lib/builder.ts:378
Change the margin of the text.
example
```
const formatted = tb().margin("5em", "Margin text."):
```
Parameters
- amount: string | number
- Rest ...content: TMPNode[]
Returns void

mark

mark(color: string | [number, number, number, number], ...content: TMPNode[]): void

- Defined in text/lib/builder.ts:411
Change the background colour of the text.
example
```
const formatted = tb().mark("00ff00aa", "This text has a green background.");
```
Or using RGBA:
```
const formatted = tb().mark([0, 255, 0, 255], "This text has a green background.");
```
Parameters
- color: string | [number, number, number, number]
- Rest ...content: TMPNode[]
Returns void

mono

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

- Defined in text/lib/builder.ts:425
Force the text to be rendered monospace.
example
```
const formatted = tb().mono("1em", "console.log('Code block.').");
```
Parameters
- spacing: string | number
- Rest ...content: TMPNode[]
Returns TMPElement

nbspace

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

- Defined in text/lib/builder.ts:437
Stop spaces from breaking up text.
example
```
const formatted = tb().nbspace("This text does not B R E A K U P")
```
Parameters
- Rest ...content: TMPNode[]
Returns TMPElement

nextpage(): TMPElement

Move to the next page.

example

const formatted = tb().text("This text").nextpage().text("goes across two pages");

Returns TMPElement

pos

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

- Defined in text/lib/builder.ts:461
Change the position of the text on the x axis.
example
```
const formatted = tb().pos("50%", "I am in the middle of the box.");
```
Parameters
- x: string | number
- Rest ...content: TMPNode[]
Returns TMPElement

s

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

- Defined in text/lib/builder.ts:531
Create a line through the text.
example
```
const formatted = tb().s("Nevermind");
```
Parameters
- Rest ...content: TMPNode[]
Returns TMPElement

size

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

- Defined in text/lib/builder.ts:473
Change the size of the font.
example
```
const formatted = tb().size("150%", "This text is rather large.");
```
Parameters
- size: string | number
- Rest ...content: TMPNode[]
Returns TMPElement

smallcaps

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

- Defined in text/lib/builder.ts:366
Force the text to be rendered as small caps.
example
```
const formatted = tb().smallcaps("This Text Will Be In Small Caps"):
```
Parameters
- Rest ...content: TMPNode[]
Returns TMPElement

space

space(space: string | number): TMPElement

- Defined in text/lib/builder.ts:485
Create a space of a specified size.
example
```
const formatted = tb().text("Huge").space("5em").text("space");
```
Parameters
- space: string | number
Returns TMPElement

spacing

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

- Defined in text/lib/builder.ts:270
Change the spacing relative to normal character spacing.
example
```
const formatted = tb().spacing("0.5em", "Spaced out text moment.");
```
Parameters
- space: string | number
- Rest ...content: TMPNode[]
Returns TMPElement

st

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

- Defined in text/lib/builder.ts:520
Create a line through the text.
example
```
const formatted = tb().st("Nevermind");
```
Parameters
- Rest ...content: TMPNode[]
Returns TMPElement

strike

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

- Defined in text/lib/builder.ts:509
Create a line through the text.
example
```
const formatted = tb().strike("Nevermind");
```
Parameters
- Rest ...content: TMPNode[]
Returns TMPElement

strikethrough

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

- Defined in text/lib/builder.ts:497
Create a line through the text.
example
```
const formatted = tb().strikethrough("Nevermind");
```
Parameters
- Rest ...content: TMPNode[]
Returns TMPElement

subscript

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

- Defined in text/lib/builder.ts:554
Create a text in subscript.
example
```
const formatted = tb().text("log").subscript("2").text("(8) = 3");
```
Parameters
- Rest ...content: TMPNode[]
Returns TMPElement

superscript

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

- Defined in text/lib/builder.ts:566
Create a text in superscript.
example
```
const formatted = tb().text("6").superscript("2").text(" = 36");
```
Parameters
- Rest ...content: TMPNode[]
Returns TMPElement

text

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

- Defined in text/lib/builder.ts:191
Create a text element.
example
```
const formatted = tb().text("text element like a boss");
```
Parameters
- node: TMPNode
- parse: boolean = false
Returns TMPElement

toString

toString(): string

- Defined in text/lib/builder.ts:99
Get the representation of the element structure as a string.

Returns string

underline

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

- Defined in text/lib/builder.ts:542
Create a underline underneath the text.
example
```
const formatted = tb().underline("Important text");
```
Parameters
- Rest ...content: TMPNode[]
Returns TMPElement

uppercase

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

- Defined in text/lib/builder.ts:354
Force the text to be rendered as uppercase.
example
```
const formatted = tb().uppercase("this text will be in lowercase."):
```
Parameters
- Rest ...content: TMPNode[]
Returns TMPElement

voffset

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

- Defined in text/lib/builder.ts:578
Change the vertical offset of the text.
example
```
const formatted = tb().voffset("5em", "This text is high up.").voffset(" and this one is low down.");
```
Parameters
- offset: string | number
- Rest ...content: TMPNode[]
Returns TMPElement

width

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

- Defined in text/lib/builder.ts:590
Change the maximum width of the text before wrapping.
example
```
const formatted = tb().width("25%", "This text doesn't go that far :(");
```
Parameters
- width: string | number
- Rest ...content: TMPNode[]
Returns TMPElement

Constructors

constructor

new TMPElement(tagName: TMPTag, attributes: Record<string, string | number>, content?: TMPNode | TMPNode[]): TMPElement

- Defined in text/lib/builder.ts:57
Parameters
- tagName: TMPTag
- attributes: Record<string, string | number>
- Optional content: TMPNode | TMPNode[]
Returns TMPElement

Hierarchy

Index

Properties

Methods

Constructors

Properties

Static SINGLES

Readonly attributes

children

Readonly tagName

Methods

align

Parameters

alignment: Align

Rest ...content: TMPNode[]

Returns TMPElement

alpha

Parameters

opacity: string | number

Rest ...content: TMPNode[]

Returns TMPElement

bold

Parameters

Rest ...content: TMPNode[]

Returns TMPElement

clone

Returns TMPElement

color

Parameters

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

Rest ...content: TMPNode[]

Returns TMPElement

font

Parameters

face: string

Rest ...content: TMPNode[]

Returns TMPElement

getAttributes

Returns string

getClosing

Returns string

getInner

Returns string

getOuter

Returns string

getTag

Returns string

highlight

Parameters

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

Rest ...content: TMPNode[]

Returns void

indent

Parameters

indentation: string | number

Rest ...content: TMPNode[]

Returns TMPElement

italics

Parameters

Rest ...content: TMPNode[]

Returns TMPElement

link

Parameters

resource: string

Rest ...content: TMPNode[]

Returns boolean

lnheight

Parameters

height: string | number

Rest ...content: TMPNode[]

Returns boolean

lnindent

Parameters

indentation: string | number

Rest ...content: TMPNode[]

Returns boolean

lowercase

Parameters

Rest ...content: TMPNode[]

Returns TMPElement