From da10bec2665d068b48144f0b3023f49a17d99ec0 Mon Sep 17 00:00:00 2001 From: Kalle Ericson <7943407+kalleericson@users.noreply.github.com> Date: Mon, 18 Nov 2024 14:20:46 +0100 Subject: [PATCH] Updating API docs Signed-off-by: Kalle Ericson <7943407+kalleericson@users.noreply.github.com> --- plugins/scaffolder-react/report-alpha.api.md | 95 ++++++++++++++++++- .../components/TemplateCard/CardHeader.tsx | 2 + .../next/components/TemplateCard/CardLink.tsx | 8 ++ .../components/TemplateCard/TemplateCard.tsx | 1 + .../TemplateCard/TemplateCardActions.tsx | 4 + .../TemplateCard/TemplateCardContent.tsx | 4 + .../TemplateCard/TemplateCardLinks.tsx | 4 + .../TemplateCard/TemplateCardTags.tsx | 4 + 8 files changed, 117 insertions(+), 5 deletions(-) diff --git a/plugins/scaffolder-react/report-alpha.api.md b/plugins/scaffolder-react/report-alpha.api.md index 7084625ad4..1d2c4138d0 100644 --- a/plugins/scaffolder-react/report-alpha.api.md +++ b/plugins/scaffolder-react/report-alpha.api.md @@ -54,6 +54,32 @@ export type BackstageTemplateStepperClassKey = | 'footer' | 'formWrapper'; +// @alpha +export const CardHeader: (props: CardHeaderProps) => React_2.JSX.Element; + +// @alpha +export interface CardHeaderProps { + // (undocumented) + template: TemplateEntityV1beta3; +} + +// @alpha +export const CardLink: ({ + icon: Icon, + text, + url, +}: CardLinkProps) => React_2.JSX.Element; + +// @alpha +export interface CardLinkProps { + // (undocumented) + icon: IconComponent; + // (undocumented) + text: string; + // (undocumented) + url: string; +} + // @alpha (undocumented) export const createAsyncValidators: ( rootSchema: JsonObject, @@ -266,20 +292,79 @@ export interface TaskStepsProps { // @alpha export const TemplateCard: (props: TemplateCardProps) => React_2.JSX.Element; +// @alpha +export const TemplateCardActions: ({ + canCreateTask, + handleChoose, + ownedByRelations, +}: TemplateCardActionsProps) => React_2.JSX.Element; + +// @alpha +export interface TemplateCardActionsProps { + // (undocumented) + canCreateTask: boolean; + // (undocumented) + handleChoose: () => void; + // (undocumented) + ownedByRelations: any; +} + +// @alpha (undocumented) +export interface TemplateCardAdditionalLink { + // (undocumented) + icon: IconComponent; + // (undocumented) + text: string; + // (undocumented) + url: string; +} + +// @alpha +export const TemplateCardContent: ({ + template, +}: TemplateCardContentProps) => React_2.JSX.Element; + +// @alpha +export interface TemplateCardContentProps { + // (undocumented) + template: TemplateEntityV1beta3; +} + +// @alpha +export const TemplateCardLinks: ({ + template, + additionalLinks, +}: TemplateCardLinksProps) => React_2.JSX.Element; + +// @alpha +export interface TemplateCardLinksProps { + // (undocumented) + additionalLinks?: TemplateCardAdditionalLink[]; + // (undocumented) + template: TemplateEntityV1beta3; +} + // @alpha export interface TemplateCardProps { // (undocumented) - additionalLinks?: { - icon: IconComponent; - text: string; - url: string; - }[]; + additionalLinks?: TemplateCardAdditionalLink[]; // (undocumented) onSelected?: (template: TemplateEntityV1beta3) => void; // (undocumented) template: TemplateEntityV1beta3; } +// @alpha +export const TemplateCardTags: ({ + template, +}: TemplateCardTagsProps) => React_2.JSX.Element; + +// @alpha +export interface TemplateCardTagsProps { + // (undocumented) + template: TemplateEntityV1beta3; +} + // @alpha export const TemplateCategoryPicker: () => React_2.JSX.Element | null; diff --git a/plugins/scaffolder-react/src/next/components/TemplateCard/CardHeader.tsx b/plugins/scaffolder-react/src/next/components/TemplateCard/CardHeader.tsx index 467d26ce76..5c7bb7f627 100644 --- a/plugins/scaffolder-react/src/next/components/TemplateCard/CardHeader.tsx +++ b/plugins/scaffolder-react/src/next/components/TemplateCard/CardHeader.tsx @@ -39,6 +39,7 @@ const useStyles = makeStyles< /** * Props for the CardHeader component + * @alpha */ export interface CardHeaderProps { template: TemplateEntityV1beta3; @@ -46,6 +47,7 @@ export interface CardHeaderProps { /** * The Card Header with the background for the TemplateCard. + * @alpha */ export const CardHeader = (props: CardHeaderProps) => { const { diff --git a/plugins/scaffolder-react/src/next/components/TemplateCard/CardLink.tsx b/plugins/scaffolder-react/src/next/components/TemplateCard/CardLink.tsx index 4aa63e4555..832c36ef1e 100644 --- a/plugins/scaffolder-react/src/next/components/TemplateCard/CardLink.tsx +++ b/plugins/scaffolder-react/src/next/components/TemplateCard/CardLink.tsx @@ -19,6 +19,10 @@ import { Link } from '@backstage/core-components'; import { makeStyles } from '@material-ui/core/styles'; import React from 'react'; +/** + * Props for the Card Links component + * @alpha + */ export interface CardLinkProps { icon: IconComponent; text: string; @@ -32,6 +36,10 @@ const useStyles = makeStyles(() => ({ }, })); +/** + * The Card Links used for the TemplateCard. + * @alpha + */ export const CardLink = ({ icon: Icon, text, url }: CardLinkProps) => { const styles = useStyles(); diff --git a/plugins/scaffolder-react/src/next/components/TemplateCard/TemplateCard.tsx b/plugins/scaffolder-react/src/next/components/TemplateCard/TemplateCard.tsx index 73b8e71de9..dab69e092d 100644 --- a/plugins/scaffolder-react/src/next/components/TemplateCard/TemplateCard.tsx +++ b/plugins/scaffolder-react/src/next/components/TemplateCard/TemplateCard.tsx @@ -37,6 +37,7 @@ const useStyles = makeStyles(() => ({ actionContainer: { padding: '16px', flex: 1, alignItems: 'flex-end' }, })); +/** @alpha */ export interface TemplateCardAdditionalLink { icon: IconComponent; text: string; diff --git a/plugins/scaffolder-react/src/next/components/TemplateCard/TemplateCardActions.tsx b/plugins/scaffolder-react/src/next/components/TemplateCard/TemplateCardActions.tsx index e8a84487df..182075f78c 100644 --- a/plugins/scaffolder-react/src/next/components/TemplateCard/TemplateCardActions.tsx +++ b/plugins/scaffolder-react/src/next/components/TemplateCard/TemplateCardActions.tsx @@ -45,6 +45,10 @@ export interface TemplateCardActionsProps { canCreateTask: boolean; handleChoose: () => void; } +/** + * The `TemplateCardActions` component that is rendered at the Actions-section of the TemplateCard + * @alpha + */ export const TemplateCardActions = ({ canCreateTask, handleChoose, diff --git a/plugins/scaffolder-react/src/next/components/TemplateCard/TemplateCardContent.tsx b/plugins/scaffolder-react/src/next/components/TemplateCard/TemplateCardContent.tsx index fad5c85474..a335d73616 100644 --- a/plugins/scaffolder-react/src/next/components/TemplateCard/TemplateCardContent.tsx +++ b/plugins/scaffolder-react/src/next/components/TemplateCard/TemplateCardContent.tsx @@ -44,6 +44,10 @@ const useStyles = makeStyles(() => ({ export interface TemplateCardContentProps { template: TemplateEntityV1beta3; } +/** + * The `TemplateCardContent` component that is rendered at the Content-section of the TemplateCard + * @alpha + */ export const TemplateCardContent = ({ template }: TemplateCardContentProps) => { const styles = useStyles(); return ( diff --git a/plugins/scaffolder-react/src/next/components/TemplateCard/TemplateCardLinks.tsx b/plugins/scaffolder-react/src/next/components/TemplateCard/TemplateCardLinks.tsx index 845c4c1621..2fa244a2b7 100644 --- a/plugins/scaffolder-react/src/next/components/TemplateCard/TemplateCardLinks.tsx +++ b/plugins/scaffolder-react/src/next/components/TemplateCard/TemplateCardLinks.tsx @@ -34,6 +34,10 @@ export interface TemplateCardLinksProps { template: TemplateEntityV1beta3; additionalLinks?: TemplateCardAdditionalLink[]; } +/** + * The `TemplateCardLinks` component that is rendered at the Links-section of the TemplateCard + * @alpha + */ export const TemplateCardLinks = ({ template, additionalLinks, diff --git a/plugins/scaffolder-react/src/next/components/TemplateCard/TemplateCardTags.tsx b/plugins/scaffolder-react/src/next/components/TemplateCard/TemplateCardTags.tsx index 88550e2104..c4cb22410a 100644 --- a/plugins/scaffolder-react/src/next/components/TemplateCard/TemplateCardTags.tsx +++ b/plugins/scaffolder-react/src/next/components/TemplateCard/TemplateCardTags.tsx @@ -27,6 +27,10 @@ import React from 'react'; export interface TemplateCardTagsProps { template: TemplateEntityV1beta3; } +/** + * The `TemplateCardTags` component that is rendered at the Tags-section of the TemplateCard + * @alpha + */ export const TemplateCardTags = ({ template }: TemplateCardTagsProps) => ( <>