Skip to main content

Navigation Configuration Guide

Overview

This guide covers how to configure different navigation layouts, sidebar modes, and top navigation options in the application.

Basic Sidebar States

The sidebar supports multiple states that can be configured through the sidebar utilities:

1. Rail Mode (Collapsed Sidebar)

Rail mode shows a collapsed sidebar with only icons visible. Configuration in Component:
Configuration in Backend:

2. Full Sidebar Mode

Full sidebar shows expanded menu with text labels and icons.

3. Persistent vs. Overlay Sidebar

Desktop (Persistent):
  • Sidebar remains visible alongside content
  • Content area adjusts width accordingly
  • Smooth transitions between rail and full modes
Mobile/Tablet (Overlay):
  • Sidebar appears as overlay over content
  • Backdrop dims the main content
  • Automatically collapses on navigation

Top Navigation Configuration

1. Enable/Disable Top Navigation

Method 1: Controller Level
Method 2: Layout Configuration

2. Top Navigation Menu Levels

Level 0: Main Groups
Shows: Document Management, Directory, Setup, etc. Level 1: Children of Active Group (Default)
Shows: Dashboard, Customer, Member, Distributor, Vendor (when in Directory)

3. Conditional Top Navigation

Show different top menu based on section:

Layout Variants

1. Sidebar Layout (Default)

2. Full-width Layout (No Sidebar)

3. Minimal Layout (No Navigation)

1. YAML Menu Files

Main Configuration (config/core/app.php):
Environment Variables (.env):

2. Multiple Menu Sources

Load Different Menu Sets:

3. Dynamic Menu Configuration

Role-Based Menu Loading:

Responsive Behavior Configuration

1. Breakpoint Configuration

2. Mobile-Specific Configuration

Advanced Configuration Examples

1. Context-Aware Navigation

2. User Preference Storage

3. Route-Based Configuration

Configuration Summary

Best Practices

  1. Use consistent naming for navigation states across components
  2. Store user preferences in localStorage or database
  3. Configure navigation contextually based on user roles and current section
  4. Test responsive behavior across different screen sizes
  5. Provide smooth transitions between navigation states
  6. Consider accessibility when hiding/showing navigation elements
  7. Document custom configurations for team members