ReferencesOptions

PropTypeDescriptionDefault
display'none' | 'end'

Display mode for the references. References can either be displayed after the response or not displayed at all.

'end'
getHref(reference: FileSectionReference) => string | undefined

Callback to transform a reference into an href

getLabel(reference: FileSectionReference) => string | undefined

Callback to transform a reference into a label

filter(reference: FileSectionReference) => boolean

Callback to filter references. If filter returns false, the reference is not displayed. If filter is not defined, all references are displayed.

headingstring

Heading above the references

"Related articles"
loadingTextstring

Loading text, default: Fetching context…

transformReferenceId(referenceId: string) => { href: string; text: string; }

Callback to transform a reference id into an href and text