Skip to main content
Version: Next

@backstage/plugin-search

Home > @backstage/plugin-search

The Backstage plugin that provides your backstage app with search

Functions

Function

Description

HomePageSearchBar(props)

Router()

SearchModal(props)

SearchModalProvider(props)

A context provider responsible for storing and managing state related to the search modal.

SearchPage()

SidebarSearch(props)

SidebarSearchModal(props)

useSearchModal(initialState)

Use this hook to manage the state of SearchModal() and change its visibility. Monitors route changes setting the hidden state to avoid having to call toggleModal on every result click.

Interfaces

Interface

Description

SearchModalChildrenProps

SearchModalProps

Variables

Variable

Description

searchPlugin

SearchType

Type Aliases

Type Alias

Description

HomePageSearchBarProps

Props for HomePageSearchBar().

SearchModalProviderProps

Props for the SearchModalProvider.

SearchModalValue

The state of the search modal, as well as functions for changing the modal's visibility.

SearchTypeAccordionProps

SearchTypeProps

Props for SearchType.

SearchTypeTabsProps

SidebarSearchModalProps

Props for SidebarSearchModal().

SidebarSearchProps

Props for SidebarSearch().