Skip to content

RichTextBuilder.md

Latest commit

 

History

History
358 lines (184 loc) · 3.8 KB

RichTextBuilder.md

File metadata and controls

358 lines (184 loc) · 3.8 KB

@devvit/public-api v0.12.20-dev

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>

Constructors

new RichTextBuilder()

new RichTextBuilder(): RichTextBuilder

Returns

RichTextBuilder

Methods

animatedImage()

animatedImage(_opts): RichTextBuilder

Append an Animated Image

Parameters

_opts

MediaOptions

Returns

RichTextBuilder

Implementation of

ImageContainer.animatedImage

blockQuote()

blockQuote(_opts, _cb): RichTextBuilder

Append a Block Quote element

Parameters

_opts

BlockQuoteOptions

_cb

(blockQuote) => void

Returns

RichTextBuilder

Implementation of

BlockQuoteContainer.blockQuote

build()

build(): string

Serializes the document to a JSON string

Returns

string

codeBlock()

codeBlock(_opts, _cb): RichTextBuilder

Append a Code Block element

Parameters

_opts

CodeBlockOptions

_cb

(codeBlock) => void

Returns

RichTextBuilder

Implementation of

CodeBlockContainer.codeBlock

embed()

embed(_opts): RichTextBuilder

Append an embedded iframe

Parameters

_opts

EmbedOptions

Returns

RichTextBuilder

Implementation of

EmbedContainer.embed

heading()

heading(_opts, _cb): RichTextBuilder

Append a Heading

Parameters

_opts

HeadingOptions

_cb

(heading) => void

Returns

RichTextBuilder

Implementation of

HeadingContainer.heading

horizontalRule()

horizontalRule(): RichTextBuilder

Append a Horizontal Rule

Returns

RichTextBuilder

Implementation of

HorizontalRuleContainer.horizontalRule

image()

image(_opts): RichTextBuilder

Append an Image

Parameters

_opts

MediaOptions

Returns

RichTextBuilder

Implementation of

ImageContainer.image

list()

list(_opts, _cb): RichTextBuilder

Append a List

Parameters

_opts

ListOptions

_cb

(list) => void

Returns

RichTextBuilder

Implementation of

ListContainer.list

paragraph()

paragraph(_cb): RichTextBuilder

Append a Paragraph

Parameters

_cb

(paragraph) => void

Returns

RichTextBuilder

Implementation of

ParagraphContainer.paragraph

table()

table(_cb): RichTextBuilder

Append a Table

Parameters

_cb

(table) => void

Returns

RichTextBuilder

Implementation of

TableContainer.table

video()

video(_opts): RichTextBuilder

Append a Video

Parameters

_opts

VideoOptions

Returns

RichTextBuilder

Implementation of

VideoContainer.video