SSlideMenu class
This file contains the classes that implement menus. The menus include SSlideMenu and SResizableMenu.
Abstract classes from which the menus are derived and custom classes that the menus use can be found in the base.dart file: SBaseMenu w/ SBaseMenuState SMenuState SMenuStyle SMenuController
Private classes include
_SSlideMenuState (for SSlideMenu)
_SResizableMenuState (for SResizableMenu)
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatefulWidget
- SBase
- SBaseMenu
- SSlideMenu
Constructors
-
SSlideMenu({Key? key, SMenuStyle style = const SMenuStyle(), SMenuController? controller, required List<
SMenuItem> items, Widget builder(BuildContext context, List<SMenuItem> items)?, Widget? header, ScrollPhysics? scrollPhysics, Axis scrollDirection = Axis.vertical, Duration duration = const Duration(milliseconds: 250), SMenuPosition position = SMenuPosition.left, double closedSize = 50.0, double openSize = 250.0, Offset offset = Offset.zero, bool isBodyMovable = true, bool isMenuMovable = true, Widget? body, bool? enableGestures}) -
const
Properties
- body → Widget?
-
final
-
builder
→ Widget Function(BuildContext context, List<
SMenuItem> items)? -
The builder that makes the menu. Completely overwrites the menu for complete
customization. This means many menu parameters will not work.
finalinherited
- closedSize → double
-
The size of the menu when it is closed
finalinherited
- controller → SMenuController?
-
The optional controller for this menu
finalinherited
- curve → Curve
-
The animation curve
finalinherited
- duration → Duration
-
The animation duration
finalinherited
- enableGestures → bool?
-
final
-
The widget at the bottom of the menu
finalinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
- header → Widget?
-
The widget at the top of the menu
finalinherited
- isBodyMovable → bool
-
final
- isMenuMovable → bool
-
final
-
items
→ List<
SMenuItem> -
Items that make up the menu
finalinherited
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- offset → Offset
-
final
- openSize → double
-
The size of the menu when it is opened
finalinherited
- performanceMode → bool
-
If true, performance mode is enabled. This means a ListView with lazy loading will
be used in the menu rather than a SingleChildScrollView and Flex which
load all items at once. Doesn't work if using a builder.
finalinherited
- position → SMenuPosition
-
The position (AKA location) of the menu
finalinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- scrollDirection → Axis
-
The direction that the menu scrolls
finalinherited
- scrollPhysics → ScrollPhysics?
-
The menu's scroll physics, or how the menu scrolls
finalinherited
- style → SMenuStyle
-
The style of the menu
finalinherited
Methods
-
createElement(
) → StatefulElement -
Creates a StatefulElement to manage this widget's location in the tree.
inherited
-
createState(
) → State< SSlideMenu> -
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