AutoTabsScaffold class
A scaffold wrapper widget that makes creating an AutoTabsRouter much easier and cleaner
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatelessWidget
- AutoTabsScaffold
Constructors
-
AutoTabsScaffold({Key? key, List<
PageRouteInfo> ? routes, bool lazyLoad = true, int homeIndex = -1, Duration animationDuration = const Duration(milliseconds: 300), Curve animationCurve = Curves.ease, AnimatedIndexedStackTransitionBuilder? transitionBuilder, Widget? floatingActionButton, FloatingActionButtonBuilder? floatingActionButtonBuilder, FloatingActionButtonLocation? floatingActionButtonLocation, FloatingActionButtonAnimator? floatingActionButtonAnimator, Widget? drawer, DrawerCallback? onDrawerChanged, Widget? endDrawer, DrawerCallback? onEndDrawerChanged, Color? drawerScrimColor, Color? backgroundColor, Widget? bottomSheet, bool? resizeToAvoidBottomInset, bool primary = true, DragStartBehavior drawerDragStartBehavior = DragStartBehavior.start, double? drawerEdgeDragWidth, bool drawerEnableOpenDragGesture = true, bool endDrawerEnableOpenDragGesture = true, String? restorationId, bool extendBody = false, bool extendBodyBehindAppBar = false, AppBarBuilder? appBarBuilder, GlobalKey<ScaffoldState> ? scaffoldKey}) -
Default constructor;
const
Properties
- animationCurve → Curve
-
Curve for each tab-change transition
final
- animationDuration → Duration
-
Duration for each tab-change transition
final
- appBarBuilder → AppBarBuilder?
-
Builds a BottomNavigation to Scaffold.appBar
final
- backgroundColor → Color?
-
Passed to Scaffold.backgroundColor
final
-
Builds a BottomNavigation to
Scaffold.bottomNavigation
final - bottomSheet → Widget?
-
Passed to Scaffold.bottomSheet
final
- drawer → Widget?
-
Passed to Scaffold.drawer
final
- drawerDragStartBehavior → DragStartBehavior
-
Passed to Scaffold.drawerDragStartBehavior
final
- drawerEdgeDragWidth → double?
-
Passed to Scaffold.drawerEdgeDragWidth
final
- drawerEnableOpenDragGesture → bool
-
Passed to Scaffold.drawerEnableOpenDragGesture
final
- drawerScrimColor → Color?
-
Passed to Scaffold.drawerScrimColor
final
- endDrawer → Widget?
-
Passed to Scaffold.endDrawer
final
- endDrawerEnableOpenDragGesture → bool
-
Passed to Scaffold.endDrawerEnableOpenDragGesture
final
- extendBody → bool
-
Passed to Scaffold.extendBody
final
- extendBodyBehindAppBar → bool
-
Passed to Scaffold.extendBodyBehindAppBar
final
- floatingActionButton → Widget?
-
Passed to Scaffold.floatingActionButton
final
- floatingActionButtonAnimator → FloatingActionButtonAnimator?
-
Passed to Scaffold.floatingActionButtonAnimator
final
- floatingActionButtonBuilder → FloatingActionButtonBuilder?
-
Builds a FloatingActionButton to Scaffold.floatingActionButton
unless floatingActionButton is provided
final
- floatingActionButtonLocation → FloatingActionButtonLocation?
-
Passed to Scaffold.floatingActionButtonLocation
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- homeIndex → int
-
Passed to
Scaffold. final GlobalKey<ScaffoldState>? scaffoldKey;
if activeIndex != homeIndex set activeIndex to homeIndex else pop parentfinal -
If false AutoTabsRouter will not use
the inherited navigators form ancestor routers
final
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- lazyLoad → bool
-
If this is true routes will only be loaded once navigated to
final
-
The AutoRouteObservers to be used by AutoTabsRouter
final
- onDrawerChanged → DrawerCallback?
-
Passed to Scaffold.onDrawerChanged
final
- onEndDrawerChanged → DrawerCallback?
-
Passed to Scaffold.onEndDrawerChanged
final
-
Passed to Scaffold.persistentFooterButtons
final
- primary → bool
-
Passed to Scaffold.primary
final
- resizeToAvoidBottomInset → bool?
-
Passed to Scaffold.resizeToAvoidBottomInset
final
- restorationId → String?
-
Passed to Scaffold.restorationId
final
-
routes
→ List<
PageRouteInfo> ? -
The List of routes to be used as tabs
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
scaffoldKey
→ GlobalKey<
ScaffoldState> ? -
Passed to
Scaffold.scaffoldKey
final - transitionBuilder → AnimatedIndexedStackTransitionBuilder?
-
Builds the transition between tabs
defaults to FadeTransition
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