platform-bible-react
    Preparing search index...

    Interface FootnoteListProps

    interface FootnoteListProps {
        className?: string;
        footnotes: MarkerObject[];
        formatCaller?: (
            caller: undefined | string,
            index: number,
        ) => undefined | string;
        layout?: FootnoteLayout;
        listId: string | number;
        onFootnoteSelected?: (footnote: MarkerObject) => void;
        selectedFootnote?: MarkerObject;
        showMarkers?: boolean;
        suppressFormatting?: boolean;
    }
    Index

    Properties

    className? footnotes formatCaller? layout? listId onFootnoteSelected? selectedFootnote? showMarkers? suppressFormatting?

    Properties

    className?: string

    Optional additional class name for styling

    footnotes: MarkerObject[]

    The footnotes to display (typically from JSX). See FootnoteItemProps.footnote

    formatCaller?: (caller: undefined | string, index: number) => undefined | string

    A function that can interpret the two special footnote caller codes defined by USFM, + and - in order to display (or suppress display of) a meaningful caller in the context where this is being used.

    layout?: FootnoteLayout

    Determines how footnotes are displayed:

    • 'horizontal': caller and reference appear in a leading-aligned column, with the contents in a second column (typically used in a wide pane below the text).
    • 'vertical': caller and reference appear on the first line, with the contents displayed beneath (typically used side-by-side with the text).
    'horizontal'
    listId: string | number

    ID provided by the caller that should change whenever the list changes (due to additions, deletions or — unlikely — reordering) )

    onFootnoteSelected?: (footnote: MarkerObject) => void

    Callback to handle clicking/selecting a footnote in the list

    selectedFootnote?: MarkerObject

    The currently selected footnote (or undefined if none)

    showMarkers?: boolean

    Flag indicating whether to display USFM-style markers

    suppressFormatting?: boolean

    Flag indicating whether to suppress USFM-style formatting.

    false

    Settings

    Member Visibility

    On This Page

    Properties