BaseScaffold<T extends ExritedWidget> class abstract

A Scaffold designed to handle BaseException in the user interface. The new parameter showFunction can be used to customize how this happens. When extending the class, the type of the ExritedWidget must be specified.

Inheritance

Constructors

BaseScaffold({Key? key, PreferredSizeWidget? appBar, required Widget body, Widget? floatingActionButton, FloatingActionButtonLocation? floatingActionButtonLocation, FloatingActionButtonAnimator? floatingActionButtonAnimator, List<Widget>? persistentFooterButtons, Widget? drawer, Widget? endDrawer, Widget? bottomNavigationBar, Widget? bottomSheet, Color? backgroundColor, bool? resizeToAvoidBottomInset, bool primary = true, DragStartBehavior drawerDragStartBehavior = DragStartBehavior.start, bool extendBody = false, Color? drawerScrimColor, double? drawerEdgeDragWidth, ShowFunction? showFunction})

Properties

appBar PreferredSizeWidget?
An app bar to display at the top of the scaffold.
finalinherited
backgroundColor Color?
The color of the Material widget that underlies the entire Scaffold.
finalinherited
body Widget?
The primary content of the scaffold.
finalinherited
bottomNavigationBar Widget?
A bottom navigation bar to display at the bottom of the scaffold.
finalinherited
bottomSheet Widget?
The persistent bottom sheet to display.
finalinherited
drawer Widget?
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)
finalinherited
drawerDragStartBehavior DragStartBehavior
Determines the way that drag start behavior is handled.
finalinherited
drawerEdgeDragWidth double?
The width of the area within which a horizontal swipe will open the drawer.
finalinherited
drawerEnableOpenDragGesture bool
Determines if the Scaffold.drawer can be opened with a drag gesture on mobile.
finalinherited
drawerScrimColor Color?
The color to use for the scrim that obscures primary content while a drawer is open.
finalinherited
endDrawer Widget?
A panel displayed to the side of the body, often hidden on mobile devices. Swipes in from right-to-left (TextDirection.ltr) or left-to-right (TextDirection.rtl)
finalinherited
endDrawerEnableOpenDragGesture bool
Determines if the Scaffold.endDrawer can be opened with a gesture on mobile.
finalinherited
extendBody bool
If true, and bottomNavigationBar or persistentFooterButtons is specified, then the body extends to the bottom of the Scaffold, instead of only extending to the top of the bottomNavigationBar or the persistentFooterButtons.
finalinherited
extendBodyBehindAppBar bool
If true, and an appBar is specified, then the height of the body is extended to include the height of the app bar and the top of the body is aligned with the top of the app bar.
finalinherited
floatingActionButton Widget?
A button displayed floating above body, in the bottom right corner.
finalinherited
floatingActionButtonAnimator FloatingActionButtonAnimator?
Animator to move the floatingActionButton to a new floatingActionButtonLocation.
finalinherited
floatingActionButtonLocation FloatingActionButtonLocation?
Responsible for determining where the floatingActionButton should go.
finalinherited
hashCode int
The hash code for this object.
no setterinherited
key Key?
Controls how one widget replaces another widget in the tree.
finalinherited
onDrawerChanged DrawerCallback?
Optional callback that is called when the Scaffold.drawer is opened or closed.
finalinherited
onEndDrawerChanged DrawerCallback?
Optional callback that is called when the Scaffold.endDrawer is opened or closed.
finalinherited
persistentFooterAlignment AlignmentDirectional
The alignment of the persistentFooterButtons inside the OverflowBar.
finalinherited
persistentFooterButtons List<Widget>?
A set of buttons that are displayed at the bottom of the scaffold.
finalinherited
primary bool
Whether this scaffold is being displayed at the top of the screen.
finalinherited
resizeToAvoidBottomInset bool?
If true the body and the scaffold's floating widgets should size themselves to avoid the onscreen keyboard whose height is defined by the ambient MediaQuery's MediaQueryData.viewInsets bottom property.
finalinherited
restorationId String?
Restoration ID to save and restore the state of the Scaffold.
finalinherited
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() ScaffoldState
Creates the mutable state for this widget at a given location in the tree.
inherited
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