docs(search): add changeset files
Signed-off-by: Camila Belo <camilaibs@gmail.com>
This commit is contained in:
@@ -0,0 +1,5 @@
|
||||
---
|
||||
'@backstage/plugin-search': minor
|
||||
---
|
||||
|
||||
Update `SearchModal` component to use `SearchResult` extensions.
|
||||
@@ -0,0 +1,5 @@
|
||||
---
|
||||
'@backstage/create-app': minor
|
||||
---
|
||||
|
||||
Update `SearchPage` template to use `SearchResult` extensions.
|
||||
@@ -0,0 +1,5 @@
|
||||
---
|
||||
'@backstage/plugin-catalog': minor
|
||||
---
|
||||
|
||||
The `CatalogSearchResultListItem` component is now a search result extension. This means that when rendered as a child of components that render search extensions, the `result`, `rank`, and `highlight` properties are optional. See the [documentation](https://backstage.io/docs/features/search/how-to-guides#how-to-render-search-results-using-extensions) for more details.
|
||||
@@ -0,0 +1,5 @@
|
||||
---
|
||||
'@backstage/plugin-explore': minor
|
||||
---
|
||||
|
||||
The `ToolSearchResultListItem` component is now a search result extension. This means that when rendered as a child of components that render search extensions, the `result`, `rank`, and `highlight` properties are optional. See the [documentation](https://backstage.io/docs/features/search/how-to-guides#how-to-render-search-results-using-extensions) for more details.
|
||||
@@ -0,0 +1,6 @@
|
||||
---
|
||||
'@backstage/plugin-search-react': minor
|
||||
---
|
||||
|
||||
- Create the search results extensions, for more details see the documentation [here](https://backstage.io/docs/features/search/how-to-guides#how-to-render-search-results-using-extensions);
|
||||
- Update the `SearchResult`, `SearchResultList` and `SearchResultGroup` components to use extensions and default their props to optionally accept a query, when the query is not passed, the component tries to get it from the search context.
|
||||
@@ -0,0 +1,5 @@
|
||||
---
|
||||
'@backstage/plugin-techdocs': minor
|
||||
---
|
||||
|
||||
The `TechDocsSearchResultListItem` component is now a search result extension. This means that when rendered as a child of components that render search extensions, the `result`, `rank`, and `highlight` properties are optional. See the [documentation](https://backstage.io/docs/features/search/how-to-guides#how-to-render-search-results-using-extensions) for more details.
|
||||
@@ -19,7 +19,6 @@ import { default as React_2 } from 'react';
|
||||
import { ReactNode } from 'react';
|
||||
import { ResultHighlight } from '@backstage/plugin-search-common';
|
||||
import { RouteRef } from '@backstage/core-plugin-api';
|
||||
import { SearchResultListItemExtensionComponent } from '@backstage/plugin-search-react';
|
||||
import { StarredEntitiesApi } from '@backstage/plugin-catalog-react';
|
||||
import { StorageApi } from '@backstage/core-plugin-api';
|
||||
import { StyleRules } from '@material-ui/core/styles/withStyles';
|
||||
@@ -108,7 +107,9 @@ export const catalogPlugin: BackstagePlugin<
|
||||
>;
|
||||
|
||||
// @public (undocumented)
|
||||
export const CatalogSearchResultListItem: SearchResultListItemExtensionComponent<CatalogSearchResultListItemProps>;
|
||||
export const CatalogSearchResultListItem: (
|
||||
props: CatalogSearchResultListItemProps,
|
||||
) => JSX.Element | null;
|
||||
|
||||
// @public
|
||||
export interface CatalogSearchResultListItemProps {
|
||||
|
||||
@@ -19,7 +19,6 @@ import { IndexableDocument } from '@backstage/plugin-search-common';
|
||||
import { ReactNode } from 'react';
|
||||
import { ResultHighlight } from '@backstage/plugin-search-common';
|
||||
import { RouteRef } from '@backstage/core-plugin-api';
|
||||
import { SearchResultListItemExtensionComponent } from '@backstage/plugin-search-react';
|
||||
import { TabProps } from '@material-ui/core';
|
||||
|
||||
// @public @deprecated (undocumented)
|
||||
@@ -126,7 +125,9 @@ export const ToolExplorerContent: (props: {
|
||||
}) => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
export const ToolSearchResultListItem: SearchResultListItemExtensionComponent<ToolSearchResultListItemProps>;
|
||||
export const ToolSearchResultListItem: (
|
||||
props: ToolSearchResultListItemProps,
|
||||
) => JSX.Element | null;
|
||||
|
||||
// @public
|
||||
export interface ToolSearchResultListItemProps {
|
||||
|
||||
@@ -37,10 +37,10 @@ export const CheckboxFilter: (props: SearchFilterComponentProps) => JSX.Element;
|
||||
|
||||
// @public
|
||||
export const createSearchResultListItemExtension: <
|
||||
Props extends SearchResultListItemExtensionProps,
|
||||
Component extends (props: any) => JSX.Element | null,
|
||||
>(
|
||||
options: SearchResultListItemExtensionOptions<Props>,
|
||||
) => Extension<SearchResultListItemExtensionComponent<Props>>;
|
||||
options: SearchResultListItemExtensionOptions<Component>,
|
||||
) => Extension<Component>;
|
||||
|
||||
// @public (undocumented)
|
||||
export const DefaultResultListItem: (
|
||||
@@ -382,17 +382,12 @@ export type SearchResultGroupTextFilterFieldProps =
|
||||
// @public
|
||||
export const SearchResultList: (props: SearchResultListProps) => JSX.Element;
|
||||
|
||||
// @public
|
||||
export type SearchResultListItemExtensionComponent<
|
||||
Props extends SearchResultListItemExtensionProps,
|
||||
> = (props: Props) => JSX.Element | null;
|
||||
|
||||
// @public
|
||||
export type SearchResultListItemExtensionOptions<
|
||||
Props extends SearchResultListItemExtensionProps = SearchResultListItemExtensionProps,
|
||||
Component extends (props: any) => JSX.Element | null,
|
||||
> = {
|
||||
name: string;
|
||||
component: (props: Props) => JSX.Element | null;
|
||||
component: () => Promise<Component>;
|
||||
predicate?: (result: SearchResult_2) => boolean;
|
||||
};
|
||||
|
||||
|
||||
@@ -6,15 +6,10 @@
|
||||
/// <reference types="react" />
|
||||
|
||||
import { BackstagePlugin } from '@backstage/core-plugin-api';
|
||||
import { DefaultResultListItemProps } from '@backstage/plugin-search-react';
|
||||
import { IconComponent } from '@backstage/core-plugin-api';
|
||||
import { ReactNode } from 'react';
|
||||
import { RouteRef } from '@backstage/core-plugin-api';
|
||||
import { SearchBarBaseProps } from '@backstage/plugin-search-react';
|
||||
import { SearchResultListItemExtensionComponent } from '@backstage/plugin-search-react';
|
||||
|
||||
// @public (undocumented)
|
||||
export const DefaultSearchResultListItem: SearchResultListItemExtensionComponent<DefaultResultListItemProps>;
|
||||
|
||||
// @public (undocumented)
|
||||
export const HomePageSearchBar: ({
|
||||
|
||||
@@ -19,7 +19,6 @@ import { default as React_2 } from 'react';
|
||||
import { ReactNode } from 'react';
|
||||
import { ResultHighlight } from '@backstage/plugin-search-common';
|
||||
import { RouteRef } from '@backstage/core-plugin-api';
|
||||
import { SearchResultListItemExtensionComponent } from '@backstage/plugin-search-react';
|
||||
import { TableColumn } from '@backstage/core-components';
|
||||
import { TableProps } from '@backstage/core-components';
|
||||
import { TechDocsEntityMetadata as TechDocsEntityMetadata_2 } from '@backstage/plugin-techdocs-react';
|
||||
@@ -397,7 +396,9 @@ export type TechDocsSearchProps = {
|
||||
};
|
||||
|
||||
// @public
|
||||
export const TechDocsSearchResultListItem: SearchResultListItemExtensionComponent<TechDocsSearchResultListItemProps>;
|
||||
export const TechDocsSearchResultListItem: (
|
||||
props: TechDocsSearchResultListItemProps,
|
||||
) => JSX.Element | null;
|
||||
|
||||
// @public
|
||||
export type TechDocsSearchResultListItemProps = {
|
||||
|
||||
Reference in New Issue
Block a user