JsonScaffold class

Inheritance

Constructors

JsonScaffold({Map<String, dynamic> args = const {}, JsonWidgetRegistry? registry, JsonWidgetData? appBar, Color? backgroundColor, JsonWidgetData? body, JsonWidgetData? bottomNavigationBar, JsonWidgetData? bottomSheet, JsonWidgetData? drawer, DragStartBehavior drawerDragStartBehavior = DragStartBehavior.start, double? drawerEdgeDragWidth, bool drawerEnableOpenDragGesture = true, Color? drawerScrimColor, JsonWidgetData? endDrawer, bool endDrawerEnableOpenDragGesture = true, bool extendBody = false, bool extendBodyBehindAppBar = false, JsonWidgetData? floatingActionButton, FloatingActionButtonAnimator? floatingActionButtonAnimator, FloatingActionButtonLocation? floatingActionButtonLocation, void onDrawerChanged(bool)?, void onEndDrawerChanged(bool)?, AlignmentDirectional persistentFooterAlignment = AlignmentDirectional.centerEnd, List<JsonWidgetData>? persistentFooterButtons, bool primary = true, bool? resizeToAvoidBottomInset, String? restorationId})

Properties

appBar → JsonWidgetData?
An app bar to display at the top of the scaffold.
final
backgroundColor → Color?
The color of the Material widget that underlies the entire Scaffold.
final
body → JsonWidgetData?
The primary content of the scaffold.
final
bottomNavigationBar → JsonWidgetData?
A bottom navigation bar to display at the bottom of the scaffold.
final
bottomSheet → JsonWidgetData?
The persistent bottom sheet to display.
final
drawer → JsonWidgetData?
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
drawerDragStartBehavior → DragStartBehavior
Determines the way that drag start behavior is handled.
final
drawerEdgeDragWidth → double?
The width of the area within which a horizontal swipe will open the drawer.
final
drawerEnableOpenDragGesture → bool
Determines if the Scaffold.drawer can be opened with a drag gesture on mobile.
final
drawerScrimColor → Color?
The color to use for the scrim that obscures primary content while a drawer is open.
final
endDrawer → JsonWidgetData?
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)
final
endDrawerEnableOpenDragGesture → bool
Determines if the Scaffold.endDrawer can be opened with a gesture on mobile.
final
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.
final
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.
final
floatingActionButton → JsonWidgetData?
A button displayed floating above body, in the bottom right corner.
final
floatingActionButtonAnimator → FloatingActionButtonAnimator?
Animator to move the floatingActionButton to a new floatingActionButtonLocation.
final
floatingActionButtonLocation → FloatingActionButtonLocation?
Responsible for determining where the floatingActionButton should go.
final
hashCode → int
The hash code for this object.
no setterinherited
jsonWidgetArgs → dynamic
finalinherited
jsonWidgetBuilder → JsonWidgetBuilder Function()
finalinherited
jsonWidgetId → String
finalinherited
jsonWidgetListenVariables → Set<String>
finalinherited
jsonWidgetRegistry → JsonWidgetRegistry
finalinherited
jsonWidgetType → String
finalinherited
onDrawerChanged → (void Function(bool)?)
Optional callback that is called when the Scaffold.drawer is opened or closed.
final
onEndDrawerChanged → (void Function(bool)?)
Optional callback that is called when the Scaffold.endDrawer is opened or closed.
final
persistentFooterAlignment → AlignmentDirectional
The alignment of the persistentFooterButtons inside the OverflowBar.
final
persistentFooterButtons → List<JsonWidgetData>?
A set of buttons that are displayed at the bottom of the scaffold.
final
primary → bool
Whether this scaffold is being displayed at the top of the screen.
final
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.
final
restorationId → String?
Restoration ID to save and restore the state of the Scaffold.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

build({ChildWidgetBuilder? childBuilder, required BuildContext context, JsonWidgetRegistry? registry}) → Widget
Convenience method that can build the widget this data object represents. This is the equilivant of calling: builder.build and passing this in as the data parameter.
inherited
copyWith({dynamic jsonWidgetArgs, JsonWidgetBuilder? jsonWidgetBuilder, Set<String>? jsonWidgetListenVariables, String? jsonWidgetId, JsonWidgetRegistry? jsonWidgetRegistry, String? jsonWidgetType}) → JsonWidgetData
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() → Map<String, dynamic>
Abstract function that concrete classes must implement. This must encode the internal data model to a JSON compatible representation.
inherited
toString() → String
Returns the string encoded JSON representation for this class. This will remove all null values and empty collections from the returned string.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited