Admin Nav

About

This plugin replaces Payload's default admin sidebar with a navigation system that each admin user can shape themselves. Groups and items can be reordered by drag and drop, hidden, renamed, re-iconned, and nested into sub-menus through a visual customizer at /admin/nav-customizer. Layouts are persisted per user in a dedicated collection, so the sidebar a content editor sees can differ from what a developer sees, with a one-click reset to defaults. It hooks into Payload through beforeNavLinks, a custom admin view, and a set of REST endpoints under /admin-nav for preferences and live badges. With no defaultNav supplied, auto-discovery reads collections, globals, and registered admin views from the config and builds a sensible layout, grouping items by admin.group and by detected plugin packages. Nav items are filtered against the requesting user's read permissions, so collections and globals a user cannot access never appear. Configuration options cover defaultNav for an explicit layout, collectionSlug and userCollectionSlug for storage, endpointBasePath, addCustomizerView, navComponentPath for file: installs, and navFooterSlot to replace the default Customize button. Labels accept a string or a per-language record, and the plugin ships French and English translations with the ability to extend. Async badge resolvers on groups and child items return counters that the client refreshes every 60 seconds. Peer dependencies target Payload 3.x, Next 14 through 16, and React 18 or 19. A known Payload issue causes a createContext error under Next 16 with Turbopack during next build; the documented workaround is to mark the admin page force-dynamic and add the package to transpilePackages.

Package info

Package name

@consilioweb/payload-admin-nav

Latest version

0.19.1

Unpacked size

638 kB

License

MIT

Weekly downloads

304

Last publish

Sep 29, 2026