Class Renderer

A class that stores materialized options for rendering NPF to HTML.

Callers may extend this class and override any of its render*() methods to change the way particular NPF components are rendered.

Constructors

constructor

new Renderer(options?): Renderer
Parameters
- Optionaloptions: Options
Returns Renderer
- Defined in renderer.ts:64

Properties

`Readonly`askingAvatar

askingAvatar: VisualMedia[]

See

Options.askingAvatar

`Readonly`prefix

prefix: string

See

Options.prefix

Methods

escape

escape(text): string
Escapes all characters in text that aren't safe to use literally in HTML text or attributes.
Parameters
- text: string
Returns string
- Defined in renderer.ts:73

formatText

formatText(text, formatting): string
HTML-escapes text and formats it according to formatting.
Parameters
- text: string
- formatting: undefined | InlineFormat[]
Returns string
- Defined in renderer.ts:83

renderAskLayout

renderAskLayout(layout, html): string
Wraps html as an ask.
Parameters
- layout: AskLayout
- html: string
Returns string
- Defined in renderer.ts:88

renderAttribution

renderAttribution(attribution): string
Converts attribution to HTML.
Parameters
- attribution: Attribution
Returns string
- Defined in renderer.ts:93

renderAudio

renderAudio(block): string
Converts block to HTML.
Parameters
- block: AudioBlock
Returns string
- Defined in renderer.ts:98

renderImage

renderImage(block): string
Converts block to HTML.
Parameters
- block: ImageBlock
Returns string
- Defined in renderer.ts:103

renderImageMedia

renderImageMedia(media, options?): string
Converts media to HTML.
Parameters
- media: VisualMedia[]
- Optionaloptions: {
  alt?: string;
  }
  - Optionalalt?: string
    The alt text for the media.
Returns string
- Defined in renderer.ts:123

renderInlineFormat

renderInlineFormat(html, format): string
Applies the formatting specified by format to html, which may already include nested formatting.

The html has already been trimmed to only the section to which format applies.
Parameters
- html: string
- format: InlineFormat
Returns string
- Defined in renderer.ts:114

renderLink

renderLink(block): string
Converts block to HTML.
Parameters
- block: LinkBlock
Returns string
- Defined in renderer.ts:128

renderPaywall

renderPaywall(block): string
Converts block to HTML.
Parameters
- block: PaywallBlock
Returns string
- Defined in renderer.ts:133

renderPoll

renderPoll(block): string
Converts block to HTML.
Parameters
- block: PollBlock
Returns string
- Defined in renderer.ts:138

renderRowLayout

renderRowLayout(display, html): string
Wraps html as single row.
Parameters
- display: RowsDisplay
- html: string
Returns string
- Defined in renderer.ts:143

renderTextIndented

renderTextIndented(blocksAndNested): string
Converts blocksAndNested to HTML.

The first element of blocksAndNested determines the subtype of the entire thing; any other blocks are guaranteed to have the same subtype. The string elements of blocksAndNested ar TextBlockIndented objects which are more deeply nested and have already been converted to HTML.
Parameters
- blocksAndNested: [TextBlockIndented, ...(string | TextBlockIndented)[]]
Returns string
- Defined in renderer.ts:161

renderTextNoIndent

renderTextNoIndent(block): string
Converts block to HTML.
Parameters
- block: TextBlockNoIndent
Returns string
- Defined in renderer.ts:148

renderTruncateLayout

renderTruncateLayout(html): string
Renders html as a "below the fold" read more.
Parameters
- html: string
Returns string
- Defined in renderer.ts:168

renderUnknown

renderUnknown(block): string
Renders block as HTML.
Parameters
- block: UnknownBlock
Returns string
- Defined in renderer.ts:173

renderVideo

renderVideo(block): string
Converts block to HTML.
Parameters
- block: VideoBlock
Returns string
- Defined in renderer.ts:181