@frigear-nu/menu 0.0.6 → 0.0.8

package/dist/module.d.mts

@@ -16,7 +16,15 @@ type MenuItem = {
      * entries, so content-sourced and module-sourced items share the exact same shape.
      */
     label: string;
+    /**
+     * Optional i18n key (e.g. `users.menu.logout.label`). When `@nuxtjs/i18n` is installed and the
+     * key exists for the active locale, `useMenu` returns its translation as `label`; otherwise the
+     * plain `label` above is the fallback. Ids are always derived from the untranslated `label`.
+     */
+    labelKey?: string;
     description?: string;
+    /** Optional i18n key for `description`, resolved the same way as `labelKey`. */
+    descriptionKey?: string;
     icon?: string;
     to?: string;
     external?: boolean;

package/dist/module.json

@@ -1,7 +1,7 @@
 {
   "name": "@frigear-nu/menu",
   "configKey": "menus",
-  "version": "0.0.6",
+  "version": "0.0.8",
   "builder": {
     "@nuxt/module-builder": "1.0.3",
     "unbuild": "unknown"

package/dist/runtime/app/composables/useMenu.js

@@ -1,6 +1,6 @@
 import { computed, unref } from "vue";
 import { useAsyncData, useNuxtApp, useRuntimeConfig } from "#imports";
-import { collectMenuItems, matchesMenuGroup, parseMenuPath, sortByOrder } from "../../utils/menu.js";
+import { collectMenuItems, matchesMenuGroup, parseMenuPath, sortByOrder, translateMenuItem } from "../../utils/menu.js";
 import { menus } from "../utils/state.js";
 function useMenuLocale() {
   const nuxtApp = useNuxtApp();
@@ -29,7 +29,8 @@ export const useMenu = (path) => {
   return useAsyncData(
     () => `menu:${path}:${locale.value ?? ""}`,
     async () => {
-      const registered = collectMenuItems(menus[menu], parsed);
+      const i18n = nuxtApp.$i18n?.t && nuxtApp.$i18n.te ? nuxtApp.$i18n : void 0;
+      const registered = collectMenuItems(menus[menu], parsed).map((item) => translateMenuItem(item, i18n));
       const content = await loadContentItems(menu, parsed, unref(locale));
       const result = sortByOrder([...content, ...registered]);
       await nuxtApp.callHook("menus:visible", menu);

package/dist/runtime/utils/menu.d.ts

@@ -37,6 +37,17 @@ export declare function collectMenuItems(groups: Record<string, MenuItem[]> | un
 export declare function sortByOrder(items: MenuItem[]): MenuItem[];
 /** Deterministic id for an item missing one: its `to` if present, else a slug of its `label`. */
 export declare function deriveMenuItemId(item: MenuItem): string;
+/** The slice of `@nuxtjs/i18n`'s `$i18n` that `translateMenuItem` needs. */
+export type MenuTranslator = {
+    t: (key: string) => string;
+    te: (key: string) => boolean;
+};
+/**
+ * Resolves an item's `labelKey`/`descriptionKey` against the active locale, falling back to the
+ * plain `label`/`description` when no translator is available or the key has no message. The
+ * `id` is derived first, so it stays identical across locales.
+ */
+export declare function translateMenuItem(item: MenuItem, i18n?: MenuTranslator): MenuItem;
 /**
  * Build-time API for other modules to contribute static items to a menu, without the host app
  * wiring anything. Call it once during a module's own `setup()`:

package/dist/runtime/utils/menu.js

@@ -46,6 +46,14 @@ function slugify(value) {
 export function deriveMenuItemId(item) {
   return item.id ?? item.to ?? slugify(item.label);
 }
+export function translateMenuItem(item, i18n) {
+  if (!i18n || !item.labelKey && !item.descriptionKey) return item;
+  const id = deriveMenuItemId(item);
+  const translated = { ...item, id };
+  if (item.labelKey && i18n.te(item.labelKey)) translated.label = i18n.t(item.labelKey);
+  if (item.descriptionKey && i18n.te(item.descriptionKey)) translated.description = i18n.t(item.descriptionKey);
+  return translated;
+}
 function normalizeItems(group, items) {
   const list = Array.isArray(items) ? items : [items];
   const seen = /* @__PURE__ */ new Set();

package/package.json

@@ -1,7 +1,8 @@
 {
   "name": "@frigear-nu/menu",
-  "version": "0.0.6",
+  "version": "0.0.8",
   "description": "Named, shareable navigation menus - modules contribute items (extendMenu / a runtime/menus.ts source) and/or Nuxt Content, consumers read them via useMenu and render them however they like.",
+  "homepage": "https://docs.frigear.dev/modules/menu",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/frigear-nu/frigear-nu.git",
@@ -30,7 +31,7 @@
   ],
   "dependencies": {
     "@nuxt/kit": "^4.6.0",
-    "@frigear-nu/module-kit": "0.1.4",
+    "@frigear-nu/module-kit": "0.1.6",
     "zod": "^4.6.5"
   },
   "devDependencies": {
@@ -42,7 +43,7 @@
     "@types/node": "latest",
     "changelogen": "^0.6.2",
     "eslint": "^10.10.0",
-    "nuxt": "^4.6.0",
+    "nuxt": "^4.6.1",
     "typescript": "^6.0.3",
     "vitest": "^5.0.1",
     "vue-tsc": "^3.3.11"