Sidebar class

A persistent desktop sidebar with sections, selection and collapse.

Use on wide screens where a NavigationRail would be too compact and a NavDrawer would be too transient.

Sidebar(
  selectedIndex: _index,
  onSelected: (int i) => setState(() => _index = i),
  header: const Text('Nash'),
  sections: <SidebarSection>[
    SidebarSection(
      title: 'General',
      items: <SidebarItem>[
        SidebarItem(label: 'Home', icon: Icons.home_outlined),
        SidebarItem(label: 'Inbox', icon: Icons.mail_outline, badge: '3'),
      ],
    ),
  ],
)
Inheritance
Available extensions

Constructors

Sidebar({Key? key, required int selectedIndex, required ValueChanged<int> onSelected, required List<SidebarSection> sections, Widget? header, Widget? footer, double width = 280, double collapsedWidth = 72, bool collapsible = true, bool showHeader = true, Color? background, Color? borderColor})
const

Properties

background → Color?
Background color.
final
borderColor → Color?
Border color (defaults to the theme outline variant).
final
centered → Widget

Available on Widget, provided by the WidgetX extension

Wraps the widget in a Center.
no setter
collapsedWidth → double
Width when collapsed.
final
collapsible → bool
When true a collapse toggle is shown.
final
Footer widget.
final
hashCode → int
The hash code for this object.
no setterinherited
Header widget (logo / branding).
final
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
onSelected → ValueChanged<int>
Called with the sequential index of the tapped item.
final
repaint → Widget

Available on Widget, provided by the WidgetX extension

Wraps in RepaintBoundary to isolate repaints.
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
sections → List<SidebarSection>
Sidebar sections.
final
selectedIndex → int
Index of the selected item across all sections (sequential).
final
showHeader → bool
Whether to render the header.
final
width → double
Width when expanded.
final

Methods

animatedSwitcher({Duration duration = const Duration(milliseconds: 300), AnimatedSwitcherTransitionBuilder transitionBuilder = _defaultAnimatedSwitcherTransition, AnimatedSwitcherLayoutBuilder layoutBuilder = AnimatedSwitcher.defaultLayoutBuilder}) → Widget

Available on Widget, provided by the WidgetX extension

Wraps in an AnimatedSwitcher with duration and default fade.
createElement() → StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → State<Sidebar>
Creates the mutable state for this widget at a given location in the tree.
override
debugDescribeChildren() → List<DiagnosticsNode>
Returns a list of DiagnosticsNode objects describing this node's children.
inherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → void
Add additional properties associated with the node.
inherited
expanded({int flex = 1}) → Widget

Available on Widget, provided by the WidgetX extension

Expands the widget inside a Flex parent.
fadeIn({double opacity = 1, Duration duration = const Duration(milliseconds: 300), Curve curve = Curves.easeIn}) → Widget

Available on Widget, provided by the WidgetAnimateX extension

Wraps in an AnimatedOpacity.
flexible({int flex = 1, FlexFit fit = FlexFit.loose}) → Widget

Available on Widget, provided by the WidgetX extension

Applies flexible sizing.
keyed(Object key) → Widget

Available on Widget, provided by the WidgetX extension

Wraps the widget in a KeyedSubtree with key.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
onTap(VoidCallback onTap, {HitTestBehavior behavior = HitTestBehavior.opaque}) → Widget

Available on Widget, provided by the WidgetX extension

Wraps the widget in GestureDetector with onTap.
pad({double horizontal = 0, double vertical = 0}) → Widget

Available on Widget, provided by the WidgetX extension

Applies symmetric padding.
padded([double padding = AppSpacing.lg]) → Widget

Available on Widget, provided by the WidgetX extension

Applies uniform padding.
scaleOnTap({double scale = 0.95, required VoidCallback onTap, Duration duration = const Duration(milliseconds: 150)}) → Widget

Available on Widget, provided by the WidgetAnimateX extension

Wraps in an AnimatedScale.
semantics({required String label, bool button = false}) → Widget

Available on Widget, provided by the WidgetX extension

Wraps in a Semantics node with label.
toDiagnosticsNode({String? name, DiagnosticsTreeStyle? style}) → DiagnosticsNode
Returns a debug representation of the object that is used by debugging tools and by DiagnosticsNode.toStringDeep.
inherited
toString({DiagnosticLevel minLevel = DiagnosticLevel.info}) → String
A string representation of this object.
inherited
toStringDeep({String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug, int wrapWidth = 65}) → String
Returns a string representation of this node and its descendants.
inherited
toStringShallow({String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String
Returns a one-line detailed description of the object.
inherited
toStringShort() → String
A short, textual description of this widget.
inherited
visible({bool condition = true}) → Widget

Available on Widget, provided by the WidgetX extension

Hides the widget entirely when condition is false.
withPadding(EdgeInsetsGeometry padding) → Widget

Available on Widget, provided by the WidgetX extension

Applies padding only.

Operators

operator ==(Object other) → bool
The equality operator.
inherited