Type Alias RenderHtmlOptions

Type Declaration

• blockCardExpansion: boolean

  If set to true, all cards will be expanded and expansion toggling will be disabled.

  Default

  false
  Copy

• currentlyExpanded: { [SectionKey in string]: boolean }

  Currently expanded sections and sources.

• expandAllCards: boolean

  If set to true, all cards will start out expanded.

  Default

  false
  Copy

• expandFirstCard: boolean

  If set to true, the first card will start out expanded.

  Default

  false
  Copy

• expandSourcesOnPrint: boolean

  If true, all sources will be expanded when printing.

  Default

  false
  Copy

• hideViewOnPageButtons: boolean

  If true, the view-on-page eyeball buttons are not rendered.

  Default

  false
  Copy

• isPhoneSize: boolean

  If true, phone-size compatible rendering will be used where supported.

  Default

  false
  Copy

• markdownStyles: string | CSSResult

  CSS styles for rendering internal Markdown.

• processingIcon: ViraIconSvg

  The icon shown next to processing text.

  Default

  LoaderAnimated24Icon
  Copy

• processingString: string

  The string to use within the processing section.

  Default

  'Processing'
  Copy

• sourceIcon: ViraIconSvg

  The icon shown for source expansion.

  Default

  DocumentSearch24Icon
  Copy

• useCardStyles: boolean

  If true, cards are wrapped in collapsible card components with borders and expansion controls. If false, card sections are rendered without card wrapper styling.

  Default

  false
  Copy

• useDrawerForSources: boolean

  If true, sources will be rendered inside a drawer instead of a collapsible wrapper.

  Default

  false
  Copy

• viewOnPageIcon: ViraIconSvg

  The icon used for "view on page" buttons.

  Default

  EyeOpen24Icon
  Copy

• createViewOnPageString: function

  • createViewOnPageString(this: void, pageNumber: number): string

    Create a string for the source "view on page" buttons.

    This will only be used if hideViewOnPageButtons is not set to true.

    Parameters

    • this: void
    • pageNumber: number

    Returns string