flutter_nav_toggle library
A dual-mode navigation toggle widget that morphs between sidebar and tab bar layouts.
Classes
- IconRailPanel
- A narrow vertical icon rail — shows only nav item icons.
- ModeToggleButton
- A general-purpose split/collapse toggle button.
- Header configuration displayed at the top of navigation panels.
- A single navigation item with an id, label, and icon.
- Manages navigation mode, selected item, and animation state.
- Top-level scaffold that manages the toggle button, sidebar/tab bar/icon rail panels, content area, and all transition animations.
- Design tokens and theme configuration for NavToggle.
- InheritedWidget that propagates NavToggleTheme down the tree.
- Holds the phased CurvedAnimations derived from a single controller.
- SidebarClipper
- Custom clipper that clips a sidebar panel. Progress 0.0 = fully clipped (hidden), 1.0 = fully visible. Clips vertically — reveals downward as progress increases.
- SidebarPanel
- The sidebar navigation panel — 200px wide, fills height below the button.
- SystemStatus
- System status data for the sidebar status panel.
- TabBarClipper
- Custom clipper that clips a tab bar panel. Progress 0.0 = fully clipped (hidden), 1.0 = fully visible. Clips horizontally — reveals rightward as progress increases.
- TabBarPanel
- The horizontal tab bar panel — extends from button's right edge to screen right.
- UserInfo
- User information displayed in the navigation panels.
- UserInfoPanel
- Displays user avatar, name, and optional role at the sidebar bottom.
- UserMenuItem
- A single item in the user flyout menu.
Enums
- ModeToggleState
- The visual state of a ModeToggleButton.
- Animation state machine states.
- Navigation display modes.
- PageTransitionType
- The type of transition used when switching between pages.
Functions
-
pageTransitionBuilder(
PageTransitionType type) → AnimatedSwitcherTransitionBuilder - Returns an AnimatedSwitcher transition builder for the given type.