platform-bible-react
    Preparing search index...

    Interface FootnoteItemProps

    Interface defining the properties for a single footnote item component

    interface FootnoteItemProps {
        footnote: MarkerObject;
        formatCaller?: (caller: undefined | string) => undefined | string;
        layout?: FootnoteLayout;
        showMarkers?: boolean;
    }
    Index

    Properties

    footnote: MarkerObject

    The footnote to display (typically from JSX). Note: Although MarkerObject.content is an array of MarkerObject, in practice, for footnotes that array contains only one additional level of MarkerObject objects. The content of those nested objects will be plain strings, containing the text of the individual footnote data (reference, quoted text, footnote text, etc.).

    formatCaller?: (caller: undefined | string) => 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.

    Determines how footnotes are displayed:

    • 'horizontal': the note's marker and caller appear in a leading-aligned column, with the note text in a second column (typically used in a wide pane below the text).
    • 'vertical': the note's marker and caller appear on the first line, with the note text displayed beneath (typically used side-by-side with the text).

    A leading \fr/\xo target reference is part of the note text in both layouts, as it is in PT9's notes pane - it is not aligned in a column of its own.

    'horizontal'
    
    showMarkers?: boolean

    Flag indicating whether to display USFM-style markers