AdaptiveNavigationScaffold class

A widget that adapts to the current display size, displaying a Drawer, NavigationRail, or BottomNavigationBar. Navigation destinations are defined in the destinations parameter.

Inheritance

Constructors

AdaptiveNavigationScaffold({Key? key, PreferredSizeWidget? appBar, required Widget body, FloatingActionButton? floatingActionButton, FloatingActionButtonLocation? floatingActionButtonLocation, FloatingActionButtonAnimator? floatingActionButtonAnimator, List<Widget>? persistentFooterButtons, Widget? endDrawer, Widget? bottomSheet, Color? backgroundColor, bool? resizeToAvoidBottomInset, bool primary = true, DragStartBehavior drawerDragStartBehavior = DragStartBehavior.start, bool extendBody = false, bool extendBodyBehindAppBar = false, Color? drawerScrimColor, double? drawerEdgeDragWidth, bool drawerEnableOpenDragGesture = true, bool endDrawerEnableOpenDragGesture = true, required int selectedIndex, required List<AdaptiveScaffoldDestination> destinations, ValueChanged<int>? onDestinationSelected, NavigationTypeResolver? navigationTypeResolver, Widget? drawerHeader, Widget? drawerFooter, bool fabInRail = true, bool includeBaseDestinationsInMenu = true, int bottomNavigationOverflow = 5})
const

Properties

appBar → PreferredSizeWidget?
See Scaffold.appBar.
final
backgroundColor → Color?
See Scaffold.backgroundColor.
final
body → Widget
See Scaffold.body.
final
bottomNavigationOverflow → int
Maximum number of items to display in bottomNavigationBar
final
bottomSheet → Widget?
See Scaffold.bottomSheet.
final
destinations → List<AdaptiveScaffoldDestination>
Defines the appearance of the items that are arrayed within the navigation.
final
drawerDragStartBehavior → DragStartBehavior
See Scaffold.drawerDragStartBehavior.
final
drawerEdgeDragWidth → double?
See Scaffold.drawerEdgeDragWidth.
final
drawerEnableOpenDragGesture → bool
See Scaffold.drawerEnableOpenDragGesture.
final
drawerFooter → Widget?
The footer item in the drawer when the navigation has a drawer.
final
drawerHeader → Widget?
The leading item in the drawer when the navigation has a drawer.
final
drawerScrimColor → Color?
See Scaffold.drawerScrimColor.
final
endDrawer → Widget?
See Scaffold.endDrawer.
final
endDrawerEnableOpenDragGesture → bool
See Scaffold.endDrawerEnableOpenDragGesture.
final
extendBody → bool
See Scaffold.extendBody.
final
extendBodyBehindAppBar → bool
See Scaffold.extendBodyBehindAppBar.
final
fabInRail → bool
Whether the floatingActionButton is inside or the rail or in the regular spot.
final
floatingActionButton → FloatingActionButton?
See Scaffold.floatingActionButton.
final
floatingActionButtonAnimator → FloatingActionButtonAnimator?
See Scaffold.floatingActionButtonAnimator.
final
floatingActionButtonLocation → FloatingActionButtonLocation?
See Scaffold.floatingActionButtonLocation.
final
hashCode → int
The hash code for this object.
no setterinherited
includeBaseDestinationsInMenu → bool
Weather the overflow menu defaults to include overflow destinations and the overflow destinations.
final
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
Determines the navigation type that the scaffold uses.
final
onDestinationSelected → ValueChanged<int>?
Called when one of the destinations is selected.
final
persistentFooterButtons → List<Widget>?
See Scaffold.persistentFooterButtons.
final
primary → bool
See Scaffold.primary.
final
resizeToAvoidBottomInset → bool?
See Scaffold.resizeToAvoidBottomInset.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
selectedIndex → int
The index into destinations for the current selected AdaptiveScaffoldDestination.
final

Methods

build(BuildContext context) → Widget
Describes the part of the user interface represented by this widget.
override
createElement() → StatelessElement
Creates a StatelessElement to manage this widget's 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