@backstage/plugin-search-react

Home > @backstage/plugin-search-react

Search Plugin frontend library

Classes

Class	Description
MockSearchApi	Search Api Mock that can be used in tests and storybooks

Functions

Function	Description
AutocompleteFilter(props)
CheckboxFilter(props)
createSearchResultListItemExtension(options)	Creates a search result item extension.
DefaultResultListItem(props)
HighlightedSearchResultText(props)
SearchAutocompleteDefaultOption(props)	A default search autocomplete option component.
SearchContextProvider(props)	Search context provider which gives you access to shared state between search components
SearchPagination(props)	A component for setting the search context page limit and cursor.
SearchPaginationBase(props)	A component with controls for search results pagination.
SearchResult(props)	A component returning the search result from a parent search context or api.
SearchResultApi(props)	Request results through the search api and provide them to a child function.
SearchResultComponent(props)	Renders results from a parent search context or api.
SearchResultContext(props)	Provides context-based results to a child function.
SearchResultGroup(props)	Given a query, search for results and render them as a group.
SearchResultGroupFilterFieldLayout(props)	Default layout for a search group filter field.
SearchResultGroupLayout(props)	Default layout for rendering search results in a group.
SearchResultGroupSelectFilterField(props)	A select field that can be used as filter on search result groups.
SearchResultGroupTextFilterField(props)	A text field that can be used as filter on search result groups.
SearchResultList(props)	Given a query, search for results and render them as a list.
SearchResultListItemExtensions(props)	Render results using search extensions.
SearchResultListLayout(props)	Default layout for rendering search results in a list.
SearchResultPager()
SearchResultState(props)	Call a child render function passing a search state as an argument.
SelectFilter(props)
useSearch()	React hook which provides the search context
useSearchContextCheck()	React hook which checks for an existing search context
useSearchResultListItemExtensions(children)	Returns a function that renders a result using extensions.

Interfaces

Interface	Description
SearchApi

Variables

Variable	Description
searchApiRef
SearchAutocomplete	Recommended search autocomplete when you use the Search Provider or Search Context.
SearchBar	Recommended search bar when you use the Search Provider or Search Context.
SearchBarBase	All search boxes exported by the search plugin are based on the , and this one is based on the component from Material UI. Recommended if you don't use Search Provider or Search Context.
SearchFilter

Type Aliases

Type Alias	Description
DefaultResultListItemProps	Props for DefaultResultListItem()
HighlightedSearchResultTextClassKey
HighlightedSearchResultTextProps	Props for HighlightedSearchResultText().
SearchAutocompleteComponent	Type for SearchAutocomplete.
SearchAutocompleteDefaultOptionProps	Props for SearchAutocompleteDefaultOption().
SearchAutocompleteFilterProps
SearchAutocompleteProps	Props for SearchAutocomplete.
SearchBarBaseProps	Props for SearchBarBase.
SearchBarProps	Props for SearchBar.
SearchContextProviderProps	Props for SearchContextProvider()
SearchContextState
SearchContextValue
SearchFilterComponentProps
SearchFilterWrapperProps
SearchPaginationBaseProps	Props for SearchPaginationBase().
SearchPaginationLimitOption	A page limit option, this value must not be greater than 100.
SearchPaginationLimitText	A page limit text, this function is called with a "{ from, to, page, count }" object.
SearchPaginationProps	Props for SearchPagination().
SearchResultApiProps	Props for SearchResultApi()
SearchResultContextProps	Props for SearchResultContext()
SearchResultGroupFilterFieldLayoutProps	Props for SearchResultGroupFilterFieldLayout()
SearchResultGroupFilterFieldPropsWith	Common props for a result group filter field.
SearchResultGroupLayoutProps	Props for SearchResultGroupLayout()
SearchResultGroupProps	Props for SearchResultGroup().
SearchResultGroupSelectFilterFieldProps	Props for SearchResultGroupTextFilterField().
SearchResultGroupTextFilterFieldProps	Props for SearchResultGroupTextFilterField().
SearchResultListItemExtensionOptions	Options for createSearchResultListItemExtension().
SearchResultListItemExtensionProps	Extends props for any search result list item extension
SearchResultListItemExtensionsProps	Props for SearchResultListItemExtensions()
SearchResultListLayoutProps	Props for SearchResultListLayout()
SearchResultListProps	Props for SearchResultList().
SearchResultProps	Props for SearchResult()
SearchResultStateProps	Props for SearchResultState()