Optional
formatA 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.
Optional
layoutDetermines 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).Optional
showFlag indicating whether to display USFM-style markers
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. Thecontent
of those nested objects will be plain strings, containing the text of the individual footnote data (reference, quoted text, footnote text, etc.).