CustomSideBar class

A customizable sidebar widget that supports navigation items and nested routes. Handles route matching, item expansion, and selection states.

Inheritance

Constructors

CustomSideBar({Key? key, required List items, String? currentRoute, SidebarConfig? sidebarConfig, ItemConfig? itemConfig, bool onRoute = false, dynamic onRouteSelected(String)?})
const

Properties

currentRoute → String?
Current active route.
final
hashCode → int
The hash code for this object.
no setterinherited
itemConfig → ItemConfig?
Configuration for the sidebarItem appearance
final
items → List
List of items to display in the sidebar. Can contain both NavigationItem and Widget.
final
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
onRoute → bool
final
onRouteSelected → dynamic Function(String)?
Callback function when a route is selected.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
sidebarConfig → SidebarConfig?
Configuration for the sidebar appearance
final

Methods

build(BuildContext context) → Widget
Describes the part of the user interface represented by this widget.
override
createElement() → StatelessElement
Creates a StatelessElement to manage this widget's location in the tree.
inherited
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
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
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

Operators

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