BaseScaffold class

Inheritance

Constructors

BaseScaffold({Widget? body, Widget? toolbar, bool isScreenLoading = false, bool isScreenLoadingWithBackground = false, bool showToolbar = true, dynamic toolbarLeftIcon, Color? toolbarLeftIconColor, String? toolbarLeftIconType, Function? toolbarLeftIconClick, dynamic toolbarRightIcon, Color? toolbarRightIconColor, String? toolbarRightIconType, Function? toolbarRightIconClick, String? toolbarTitle, String? toolbarRightText, Function? toolbarRightTextClick, String? toolbarLeftText, Function? toolbarLeftTextClick, double toolbarHeight = 60, Widget? toolbarLeftChild, Widget? toolbarCenterChild, Widget? toolbarRightChild, Widget? screenLoaderView, Widget? backgroundScreenLoaderView, Color bodyBackgroundColor = Colors.white, Color scaffoldBackgroundColor = Colors.white, Color toolbarBackgroundColor = Colors.white, TextStyle? toolbarLeftTextStyle, TextStyle? toolbarTitleTextStyle, TextStyle? toolbarRightTextStyle, Widget? floatingActionButton, FloatingActionButtonLocation? floatingActionButtonLocation, FloatingActionButtonAnimator? floatingActionButtonAnimator, List<Widget>? persistentFooterButtons, Widget? drawer, Widget? endDrawer, Widget? bottomNavigationBar, Widget? bottomSheet, bool? resizeToAvoidBottomInset, bool primary = true, DragStartBehavior drawerDragStartBehavior = DragStartBehavior.start, bool extendBody = false, bool extendBodyBehindAppBar = false, Color? drawerScrimColor, double? drawerEdgeDragWidth})
Default properties of Scaffold

Properties

backgroundScreenLoaderView → Widget?
Design custom widget for loader view which will display with body content.
final
body → Widget?
It contains the body of the screen which will be display in safe area and between toolbar and bottom navigation bar.
final
bodyBackgroundColor → Color
Set body background color.
final
bottomNavigationBar → Widget?
Default properties of Scaffold
final
bottomSheet → Widget?
Default properties of Scaffold
final
drawer → Widget?
Default properties of Scaffold
final
drawerDragStartBehavior → DragStartBehavior
Default properties of Scaffold
final
drawerEdgeDragWidth → double?
Default properties of Scaffold
final
drawerScrimColor → Color?
Default properties of Scaffold
final
endDrawer → Widget?
Default properties of Scaffold
final
extendBody → bool
Default properties of Scaffold
final
extendBodyBehindAppBar → bool
Default properties of Scaffold
final
floatingActionButton → Widget?
Default properties of Scaffold
final
floatingActionButtonAnimator → FloatingActionButtonAnimator?
Default properties of Scaffold
final
floatingActionButtonLocation → FloatingActionButtonLocation?
Default properties of Scaffold
final
hashCode → int
The hash code for this object.
no setterinherited
isScreenLoading → bool
Set true to show loading. @Note: This will hide the body and display empty screen.
final
isScreenLoadingWithBackground → bool
Set true to show loading with body in background. @Note: This will show body in background and loader on it.
final
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
persistentFooterButtons → List<Widget>?
Default properties of Scaffold
final
primary → bool
Default properties of Scaffold
final
resizeToAvoidBottomInset → bool?
Default properties of Scaffold
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
scaffoldBackgroundColor → Color
Set scaffold background color.
final
screenLoaderView → Widget?
Design custom widget for loader view where body will display empty.
final
showToolbar → bool
Show/Hide toolbar by true/false value. By default it's value is true.
final
toolbar → Widget?
Design your own custom toolbar.
final
toolbarBackgroundColor → Color
Set toolbar background color.
final
toolbarCenterChild → Widget?
Make custom widget to set at center of toolbar.
final
toolbarHeight → double
Manage height of toolbar. By default it height is 60 and it can not be less than 50.
final
toolbarLeftChild → Widget?
Make custom widget to set at left side of toolbar.
final
toolbarLeftIcon → dynamic
Set icon on left side of the toolbar. Icon can be an String value if you use an assets OR Icon can be an IconData if you use Icons.
final
toolbarLeftIconClick → Function?
Set left icon click event if you have used toolbarLeftIcon & toolbarLeftIconType.
final
toolbarLeftIconColor → Color?
Use to set only color of left icon.
final
toolbarLeftIconType → String?
If you set left icon you need to provide the type of icon. Use this to set type of icon can be from below two option.
final
toolbarLeftText → String?
Set text at left side of toolbar.
final
toolbarLeftTextClick → Function?
Set click event of left side text. @Note: It will not work if toolbarLeftText is empty or not set.
final
toolbarLeftTextStyle → TextStyle?
Set custom text style of left text in toolbar.
final
toolbarRightChild → Widget?
Make custom widget to set at right side of toolbar.
final
toolbarRightIcon → dynamic
Set icon on right side of the toolbar. Icon can be an String value if you use an assets OR Icon can be an IconData if you use Icons.
final
toolbarRightIconClick → Function?
Set right icon click event if you have used toolbarRightIcon & toolbarRightIconType.
final
toolbarRightIconColor → Color?
Use to set only color of right icon.
final
toolbarRightIconType → String?
If you set right icon you need to provide the type of icon. Use this to set type of icon can be from below two option.
final
toolbarRightText → String?
Set text at right side of toolbar.
final
toolbarRightTextClick → Function?
Set click event of right side text. @Note: It will not work if toolbarRightText is empty or not set.
final
toolbarRightTextStyle → TextStyle?
Set custom text style of right text in toolbar.
final
toolbarTitle → String?
Set title on toolbar.
final
toolbarTitleTextStyle → TextStyle?
Set custom text style of title text in toolbar.
final

Methods

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