@backstage/plugin-search-react
Home > @backstage/plugin-search-react
Search Plugin frontend library
Classes
Class |
Description |
---|---|
Search Api Mock that can be used in tests and storybooks |
Functions
Function |
Description |
---|---|
Creates a search result item extension. | |
A default search autocomplete option component. | |
Search context provider which gives you access to shared state between search components | |
A component for setting the search context page limit and cursor. | |
A component with controls for search results pagination. | |
A component returning the search result from a parent search context or api. | |
Request results through the search api and provide them to a child function. | |
Renders results from a parent search context or api. | |
Provides context-based results to a child function. | |
Given a query, search for results and render them as a group. | |
Default layout for a search group filter field. | |
Default layout for rendering search results in a group. | |
A select field that can be used as filter on search result groups. | |
A text field that can be used as filter on search result groups. | |
Given a query, search for results and render them as a list. | |
Render results using search extensions. | |
Default layout for rendering search results in a list. | |
Call a child render function passing a search state as an argument. | |
React hook which provides the search context | |
React hook which checks for an existing search context | |
Returns a function that renders a result using extensions. |
Interfaces
Interface |
Description |
---|---|
Variables
Variable |
Description |
---|---|
Recommended search autocomplete when you use the Search Provider or Search Context. | |
Recommended search bar when you use the Search Provider or Search Context. | |
All search boxes exported by the search plugin are based on the | |
Type Aliases
Type Alias |
Description |
---|---|
Props for DefaultResultListItem() | |
Props for HighlightedSearchResultText(). | |
Type for SearchAutocomplete. | |
Props for SearchAutocompleteDefaultOption(). | |
Props for SearchAutocomplete. | |
Props for SearchBarBase. | |
Props for SearchBar. | |
Props for SearchContextProvider() | |
Props for SearchPaginationBase(). | |
A page limit option, this value must not be greater than 100. | |
A page limit text, this function is called with a "{ from, to, page, count }" object. | |
Props for SearchPagination(). | |
Props for SearchResultApi() | |
Props for SearchResultContext() | |
Props for SearchResultGroupFilterFieldLayout() | |
Common props for a result group filter field. | |
Props for SearchResultGroupLayout() | |
Props for SearchResultGroup(). | |
Props for SearchResultGroupTextFilterField(). | |
Props for SearchResultGroupTextFilterField(). | |
Options for createSearchResultListItemExtension(). | |
Extends props for any search result list item extension | |
Props for SearchResultListItemExtensions() | |
Props for SearchResultListLayout() | |
Props for SearchResultList(). | |
Props for SearchResult() | |
Props for SearchResultState() |