@plumix/plugin-menu

This Plumix plugin adds navigation menus you build in the admin — assembled from your entries, terms, and custom URLs, then dropped into named theme locations.

Install

pnpm add @plumix/plugin-menu

Then add it to your plumix.config.ts and declare the locations your theme renders into:

import { plumix } from "plumix";

import { menu } from "@plumix/plugin-menu";

export default plumix({
  // …your runtime, database, and auth
  plugins: [
    menu({
      locations: {
        primary: { label: "Primary" },
        footer: { label: "Footer" },
      },
    }),
  ],
});

What you get

• A /menus admin page (under Appearance) — build menus by dragging in links to entries, terms, or custom URLs, and nest them into a tree.
• Theme locations — assign a menu to a location (primary, footer, …); your theme reads the resolved tree for that slot.
• Filter hooks — menu:item, menu:tree, and menu:saved let plugins reshape items, the whole tree, or react to saves.

Rendering in a theme

The /server entry resolves menus for your theme without pulling in admin code:

import { getMenuForLocation } from "@plumix/plugin-menu/server";

const primary = await getMenuForLocation(ctx, "primary");

getMenuByName and getRegisteredLocations are available there too.

Support

Have a question? Start a discussion. Found a bug? Open an issue.

Contributing

PRs and ideas welcome. The Contributing guide gets you set up — new contributors especially welcome.

License

MIT © Plumix Contributors