super_navigation_sidebar library

Classes

SuperNavBadge
A small trailing pill on a nav row — a count ('3'), a status ('New', 'Live') or any short token. In the collapsed rail it collapses to a dot.
SuperNavigationLocalization
Callers can lookup localized strings with an instance of SuperNavigationLocalization returned by SuperNavigationLocalization.of(context).
SuperNavigationSearchView<T>
Search UI for navigating to any leaf in a SuperNavigationSidebarController.
SuperNavigationSidebar<T>
SuperNavigationSidebarController<T>
SuperNavigationSidebarScope<T>
Exposes a SuperNavigationSidebarController to the subtree so any descendant (a page, a custom header/footer) can read/drive the sidebar and rebuild when it changes.
SuperNavigationSidebarThemeData
SuperNavNode<T>
One node in the navigation tree, generic over a strongly-typed host value (a route, a screen enum, …) so callers read node.value with no casting. Deeply immutable; children is wrapped in List.unmodifiable at construction time. Use copyWith to derive modified copies.
SuperNavOps
Static helpers shared by the controller and the view.
SuperNavSearchHit
A flattened searchable destination extracted from the navigation tree.
SuperNavSearchOps
Helpers for building and querying the navigation search index.
SuperNavSection<T>
A titled band of the sidebar (e.g. Overview, Finance). The title is the small uppercase eyebrow above the band; items are its top-level nodes.
SuperNavSidebarBreakpoints
Width thresholds that map an available width to a SuperNavSidebarMode — the Flutter analogue of the web getNavMode(w). Tune per app.
SuperNavSidebarStateSnapshot
An immutable, JSON-serializable capture of the user-owned sidebar state.

Enums

SuperNavBadgeTone
Semantic colour of a SuperNavBadge.
SuperNavigationSearchViewMode
How showSuperNavigationSearchView presents SuperNavigationSearchView.
SuperNavNodeRole
The four visual roles a node can take, derived from its position.
SuperNavNodeStatus
Informational state of a node — surfaced as a small status dot before the label. Built for ERP needs like fiscal-period or ledger state (an open period is green, a closed one grey, a locked one red). Purely presentational; it does not block navigation (use SuperNavNode.locked for permission gating).
SuperNavSectionPlacement
Where a SuperNavSection is laid out within the pane.
SuperNavSelectionIndicator
Visual treatment of the active-row selection indicator.
SuperNavSidebarMode
How the sidebar is currently presented. The view can derive this from the available width (see SuperNavSidebarBreakpoints) or a host can force it.

Functions

lookupSuperNavigationLocalization(Locale locale) → SuperNavigationLocalization
showNavigationSearchView<T>(BuildContext context, {required SuperNavigationSidebarController<T> controller, SuperNavigationSearchViewMode mode = SuperNavigationSearchViewMode.dialog, ValueChanged<SuperNavNodeId>? onPick, String hint = 'Search navigation…', String recentsLabel = 'Recent'}) → Future<void>
showSuperNavigationSearchView<T>(BuildContext context, {required SuperNavigationSidebarController<T> controller, SuperNavigationSearchViewMode mode = SuperNavigationSearchViewMode.dialog, ValueChanged<SuperNavNodeId>? onPick, String hint = 'Search navigation…', String recentsLabel = 'Recent'}) → Future<void>
Presents SuperNavigationSearchView as either a dialog or modal bottom sheet.