Class: RichTextBuilder

Mixes

ParagraphContainer

Mixes

HeadingContainer

Mixes

HorizontalRuleContainer

Mixes

BlockQuoteContainer

Mixes

CodeBlockContainer

Mixes

EmbedContainer

Mixes

ListContainer

Mixes

TableContainer

Mixes

ImageContainer

Mixes

VideoContainer

Implements

• ParagraphContainer<RichTextBuilder>
• HeadingContainer<RichTextBuilder>
• HorizontalRuleContainer<RichTextBuilder>
• BlockQuoteContainer<RichTextBuilder>
• CodeBlockContainer<RichTextBuilder>
• EmbedContainer<RichTextBuilder>
• ListContainer<RichTextBuilder>
• TableContainer<RichTextBuilder>
• ImageContainer<RichTextBuilder>
• VideoContainer<RichTextBuilder>

Table of contents

Constructors

• constructor

Methods

• animatedImage
• blockQuote
• build
• codeBlock
• embed
• heading
• horizontalRule
• image
• list
• paragraph
• table
• video

Constructors

constructor

• new RichTextBuilder(): RichTextBuilder

Returns

RichTextBuilder

Methods

animatedImage

▸ animatedImage(_opts): RichTextBuilder

Parameters

Name	Type
_opts	MediaOptions

Returns

RichTextBuilder

Implementation of

ImageContainer.animatedImage

---

blockQuote

▸ blockQuote(_opts, _cb): RichTextBuilder

Parameters

Name	Type
_opts	BlockQuoteOptions
_cb	(blockQuote: BlockQuoteContext) => void

Returns

RichTextBuilder

Implementation of

BlockQuoteContainer.blockQuote

---

build

▸ build(): string

Serializes the document to a JSON string

Returns

string

---

codeBlock

▸ codeBlock(_opts, _cb): RichTextBuilder

Parameters

Name	Type
_opts	CodeBlockOptions
_cb	(codeBlock: CodeBlockContext) => void

Returns

RichTextBuilder

Implementation of

CodeBlockContainer.codeBlock

---

embed

▸ embed(_opts): RichTextBuilder

Parameters

Name	Type
_opts	EmbedOptions

Returns

RichTextBuilder

Implementation of

EmbedContainer.embed

---

heading

▸ heading(_opts, _cb): RichTextBuilder

Parameters

Name	Type
_opts	HeadingOptions
_cb	(heading: HeadingContext) => void

Returns

RichTextBuilder

Implementation of

HeadingContainer.heading

---

horizontalRule

▸ horizontalRule(): RichTextBuilder

Returns

RichTextBuilder

Implementation of

HorizontalRuleContainer.horizontalRule

---

image

▸ image(_opts): RichTextBuilder

Parameters

Name	Type
_opts	MediaOptions

Returns

RichTextBuilder

Implementation of

ImageContainer.image

---

list

▸ list(_opts, _cb): RichTextBuilder

Parameters

Name	Type
_opts	ListOptions
_cb	(list: ListContext) => void

Returns

RichTextBuilder

Implementation of

ListContainer.list

---

paragraph

▸ paragraph(_cb): RichTextBuilder

Parameters

Name	Type
_cb	(paragraph: ParagraphContext) => void

Returns

RichTextBuilder

Implementation of

ParagraphContainer.paragraph

---

table

▸ table(_cb): RichTextBuilder

Parameters

Name	Type
_cb	(table: TableContext) => void

Returns

RichTextBuilder

Implementation of

TableContainer.table

---

video

▸ video(_opts): RichTextBuilder

Parameters

Name	Type
_opts	VideoOptions

Returns

RichTextBuilder

Implementation of

VideoContainer.video