SideMenu class

Inheritance

Constructors

SideMenu({Key? key, required SideMenuBuilder builder, SideMenuController? controller, SideMenuMode mode = SideMenuMode.auto, SideMenuPriority priority = SideMenuPriority.mode, SideMenuPosition position = SideMenuPosition.left, double minWidth = Constants.minWidth, double maxWidth = Constants.maxWidth, bool hasResizer = true, bool hasResizerToggle = true, ResizerData? resizerData, ResizerToggleData? resizerToggleData, Color? backgroundColor})
const

Properties

backgroundColor → Color?
The backgroundColor it's used to determine the side menu background color.
final
builder → SideMenuBuilder
The builder function which will be invoked on each widget build. The builder takes the SideMenuBuilderData and must return a SideMenuData that includes headers, footers, items, or custom child .
final
controller → SideMenuController?
The controller that can be used to open, close, or toggle side menu.
final
hashCode → int
The hash code for this object.
no setterinherited
hasResizer → bool
The hasResizer enable Resizer widget for side menu. With Resizer the side menu width can be customized by the user.
final
hasResizerToggle → bool
The hasResizerToggle enable ResizerToggle widget for side menu. With ResizerToggle button you can toggle the width of the side menu between minWidth or maxWidth.
final
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
maxWidth → double
The minWidth and maxWidth values which are used to determine the side menu width.
final
minWidth → double
The minWidth and maxWidth values which are used to determine the side menu width.
final
mode → SideMenuMode
The SideMenuMode which is auto, open or compact.
final
position → SideMenuPosition
The SideMenuPosition which is left or right.
final
priority → SideMenuPriority
The SideMenuPriority which is mode or sizer.
final
resizerData → ResizerData?
The ResizerData that can set custom style for a Resizer.
final
resizerToggleData → ResizerToggleData?
The resizerToggleData that can set custom style for a ResizerToggle.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

createElement() → StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → State<SideMenu>
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
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}) → 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