Interface GlossaryListProps

Hierarchy

  • GlossaryListProps

Properties

expandedList? glossaryEntries? searchQuery? selectedIndexElement? selectedTags? setExpandedList? useGlossaryList?

Properties

Optional expandedList

expandedList?: string[]

The list of terms of the currently expanded entries.

Optional glossaryEntries

glossaryEntries?: GlossaryEntryProps[]

The entries to be displayed in the list.

Optional searchQuery

searchQuery?: string

The query to search for in the properties of the entries.

Optional selectedIndexElement

selectedIndexElement?: string

The index element to filter the entries by.

Optional selectedTags

selectedTags?: string[]

The tags to filter the entries by.

Optional setExpandedList

setExpandedList?: ((newExpandedList) => void)

Type declaration

    • (newExpandedList): void

    • The function to set the currently expanded entries.

      Parameters

      • newExpandedList: string[]

      Returns void

Optional useGlossaryList

useGlossaryList?: (() => GlossaryListHookReturn)

Type declaration

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc