From 998a8062d6c13c8e31a605adf0c4cc1fae649600 Mon Sep 17 00:00:00 2001 From: nikolar Date: Mon, 2 Dec 2024 20:58:01 -0800 Subject: [PATCH] add api report Signed-off-by: nikolar --- plugins/techdocs/report.api.md | 36 +++++++++++++++++++++++++++++++++- 1 file changed, 35 insertions(+), 1 deletion(-) diff --git a/plugins/techdocs/report.api.md b/plugins/techdocs/report.api.md index c58a946287..04fd8dda39 100644 --- a/plugins/techdocs/report.api.md +++ b/plugins/techdocs/report.api.md @@ -12,6 +12,7 @@ import { Config } from '@backstage/config'; import { CSSProperties } from '@material-ui/styles/withStyles'; import { DiscoveryApi } from '@backstage/core-plugin-api'; import { Entity } from '@backstage/catalog-model'; +import { EntityFilterQuery } from '@backstage/catalog-client'; import { EntityOwnerPickerProps } from '@backstage/plugin-catalog-react'; import { FetchApi } from '@backstage/core-plugin-api'; import { IdentityApi } from '@backstage/core-plugin-api'; @@ -194,6 +195,21 @@ export const EntityTechdocsContent: (props: { children?: ReactNode; }) => JSX_2.Element; +// @public +export const InfoCardGrid: ( + props: InfoCardGridProps, +) => React_2.JSX.Element | null; + +// @public (undocumented) +export type InfoCardGridClassKey = 'linkSpacer' | 'readMoreLink'; + +// @public +export type InfoCardGridProps = { + entities: Entity[] | undefined; + linkContent?: string | JSX.Element; + linkDest?: (entity: Entity) => string; +}; + // @public export const isTechDocsAvailable: (entity: Entity) => boolean; @@ -206,13 +222,19 @@ export interface PanelConfig { // (undocumented) panelCSS?: CSSProperties; // (undocumented) + panelProps?: Record; + // (undocumented) panelType: PanelType; // (undocumented) title: string; } // @public -export type PanelType = 'DocsCardGrid' | 'DocsTable'; +export type PanelType = + | 'DocsCardGrid' + | 'DocsTable' + | 'TechDocsIndexPage' + | 'InfoCardGrid'; // @public @deprecated export const Reader: ( @@ -293,6 +315,10 @@ export const TechDocsCustomHome: ( // @public export type TechDocsCustomHomeProps = { tabsConfig: TabsConfig; + filter?: EntityFilterQuery; + title?: string; + subtitle?: string; + hideSubtitle?: boolean; }; // @public @deprecated (undocumented) @@ -309,6 +335,11 @@ export type TechDocsIndexPageProps = { columns?: TableColumn[]; actions?: TableProps['actions']; ownerPickerMode?: EntityOwnerPickerProps['mode']; + showHeader?: boolean; + hideSupport?: boolean; + options?: TableOptions; + title?: string; + subtitle?: string; }; // @public @deprecated (undocumented) @@ -325,6 +356,9 @@ export const TechDocsPageWrapper: ( // @public export type TechDocsPageWrapperProps = { children?: React_2.ReactNode; + title?: string; + subtitle?: string; + hideSubtitle?: boolean; }; // @public