From 9a408928a19219696fed8fd263ef9c84170602d2 Mon Sep 17 00:00:00 2001 From: Patrik Oldsberg Date: Thu, 17 Mar 2022 08:58:54 +0100 Subject: [PATCH] scaffolder: remove unused titleComponent property Signed-off-by: Patrik Oldsberg --- .changeset/good-gorillas-pump.md | 5 +++++ plugins/scaffolder/api-report.md | 3 +-- plugins/scaffolder/src/components/Router.tsx | 3 +-- .../src/components/ScaffolderPage/ScaffolderPage.tsx | 2 -- 4 files changed, 7 insertions(+), 6 deletions(-) create mode 100644 .changeset/good-gorillas-pump.md diff --git a/.changeset/good-gorillas-pump.md b/.changeset/good-gorillas-pump.md new file mode 100644 index 0000000000..b0039aa835 --- /dev/null +++ b/.changeset/good-gorillas-pump.md @@ -0,0 +1,5 @@ +--- +'@backstage/plugin-scaffolder': minor +--- + +**BREAKING**: Removed the unused `titleComponent` property of `groups` passed to the `ScaffolderPage`. The property was already ignored, but existing usage should migrated to use the `title` property instead, which now accepts any `ReactNode`. diff --git a/plugins/scaffolder/api-report.md b/plugins/scaffolder/api-report.md index a677b60c99..d73cb391fc 100644 --- a/plugins/scaffolder/api-report.md +++ b/plugins/scaffolder/api-report.md @@ -196,8 +196,7 @@ export type RouterProps = { TaskPageComponent?: ComponentType<{}>; }; groups?: Array<{ - title?: string; - titleComponent?: React_2.ReactNode; + title?: React_2.ReactNode; filter: (entity: Entity) => boolean; }>; defaultPreviewTemplate?: string; diff --git a/plugins/scaffolder/src/components/Router.tsx b/plugins/scaffolder/src/components/Router.tsx index ef4f373ef2..f46a4cc111 100644 --- a/plugins/scaffolder/src/components/Router.tsx +++ b/plugins/scaffolder/src/components/Router.tsx @@ -45,8 +45,7 @@ export type RouterProps = { TaskPageComponent?: ComponentType<{}>; }; groups?: Array<{ - title?: string; - titleComponent?: React.ReactNode; + title?: React.ReactNode; filter: (entity: Entity) => boolean; }>; defaultPreviewTemplate?: string; diff --git a/plugins/scaffolder/src/components/ScaffolderPage/ScaffolderPage.tsx b/plugins/scaffolder/src/components/ScaffolderPage/ScaffolderPage.tsx index a60a60554a..a1ceec194d 100644 --- a/plugins/scaffolder/src/components/ScaffolderPage/ScaffolderPage.tsx +++ b/plugins/scaffolder/src/components/ScaffolderPage/ScaffolderPage.tsx @@ -46,8 +46,6 @@ export type ScaffolderPageProps = { | undefined; groups?: Array<{ title?: React.ReactNode; - /** @deprcated use title instead as it accepts a string and react component */ - titleComponent?: React.ReactNode; filter: (entity: Entity) => boolean; }>; };