ArnaScaffold class

Implements the basic layout structure.

This class provides APIs for showing drawer.

See also:

  • ArnaHeaderBar, which is a horizontal bar shown at the top of the app.
Inheritance

Constructors

ArnaScaffold({Key? key, PreferredSizeWidget? headerBar, Widget? body, ArnaDrawer? drawer, ArnaDrawerCallback? onDrawerChanged, Widget? bottomNavigationBar, bool? resizeToAvoidBottomInset, String? restorationId})
Creates a basic layout structure in the Arna style.
const

Properties

body → Widget?
The primary content of the scaffold.
final
bottomNavigationBar → Widget?
A bottom navigation bar to display at the bottom of the scaffold.
final
drawer → ArnaDrawer?
A panel displayed to the side of the body, often hidden on mobile devices. Swipes in from either left-to-right (TextDirection.ltr) or right-to-left (TextDirection.rtl)
final
hashCode → int
The hash code for this object.
no setterinherited
headerBar → PreferredSizeWidget?
A header bar to display at the top of the scaffold.
final
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
onDrawerChanged → ArnaDrawerCallback?
Optional callback that is called when the ArnaScaffold.drawer is opened or closed.
final
resizeToAvoidBottomInset → bool?
If true the body should size itself to avoid the onscreen keyboard whose height is defined by the ambient MediaQuery's MediaQueryData.viewInsets bottom property.
final
restorationId → String?
Restoration ID to save and restore the state of the ArnaScaffold.
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() → ArnaScaffoldState
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

hasDrawer(BuildContext context, {bool registerForUpdates = true}) → bool
Whether the ArnaScaffold that most tightly encloses the given context has a drawer.
maybeOf(BuildContext context) → ArnaScaffoldState?
Finds the ArnaScaffoldState from the closest instance of this class that encloses the given context.
of(BuildContext context) → ArnaScaffoldState
Finds the ArnaScaffoldState from the closest instance of this class that encloses the given context.