structured-render - v2.17.1
    Preparing search index...

    Type Alias RenderHtmlOptions<IconKey>

    RenderHtmlOptions: RenderOptions<IconKey> & {
        blockCardExpansion: boolean;
        currentlyExpanded: { [SectionKey in string]: boolean };
        devDebug: boolean;
        expandAllCards: boolean;
        expandFirstCard: boolean;
        expandSourcesOnPrint: boolean;
        hideCardTitles: boolean;
        hideViewOnPageButtons: boolean;
        isPhoneSize: boolean;
        markdownStyles: string | CSSResult;
        processingIcon: ViraIconSvg;
        processingString: string;
        sourceIcon: ViraIconSvg;
        tableSortStates: { [TableKey in string]: TableSortState | undefined };
        useCardStyles: boolean;
        useDrawerForSources: boolean;
        viewOnPageIcon: ViraIconSvg;
        createViewOnPageString(this: void, pageNumber: number): string;
    }

    Option values for Structured Render rendering to HTML.

    Type Parameters

    • IconKey extends string = string

    Type Declaration

    • blockCardExpansion: boolean

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

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

      Currently expanded sections and sources.

    • devDebug: boolean

      Passed to section types that support dev debugging.

      false
    • expandAllCards: boolean

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

      false
    • expandFirstCard: boolean

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

      false
    • expandSourcesOnPrint: boolean

      If true, all sources will be expanded when printing.

      false
    • hideCardTitles: boolean

      If true, card titles (and their icons) are not rendered, even when set on the card data.

      false
    • hideViewOnPageButtons: boolean

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

      false
    • isPhoneSize: boolean

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

      false
    • markdownStyles: string | CSSResult

      CSS styles for rendering internal Markdown.

    • processingIcon: ViraIconSvg

      The icon shown next to processing text.

      LoaderAnimated24Icon
    • processingString: string

      The string to use within the processing section.

      'Processing'
    • sourceIcon: ViraIconSvg

      The icon shown for source expansion.

      LucideFileSearchIcon
    • tableSortStates: { [TableKey in string]: TableSortState | undefined }

      Current sort state for each table, keyed by the table's key chain.

    • 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.

      false
    • useDrawerForSources: boolean

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

      false
    • viewOnPageIcon: ViraIconSvg

      The icon used for "view on page" buttons.

      LucideEyeIcon
    • 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

    Settings
    Member Visibility