generate api report
Signed-off-by: Malikah Montgomery <malikah.montgomery@thoughtworks.com>
This commit is contained in:
@@ -1,17 +1,12 @@
|
||||
## API Report File for "@backstage/plugin-home"
|
||||
## API Report File for "@backstage/plugin-home-react"
|
||||
|
||||
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
|
||||
|
||||
```ts
|
||||
/// <reference types="react" />
|
||||
|
||||
import { BackstagePlugin } from '@backstage/core-plugin-api';
|
||||
import { Extension } from '@backstage/core-plugin-api';
|
||||
import { default as React_2 } from 'react';
|
||||
import { ReactElement } from 'react';
|
||||
import { ReactNode } from 'react';
|
||||
import { RJSFSchema } from '@rjsf/utils';
|
||||
import { RouteRef } from '@backstage/core-plugin-api';
|
||||
|
||||
// @public (undocumented)
|
||||
export type CardExtensionProps<T> = ComponentRenderer & {
|
||||
@@ -37,22 +32,6 @@ export type CardSettings = {
|
||||
schema?: RJSFSchema;
|
||||
};
|
||||
|
||||
// @public (undocumented)
|
||||
export type ClockConfig = {
|
||||
label: string;
|
||||
timeZone: string;
|
||||
};
|
||||
|
||||
// @public (undocumented)
|
||||
export const ComponentAccordion: (props: {
|
||||
title: string;
|
||||
expanded?: boolean | undefined;
|
||||
Content: () => JSX.Element;
|
||||
Actions?: (() => JSX.Element) | undefined;
|
||||
Settings?: (() => JSX.Element) | undefined;
|
||||
ContextProvider?: ((props: any) => JSX.Element) | undefined;
|
||||
}) => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
export type ComponentParts = {
|
||||
Content: (props?: any) => JSX.Element;
|
||||
@@ -66,22 +45,6 @@ export type ComponentRenderer = {
|
||||
Renderer?: (props: RendererProps) => JSX.Element;
|
||||
};
|
||||
|
||||
// @public (undocumented)
|
||||
export const ComponentTab: (props: {
|
||||
title: string;
|
||||
Content: () => JSX.Element;
|
||||
ContextProvider?: ((props: any) => JSX.Element) | undefined;
|
||||
}) => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
export const ComponentTabs: (props: {
|
||||
title: string;
|
||||
tabs: {
|
||||
label: string;
|
||||
Component: () => JSX.Element;
|
||||
}[];
|
||||
}) => JSX.Element;
|
||||
|
||||
// @public
|
||||
export function createCardExtension<T>(options: {
|
||||
title: string;
|
||||
@@ -92,71 +55,6 @@ export function createCardExtension<T>(options: {
|
||||
settings?: CardSettings;
|
||||
}): Extension<(props: CardExtensionProps<T>) => JSX.Element>;
|
||||
|
||||
// @public
|
||||
export const CustomHomepageGrid: (
|
||||
props: CustomHomepageGridProps,
|
||||
) => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
export type CustomHomepageGridProps = {
|
||||
children?: ReactNode;
|
||||
config?: LayoutConfiguration[];
|
||||
rowHeight?: number;
|
||||
};
|
||||
|
||||
// @public
|
||||
export const HeaderWorldClock: (props: {
|
||||
clockConfigs: ClockConfig[];
|
||||
customTimeFormat?: Intl.DateTimeFormatOptions | undefined;
|
||||
}) => JSX.Element | null;
|
||||
|
||||
// @public
|
||||
export const HomePageCompanyLogo: (props: {
|
||||
logo?: ReactNode;
|
||||
className?: string | undefined;
|
||||
}) => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
export const HomepageCompositionRoot: (props: {
|
||||
title?: string | undefined;
|
||||
children?: ReactNode;
|
||||
}) => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
export const HomePageRandomJoke: (
|
||||
props: CardExtensionProps<{
|
||||
defaultCategory?: 'any' | 'programming' | undefined;
|
||||
}>,
|
||||
) => JSX.Element;
|
||||
|
||||
// @public
|
||||
export const HomePageStarredEntities: (
|
||||
props: CardExtensionProps<unknown>,
|
||||
) => JSX.Element;
|
||||
|
||||
// @public
|
||||
export const HomePageToolkit: (
|
||||
props: CardExtensionProps<ToolkitContentProps>,
|
||||
) => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
export const homePlugin: BackstagePlugin<
|
||||
{
|
||||
root: RouteRef<undefined>;
|
||||
},
|
||||
{},
|
||||
{}
|
||||
>;
|
||||
|
||||
// @public
|
||||
export type LayoutConfiguration = {
|
||||
component: ReactElement | string;
|
||||
x: number;
|
||||
y: number;
|
||||
width: number;
|
||||
height: number;
|
||||
};
|
||||
|
||||
// @public (undocumented)
|
||||
export type RendererProps = {
|
||||
title: string;
|
||||
@@ -169,30 +67,4 @@ export const SettingsModal: (props: {
|
||||
componentName: string;
|
||||
children: JSX.Element;
|
||||
}) => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
export const TemplateBackstageLogo: (props: {
|
||||
classes: {
|
||||
svg: string;
|
||||
path: string;
|
||||
};
|
||||
}) => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
export const TemplateBackstageLogoIcon: () => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
export type Tool = {
|
||||
label: string;
|
||||
url: string;
|
||||
icon: React_2.ReactNode;
|
||||
};
|
||||
|
||||
// @public
|
||||
export type ToolkitContentProps = {
|
||||
tools: Tool[];
|
||||
};
|
||||
|
||||
// @public
|
||||
export const WelcomeTitle: () => JSX.Element;
|
||||
```
|
||||
|
||||
@@ -13,12 +13,12 @@ import { ReactNode } from 'react';
|
||||
import { RJSFSchema } from '@rjsf/utils';
|
||||
import { RouteRef } from '@backstage/core-plugin-api';
|
||||
|
||||
// @public (undocumented)
|
||||
// @public @deprecated (undocumented)
|
||||
export type CardExtensionProps<T> = ComponentRenderer & {
|
||||
title?: string;
|
||||
} & T;
|
||||
|
||||
// @public (undocumented)
|
||||
// @public @deprecated (undocumented)
|
||||
export type CardLayout = {
|
||||
width?: {
|
||||
minColumns?: number;
|
||||
@@ -53,7 +53,7 @@ export const ComponentAccordion: (props: {
|
||||
ContextProvider?: ((props: any) => JSX.Element) | undefined;
|
||||
}) => JSX.Element;
|
||||
|
||||
// @public (undocumented)
|
||||
// @public @deprecated (undocumented)
|
||||
export type ComponentParts = {
|
||||
Content: (props?: any) => JSX.Element;
|
||||
Actions?: () => JSX.Element;
|
||||
@@ -61,7 +61,7 @@ export type ComponentParts = {
|
||||
ContextProvider?: (props: any) => JSX.Element;
|
||||
};
|
||||
|
||||
// @public (undocumented)
|
||||
// @public @deprecated (undocumented)
|
||||
export type ComponentRenderer = {
|
||||
Renderer?: (props: RendererProps) => JSX.Element;
|
||||
};
|
||||
@@ -82,7 +82,7 @@ export const ComponentTabs: (props: {
|
||||
}[];
|
||||
}) => JSX.Element;
|
||||
|
||||
// @public
|
||||
// @public @deprecated
|
||||
export function createCardExtension<T>(options: {
|
||||
title: string;
|
||||
components: () => Promise<ComponentParts>;
|
||||
@@ -157,7 +157,7 @@ export type LayoutConfiguration = {
|
||||
height: number;
|
||||
};
|
||||
|
||||
// @public (undocumented)
|
||||
// @public @deprecated (undocumented)
|
||||
export type RendererProps = {
|
||||
title: string;
|
||||
} & ComponentParts;
|
||||
|
||||
@@ -7,7 +7,7 @@
|
||||
|
||||
import { ApiRef } from '@backstage/core-plugin-api';
|
||||
import { BackstagePlugin } from '@backstage/core-plugin-api';
|
||||
import { CardExtensionProps } from '@backstage/plugin-home';
|
||||
import { CardExtensionProps } from '@backstage/plugin-home-react';
|
||||
import { default as React_2 } from 'react';
|
||||
import { ResultHighlight } from '@backstage/plugin-search-common';
|
||||
import { SearchResultListItemExtensionProps } from '@backstage/plugin-search-react';
|
||||
|
||||
Reference in New Issue
Block a user