Skip to main content

@backstage/plugin-search-react

Home > @backstage/plugin-search-react

Search Plugin frontend library

Classes

ClassDescription
MockSearchApiSearch Api Mock that can be used in tests and storybooks

Functions

FunctionDescription
SearchResultApi(props)Request results through the search api and provide them to a child function.
SearchResultContext(props)Provides context-based results to a child function.
SearchResultGroup(props)Given a query, search for results and render them as a group.
SearchResultGroupLayout(props)Default layout for rendering search results in a group.

Interfaces

InterfaceDescription
SearchApi

Variables

VariableDescription
AutocompleteFilter
CheckboxFilter
createSearchResultListItemExtensionCreates a search result item extension.
DefaultResultListItem
HighlightedSearchResultText
searchApiRef
SearchAutocompleteRecommended search autocomplete when you use the Search Provider or Search Context.
SearchAutocompleteDefaultOptionA default search autocomplete option component.
SearchBarRecommended search bar when you use the Search Provider or Search Context.
SearchBarBaseAll 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.
SearchContextProviderSearch context provider which gives you access to shared state between search components
SearchFilter
SearchPaginationA component for setting the search context page limit and cursor.
SearchPaginationBaseA component with controls for search results pagination.
SearchResultA component returning the search result from a parent search context or api.
SearchResultComponentRenders results from a parent search context or api.
SearchResultGroupFilterFieldLayoutDefault layout for a search group filter field.
SearchResultGroupSelectFilterFieldA select field that can be used as filter on search result groups.
SearchResultGroupTextFilterFieldA text field that can be used as filter on search result groups.
SearchResultListGiven a query, search for results and render them as a list.
SearchResultListItemExtensionsRender results using search extensions.
SearchResultListLayoutDefault layout for rendering search results in a list.
SearchResultPager
SearchResultStateCall a child render function passing a search state as an argument.
SelectFilter
useSearchReact hook which provides the search context
useSearchContextCheckReact hook which checks for an existing search context
useSearchResultListItemExtensionsReturns a function that renders a result using extensions.

Type Aliases

Type AliasDescription
DefaultResultListItemPropsProps for DefaultResultListItem
HighlightedSearchResultTextPropsProps for HighlightedSearchResultText.
SearchAutocompleteComponentType for SearchAutocomplete.
SearchAutocompleteDefaultOptionPropsProps for SearchAutocompleteDefaultOption.
SearchAutocompleteFilterProps
SearchAutocompletePropsProps for SearchAutocomplete.
SearchBarBasePropsProps for SearchBarBase.
SearchBarPropsProps for SearchBar.
SearchContextProviderPropsProps for SearchContextProvider
SearchContextState
SearchContextValue
SearchFilterComponentProps
SearchFilterWrapperProps
SearchPaginationBasePropsProps for SearchPaginationBase.
SearchPaginationLimitOptionA page limit option, this value must not be greater than 100.
SearchPaginationLimitTextA page limit text, this function is called with a "{ from, to, page, count }" object.
SearchPaginationPropsProps for SearchPagination.
SearchResultApiPropsProps for SearchResultApi()
SearchResultContextPropsProps for SearchResultContext()
SearchResultGroupFilterFieldLayoutPropsProps for SearchResultGroupFilterFieldLayout
SearchResultGroupFilterFieldPropsWithCommon props for a result group filter field.
SearchResultGroupLayoutPropsProps for SearchResultGroupLayout()
SearchResultGroupPropsProps for SearchResultGroup().
SearchResultGroupSelectFilterFieldPropsProps for SearchResultGroupTextFilterField.
SearchResultGroupTextFilterFieldPropsProps for SearchResultGroupTextFilterField.
SearchResultListItemExtensionOptionsOptions for createSearchResultListItemExtension.
SearchResultListItemExtensionPropsExtends props for any search result list item extension
SearchResultListItemExtensionsPropsProps for SearchResultListItemExtensions
SearchResultListLayoutPropsProps for SearchResultListLayout
SearchResultListPropsProps for SearchResultList.
SearchResultPropsProps for SearchResult
SearchResultStatePropsProps for SearchResultState