Collapsible Navigation — Developer Guide & Admin UI
1. Installation & Peer Setup
Section titled “1. Installation & Peer Setup”pnpm add @vicacha-devs/strapi-plugin-collapsible-nav2. Server Configuration (config/plugins.ts)
Section titled “2. Server Configuration (config/plugins.ts)”Add the plugin configuration to your Strapi v5 config/plugins.ts file:
export default ({ env }: { env: (key: string, defaultValue?: string) => string }) => ({ "collapsible-nav": { enabled: true, config: { // No options: install, enable, and restart Strapi. }, },});3. Strapi v5 Admin UI Tour
Section titled “3. Strapi v5 Admin UI Tour”Once enabled, the plugin registers its workspace and settings inside the Strapi v5 Admin panel using Strapi Design System v2 components:
Key Localized Admin UI Labels
Section titled “Key Localized Admin UI Labels”| Translation Key | Rendered UI Label |
|---|---|
plugin.name |
Collapsible Nav |
toggle.expand |
Expand navigation |
toggle.collapse |
Collapse navigation |
pin.pin |
Pin sidebar open |
pin.unpin |
Unpin sidebar (auto-collapse) |
4. Content-Type Entities, Locations & Schemas (strapi.documents)
Section titled “4. Content-Type Entities, Locations & Schemas (strapi.documents)”Registers no Content-Types, routes, or server services (server/index.ts exports an empty object). The admin entry registers the plugin and calls initCollapsibleNav() once from bootstrap(): a DOM controller that finds Strapi’s main left navigation, adds a floating chevron toggle and a Pin/Unpin control, animates the width between 22.4rem (expanded) and 5.6rem (collapsed), and stores both choices in the browser’s localStorage (strapi-collapsible-nav:expanded and strapi-collapsible-nav:pinned). It only activates at Strapi’s large desktop breakpoint (>= 1080px).
Where to Find Content-Type Entities in Strapi v5
Section titled “Where to Find Content-Type Entities in Strapi v5”- Every Admin Page: the chevron toggle sits on the edge of the left navigation sidebar across
/admin/*, with the Pin/Unpin control next to it. - Browser Storage:
localStoragekeysstrapi-collapsible-nav:expandedandstrapi-collapsible-nav:pinned(per browser profile, not per Strapi user). - No Content-Types or API: this plugin creates no entities, routes, settings page, or database tables.
This plugin operates dynamically across existing Strapi api::* and plugin::* Content-Type entities without creating separate collection tables.
Strapi v5 Content Manager Integration (/admin/content-manager)
Section titled “Strapi v5 Content Manager Integration (/admin/content-manager)”Content Manager Sidebar Group:
Applies to Strapi's left navigation on every admin page, including all Content Manager screens
Content Manager Entities & Components
Section titled “Content Manager Entities & Components”- Strapi main left navigation (
NavBrand, menu links,NavUser), enhanced in place with a chevron toggle and a Pin/Unpin control - Browser
localStoragekeysstrapi-collapsible-nav:expandedandstrapi-collapsible-nav:pinned(no Content-Type, route, or database table is created)
Why This Plugin Creates & Integrates Content Manager Entities
Section titled “Why This Plugin Creates & Integrates Content Manager Entities”@vicacha-devs/strapi-plugin-collapsible-nav does not add fields or panels to Content Manager documents. It gives editors more horizontal room while they work in Content Manager lists and edit views by letting them collapse the left navigation that Strapi v5 does not collapse on desktop.
- Wider Content Manager Lists and Edit Views: collapse the sidebar to
5.6remicons to fit more columns and wider rich-text fields on screen. - Zero Configuration, Zero Server Footprint: install, enable, and restart Strapi; there are no options, routes, or install scripts.
- Per-Browser Preference: the expanded and pinned state is remembered in
localStorage, so each editor keeps their own layout.
How to Use in Strapi Content Manager (Step-by-Step)
Section titled “How to Use in Strapi Content Manager (Step-by-Step)”- Open Any Content Manager Screen: go to
/admin/content-manageron a desktop viewport (>= 1080px). - Click the Chevron Toggle: use the control on the sidebar edge to collapse or expand the navigation.
- Choose Pinned or Hover-to-Peek: use Pin/Unpin to keep the labels visible, or leave the sidebar compact and hover it to read the labels.
Content Manager & Plugin Workspace Synchronization
Section titled “Content Manager & Plugin Workspace Synchronization”Content Manager Use Cases & Editorial Workflows
Section titled “Content Manager Use Cases & Editorial Workflows”Content Manager Use Case 1 — Editing Wide Entries Without Horizontal Squeeze
Section titled “Content Manager Use Case 1 — Editing Wide Entries Without Horizontal Squeeze”- Why & What it is for: Keep wide Content Manager tables and multi-column edit views readable on laptop screens by collapsing the navigation to icons.
- How to use in Content Manager: Open a collection in
/admin/content-manager, click the chevron toggle to collapse the sidebar, and reopen it later; the collapsed state is restored automatically.
5. End-to-End Use Cases & Workflows
Section titled “5. End-to-End Use Cases & Workflows”Use Case 1 — Reclaiming Workspace Width on Dense Admin Pages
Section titled “Use Case 1 — Reclaiming Workspace Width on Dense Admin Pages”- What it is for: Give editors more room for wide Content Manager tables, the Calendar, and the Media Library by collapsing the left navigation to icons only (
5.6rem). - How it works: Click the chevron toggle on the sidebar edge; the width animates between
22.4remand5.6remwhile icons, the brand logo, and the user avatar stay anchored. The choice is saved instrapi-collapsible-nav:expandedand restored on the next visit.
Use Case 2 — Compact Sidebar with Hover-to-Peek (Unpinned Mode)
Section titled “Use Case 2 — Compact Sidebar with Hover-to-Peek (Unpinned Mode)”- What it is for: Keep the navigation compact by default but still read the full labels on demand.
- How it works: Unpin the sidebar with the Pin/Unpin control: it stays at
5.6remand expands on hover, then collapses again. Pin it to keep the labels visible. The state is saved instrapi-collapsible-nav:pinned.
Use Case 3 — Localized, Theme-Aware Labels for Multilingual Teams
Section titled “Use Case 3 — Localized, Theme-Aware Labels for Multilingual Teams”- What it is for: Show tooltips and control labels in each editor’s language and in the active light or dark theme.
- How it works: The controller reads each menu link’s localized
aria-label(plus theNavBrandandNavUserlabels) so collapsed items keep readable tooltips; toggle and pin labels come from the plugin’sen,es,ar,fr, andtrtranslations registered throughregisterTrads, and colors follow Strapi’sSTRAPI_THEMEsetting or the system preference.
6. REST API Endpoints (content-api & admin)
Section titled “6. REST API Endpoints (content-api & admin)”| Method | Endpoint Path | Scope | Controller Handler | Auth |
|---|
7. Programmatic Server Usage (strapi.plugin & strapi.documents)
Section titled “7. Programmatic Server Usage (strapi.plugin & strapi.documents)”// Registered services on plugin "collapsible-nav": "service"const pluginService = strapi.plugin("collapsible-nav")?.service("service");
// Retrieving plugin settings via Strapi plugin storeconst store = strapi.store({ type: "plugin", name: "collapsible-nav" });const settings = await store.get({ key: "settings" });8. Troubleshooting & Verification
Section titled “8. Troubleshooting & Verification”- Admin panel changes not visible: Run
pnpm strapi buildafter modifyingconfig/plugins.ts. - Peer dependency isolation: Keep
hoistPattern: ["*", "!@strapi/*"]inpnpm-workspace.yamlso@strapi/*contexts are never duplicated. - TypeScript type-checking: Validate both
admin/tsconfig.jsonandserver/tsconfig.jsonviapnpm --filter <pkg> test:ts.