DrawerScaffold class - drawerbehavior library

Constructors

DrawerScaffold({PreferredSizeWidget? appBar, Widget? body, List<BoxShadow> contentShadow = const [BoxShadow(color: const Color(0x44000000), offset: const Offset(0.0, 5.0), blurRadius: 20.0, spreadRadius: 10.0)], List<SideDrawer>? drawers, double? cornerRadius = 16.0, DrawerScaffoldController? controller, bool extendedBody = false, Widget? bottomNavigationBar, FloatingActionButtonLocation? floatingActionButtonLocation, Widget? floatingActionButton, FloatingActionButtonAnimator? floatingActionButtonAnimator, ScreenBuilder? builder, bool? enableGestures = true, Direction defaultDirection = Direction.left, Key? key, Widget? bottomSheet, bool extendBodyBehindAppBar = false, List<Widget>? persistentFooterButtons, bool primary = true, bool? resizeToAvoidBottomInset, dynamic onSlide(SideDrawer, double)?, dynamic onOpened(SideDrawer)?, dynamic onClosed(SideDrawer)?, Color? backgroundColor})

Properties

appBar → PreferredSizeWidget?: Appbar for Scaffold
final
backgroundColor → Color?: set background color for DrawerScaffold, default: Theme.of(context).scaffoldBackgroundColor
final
body → Widget?: Screen child
final
bottomNavigationBar → Widget?: final
bottomSheet → Widget?: final
builder → ScreenBuilder?: Screen Builder => Widget ScreenBuilder
final
contentShadow → List<BoxShadow>: final
controller → DrawerScaffoldController?: set controller for DrawerScaffold
final
cornerRadius → double?: set corner radius, default: 16.0
final
defaultDirection → Direction: set default drawer from which Direction, default: Direction.left
final
drawers → List<SideDrawer>?: List of drawers
final
enableGestures → bool?: final
extendBodyBehindAppBar → bool: final
extendedBody → bool: final
floatingActionButton → Widget?: final
floatingActionButtonAnimator → FloatingActionButtonAnimator?: final
floatingActionButtonLocation → FloatingActionButtonLocation?: final
hashCode → int: The hash code for this object.
no setterinherited
key → Key?: Controls how one widget replaces another widget in the tree.
finalinherited
onClosed → (dynamic Function(SideDrawer)?): Listen to which SideDrawer is closed (offset=0)
final
onOpened → (dynamic Function(SideDrawer)?): Listen to which SideDrawer is opened (offset=1)
final
onSlide → (dynamic Function(SideDrawer, double)?): Listen to offset value on slide event for which SideDrawer
final
persistentFooterButtons → List<Widget>?: final
primary → bool: final
resizeToAvoidBottomInset → bool?: 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() → _DrawerScaffoldState: 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

Static Methods

currentController(BuildContext context, {bool nullOk = true}) → MenuController
getControllerFor(BuildContext context, SideDrawer drawer, {bool nullOk = true}) → MenuController?