CustomScaffold class
A Scaffold wrapped in Semantics with a SafeArea.
Also includes WillPopScope and a RefreshIndicator to be used when necessary.
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatefulWidget
- CustomScaffold
Constructors
-
CustomScaffold({Key? key, required Widget body, PreferredSizeWidget? appBar, bool bottom = true, Widget? bottomSheet, Widget? drawer, bool dynamicFab = false, Widget? endDrawer, Widget? floatingActionButton, FloatingActionButtonLocation? floatingActionButtonLocation, bool left = true, AsyncCallback? onRefresh, AsyncValueGetter<
bool> ? onWillPop, EdgeInsets padding = EdgeInsets.zero, bool resizeToAvoidBottomInset = true, bool right = true, String? semanticLabel, bool top = false}) -
A Scaffold wrapped in Semantics with a SafeArea.
const
Properties
- appBar → PreferredSizeWidget?
-
An app bar to display at the top of the scaffold.
final
- body → Widget
-
The primary content of the scaffold.
final
- bottom → bool
-
Whether to avoid system intrusions on the bottom side of the screen.
final
-
A bottom navigation bar to display at the bottom of the scaffold.
final
- bottomSheet → Widget?
-
The persistent bottom sheet to display.
final
- drawer → Widget?
-
A panel displayed to the side of the body.
final
- dynamicFab → bool
-
final
- endDrawer → Widget?
-
A panel displayed to the side of the body.
final
- floatingActionButton → Widget?
-
A button displayed floating above body.
final
- floatingActionButtonLocation → FloatingActionButtonLocation?
-
Responsible for determining where the floatingActionButton should go.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- left → bool
-
Whether to avoid system intrusions on the left.
final
- onRefresh → AsyncCallback?
-
A function that's called when the user has dragged
far enough to demonstrate that they want the app to refresh
final
-
onWillPop
→ AsyncValueGetter<
bool> ? -
Called to veto attempts by the user to dismiss the enclosing ModalRoute.
final
- padding → EdgeInsets
-
Empty space around the body.
final
- resizeToAvoidBottomInset → bool
-
If true the body and floating widgets avoid the onscreen keyboard.
final
- right → bool
-
Whether to avoid system intrusions on the right.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- semanticLabel → String?
-
Creates a semantic annotation.
final
- top → bool
-
Whether to avoid system intrusions at the top of the screen,
typically the system status bar.
final
Methods
-
createElement(
) → StatefulElement -
Creates a StatefulElement to manage this widget's location in the tree.
inherited
-
createState(
) → State< CustomScaffold> -
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