Merge pull request #33142 from backstage/rugvip/deprecate-nav-item-blueprint

Deprecate NavItemBlueprint in @backstage/frontend-plugin-api

.changeset/deprecate-nav-item-blueprint.md

@@ -0,0 +1,5 @@
+---
+'@backstage/frontend-plugin-api': patch
+---
+
+Deprecated `NavItemBlueprint`. Nav items are now automatically inferred from `PageBlueprint` extensions based on their `title` and `icon` params.

packages/frontend-plugin-api/report.api.md

@@ -1470,7 +1470,7 @@ export const microsoftAuthApiRef: ApiRef<
     SessionApi
 >;
 
-// @public
+// @public @deprecated
 export const NavItemBlueprint: ExtensionBlueprint_2<{
   kind: 'nav-item';
   params: {

packages/frontend-plugin-api/src/blueprints/NavItemBlueprint.ts

@@ -29,6 +29,10 @@ const targetDataRef = createExtensionDataRef<{
  * Creates extensions that make up the items of the nav bar.
  *
  * @public
+ * @deprecated Nav items are now automatically inferred from `PageBlueprint`
+ * extensions based on their `title` and `icon` params. You can remove your
+ * `NavItemBlueprint` usage and instead pass `title` and `icon` directly to
+ * the `PageBlueprint`.
  */
 export const NavItemBlueprint = createExtensionBlueprint({
   kind: 'nav-item',