diff --git a/.changeset/thirty-dingos-allow.md b/.changeset/thirty-dingos-allow.md new file mode 100644 index 0000000000..f60c2b0d44 --- /dev/null +++ b/.changeset/thirty-dingos-allow.md @@ -0,0 +1,5 @@ +--- +'@backstage/core-components': patch +--- + +Added `FavoriteToggleProps`. diff --git a/packages/core-components/report.api.md b/packages/core-components/report.api.md index 90fa9ced22..fff1d0365a 100644 --- a/packages/core-components/report.api.md +++ b/packages/core-components/report.api.md @@ -399,14 +399,7 @@ export type ErrorPanelProps = { }; // @public -export function FavoriteToggle( - props: ComponentProps & { - id: string; - title: string; - isFavorite: boolean; - onToggle: (value: boolean) => void; - }, -): JSX_2.Element; +export function FavoriteToggle(props: FavoriteToggleProps): JSX_2.Element; // @public export function FavoriteToggleIcon(props: { @@ -416,6 +409,14 @@ export function FavoriteToggleIcon(props: { // @public (undocumented) export type FavoriteToggleIconClassKey = 'icon' | 'iconBorder'; +// @public +export type FavoriteToggleProps = ComponentProps & { + id: string; + title: string; + isFavorite: boolean; + onToggle: (value: boolean) => void; +}; + // @public (undocumented) export type FeatureCalloutCircleClassKey = | '@keyframes pulsateSlightly' diff --git a/packages/core-components/src/components/FavoriteToggle/FavoriteToggle.tsx b/packages/core-components/src/components/FavoriteToggle/FavoriteToggle.tsx index df6b367b57..ceb60c5491 100644 --- a/packages/core-components/src/components/FavoriteToggle/FavoriteToggle.tsx +++ b/packages/core-components/src/components/FavoriteToggle/FavoriteToggle.tsx @@ -62,6 +62,18 @@ export function FavoriteToggleIcon(props: { isFavorite: boolean }) { ); } +/** + * Props for the {@link FavoriteToggle} component. + * + * @public + */ +export type FavoriteToggleProps = ComponentProps & { + id: string; + title: string; + isFavorite: boolean; + onToggle: (value: boolean) => void; +}; + /** * Toggle encapsulating logic for marking something as favorite, * primarily used in various instances of entity lists and cards but can be used elsewhere. @@ -70,14 +82,7 @@ export function FavoriteToggleIcon(props: { isFavorite: boolean }) { * * @public */ -export function FavoriteToggle( - props: ComponentProps & { - id: string; - title: string; - isFavorite: boolean; - onToggle: (value: boolean) => void; - }, -) { +export function FavoriteToggle(props: FavoriteToggleProps) { const { id, title, diff --git a/packages/core-components/src/components/FavoriteToggle/index.ts b/packages/core-components/src/components/FavoriteToggle/index.ts index 460b162bdf..845ab22df2 100644 --- a/packages/core-components/src/components/FavoriteToggle/index.ts +++ b/packages/core-components/src/components/FavoriteToggle/index.ts @@ -15,4 +15,7 @@ */ export { FavoriteToggle, FavoriteToggleIcon } from './FavoriteToggle'; -export type { FavoriteToggleIconClassKey } from './FavoriteToggle'; +export type { + FavoriteToggleIconClassKey, + FavoriteToggleProps, +} from './FavoriteToggle'; diff --git a/packages/core-components/src/components/index.ts b/packages/core-components/src/components/index.ts index 828df3ec03..905893597e 100644 --- a/packages/core-components/src/components/index.ts +++ b/packages/core-components/src/components/index.ts @@ -48,4 +48,3 @@ export * from './TabbedLayout'; export * from './Table'; export * from './TrendLine'; export * from './WarningPanel'; -export * from './FavoriteToggle';