Interface GlossaryListHookReturn

Hierarchy

GlossaryListHookReturn

Index

Properties

filterByIndexElement filterByTags searchByQuery

Properties

`Readonly` filterByIndexElement

filterByIndexElement: ((glossaryEntries, selectedIndexElement?) => GlossaryEntryProps[])

Type declaration

- (glossaryEntries, selectedIndexElement?): GlossaryEntryProps[]
- Function to filter the glossary entries by index element.
  Parameters
  - glossaryEntries: GlossaryEntryProps[]
  - Optional selectedIndexElement: string
  Returns GlossaryEntryProps[]

`Readonly` filterByTags

filterByTags: ((glossaryEntries, selectedTags?) => GlossaryEntryProps[])

Type declaration

- (glossaryEntries, selectedTags?): GlossaryEntryProps[]
- Function to filter the glossary entries by tags.
  Parameters
  - glossaryEntries: GlossaryEntryProps[]
  - Optional selectedTags: string[]
  Returns GlossaryEntryProps[]

`Readonly` searchByQuery

searchByQuery: ((glossaryEntries, searchQuery?) => GlossaryEntryProps[])

Type declaration

- (glossaryEntries, searchQuery?): GlossaryEntryProps[]
- Function to search the glossary entries by query.
  Parameters
  - glossaryEntries: GlossaryEntryProps[]
  - Optional searchQuery: string
  Returns GlossaryEntryProps[]

Generated using TypeDoc