diff --git a/.changeset/tiny-pens-boil.md b/.changeset/tiny-pens-boil.md new file mode 100644 index 0000000000..57974c498f --- /dev/null +++ b/.changeset/tiny-pens-boil.md @@ -0,0 +1,5 @@ +--- +'@backstage/frontend-plugin-api': patch +--- + +Fixed the type for `useRouteRef`, which wasn't handling optional external route refs correctly. diff --git a/packages/frontend-plugin-api/api-report.md b/packages/frontend-plugin-api/api-report.md index d849fecf50..3e19573d95 100644 --- a/packages/frontend-plugin-api/api-report.md +++ b/packages/frontend-plugin-api/api-report.md @@ -1155,7 +1155,7 @@ export function useRouteRef< TParams extends AnyRouteRefParams, >( routeRef: ExternalRouteRef, -): TParams extends true ? RouteFunc | undefined : RouteFunc; +): TOptional extends true ? RouteFunc | undefined : RouteFunc; // @public export function useRouteRef( diff --git a/packages/frontend-plugin-api/src/routing/useRouteRef.tsx b/packages/frontend-plugin-api/src/routing/useRouteRef.tsx index 1b096a6b5d..fdf831953d 100644 --- a/packages/frontend-plugin-api/src/routing/useRouteRef.tsx +++ b/packages/frontend-plugin-api/src/routing/useRouteRef.tsx @@ -38,7 +38,7 @@ export function useRouteRef< TParams extends AnyRouteRefParams, >( routeRef: ExternalRouteRef, -): TParams extends true ? RouteFunc | undefined : RouteFunc; +): TOptional extends true ? RouteFunc | undefined : RouteFunc; /** * React hook for constructing URLs to routes.