SimpleDrawer class - simple_drawer library

Constructors

SimpleDrawer({Direction direction = Direction.none, double? childWidth, double? childHeight, int? animationDurationInMilliseconds, Curve? animationCurve, Widget? child, double? simpleDrawerAreaHeight, double? simpleDrawerAreaWidth, Color? fadeColor, String? id, Function? onDrawerStatusChanged})

Properties

animationCurve → Curve?: the animation curve which the simpleDrawer takes to push in and out (optional argument. default: Curves.ease)
final
animationDurationInMilliseconds → int?: the duration in milliseconds which it takes for the simpleDrawer to be pushed in & pushed out (optional argument. default: 300)
final
child → Widget?: the content of the SimpleDrawer (what is being pushed in) (must be set)
final
childHeight → double?: the height of the child. (must be set if direction is Direction.top or .bottom)
final
childWidth → double?: the width of the child. (must be set if direction is Direction.left or .right)
final
direction → Direction: the direction from which the SimpleDrawer enters (must be set)
final
fadeColor → Color?: The color which is overlaid behind the simpleDrawer to obscure the content in the background. (optional argument. default: Colors.black54)
final
hashCode → int: The hash code for this object.
no setterinherited
id → String?: unique id chosen for a SimpleDrawer (chosen by user) (if this is changed, you must perform at least a hot reload) (must be set)
final
key → Key?: Controls how one widget replaces another widget in the tree.
finalinherited
onDrawerStatusChanged → Function?: This function is called whenever the DrawerStatus of this SimpleDrawer changes. Receives the new DrawerStatus as an argument.
final
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
simpleDrawerAreaHeight → double?: the maximum height which the entire widget (including the fading background) can take up (optional argument. default: entire device height)
final
simpleDrawerAreaWidth → double?: the maximum width which the entire widget (including the fading background) can take up (optional argument. default: entire device width)
final

Methods

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

activate(String id) → dynamic: activates the SimpleDrawer of the chosen Id & set isActive to true
deactivate(String? id) → dynamic: deactivates the SimpleDrawer of the chosen Id & set isActive to false
getDrawerStatus(String id) → DrawerStatus?: returns the current status of a drawer