From 0639f2840abaa7f1fce0d2c5d9bdb115aa9e3c39 Mon Sep 17 00:00:00 2001 From: Camila Belo Date: Mon, 25 Sep 2023 23:37:51 +0200 Subject: [PATCH] chore(search-react): update api reports Signed-off-by: Camila Belo --- plugins/search-react/alpha-api-report.md | 56 ++++++++++++++++++++++++ plugins/search-react/api-report.md | 5 +++ 2 files changed, 61 insertions(+) create mode 100644 plugins/search-react/alpha-api-report.md diff --git a/plugins/search-react/alpha-api-report.md b/plugins/search-react/alpha-api-report.md new file mode 100644 index 0000000000..90492f9434 --- /dev/null +++ b/plugins/search-react/alpha-api-report.md @@ -0,0 +1,56 @@ +## API Report File for "@backstage/plugin-search-react" + +> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). + +```ts +/// + +import { ConfigurableExtensionDataRef } from '@backstage/frontend-plugin-api'; +import { Extension } from '@backstage/frontend-plugin-api'; +import { ListItemProps } from '@material-ui/core'; +import { SearchDocument } from '@backstage/plugin-search-common'; +import { SearchResult } from '@backstage/plugin-search-common'; + +// @alpha (undocumented) +export type BaseSearchResultListItemProps = { + rank?: number; + result?: SearchDocument; + noTrack?: boolean; +} & Omit; + +// @alpha (undocumented) +export const createSearchResultListItemExtension: ( + options: SearchResultItemExtensionOptions, +) => Extension; + +// @alpha (undocumented) +export type SearchResultItemExtensionComponent = < + P extends BaseSearchResultListItemProps, +>( + props: P, +) => JSX.Element | null; + +// @alpha (undocumented) +export const searchResultItemExtensionData: ConfigurableExtensionDataRef< + { + predicate?: SearchResultItemExtensionPredicate | undefined; + component: SearchResultItemExtensionComponent; + }, + {} +>; + +// @alpha (undocumented) +export type SearchResultItemExtensionOptions = { + id: string; + at: string; + component: () => Promise; + predicate?: SearchResultItemExtensionPredicate; +}; + +// @alpha (undocumented) +export type SearchResultItemExtensionPredicate = ( + result: SearchResult, +) => boolean; + +// (No @packageDocumentation comment for this package) +``` diff --git a/plugins/search-react/api-report.md b/plugins/search-react/api-report.md index 97c8300c14..21dd6135a9 100644 --- a/plugins/search-react/api-report.md +++ b/plugins/search-react/api-report.md @@ -391,6 +391,11 @@ export const SearchResultList: ( props: SearchResultListProps, ) => React_2.JSX.Element; +// @public +export const SearchResultListItemExtension: ( + props: SearchResultListItemExtensionProps, +) => React_2.JSX.Element; + // @public export type SearchResultListItemExtensionOptions< Component extends (props: any) => JSX.Element | null,