PageTabScaffold<T> class

A scaffold widget that supports pages and tabs.

Inheritance
Available extensions

Constructors

PageTabScaffold({required PageTabController pageTabController, required PageEntries items, Widget? drawer, 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, String? restorationId, Widget? floatingActionButton, dynamic title, dynamic subtitle, Color? appBarBackgroundColor, Widget? leading, List<Widget>? actions, Widget wrapper(Widget)?, Color? iconColor, Color? activeIconColor, BottomNavigationBarType? bottomNavigationBarType, bool? scrollableTabs, Color? labelColor, Color? titleColor, bool showUnselectedLabels = true, double? tabHeight, FloatingActionButtonLocation? floatingActionButtonLocation, bool useDrawerInstedOfBottomNavigationBar = false, Color? bottomBarBackgroundColor, GlobalKey<ScaffoldState>? scaffoldKey, bool automaticallyImplyLeading = true, void onNavigate(int oldPageIndex, int oldTabIndex, int newPageIndex, int newTabIndex)?, Widget tabBuilder(PageEntry page, TabEntry tab)?, double? leadingWidth})
const

Properties

actions → List<Widget>?
The actions for the app bar.
final
activeIconColor → Color?
The color of the active icons.
final
appBarBackgroundColor → Color?
The background color of the app bar.
final
automaticallyImplyLeading → bool
Whether to automatically imply the leading widget.
final
backgroundColor → Color?
The background color of the scaffold.
final
bottomBarBackgroundColor → Color?
The background color of the bottom bar.
final
bottomNavigationBarType → BottomNavigationBarType?
The type of the bottom navigation bar.
final
bottomSheet → Widget?
The bottom sheet widget.
final
drawer → Widget?
The drawer widget.
final
drawerDragStartBehavior → DragStartBehavior
The drag start behavior for the drawer.
final
drawerEdgeDragWidth → double?
The edge drag width for the drawer.
final
drawerEnableOpenDragGesture → bool
Whether to enable open drag gesture for the drawer.
final
drawerScrimColor → Color?
The scrim color for the drawer.
final
endDrawer → Widget?
The end drawer widget.
final
endDrawerEnableOpenDragGesture → bool
Whether to enable open drag gesture for the end drawer.
final
extendBody → bool
Whether to extend the body of the scaffold.
final
extendBodyBehindAppBar → bool
Whether to extend the body behind the app bar.
final
floatingActionButton → Widget?
The floating action button widget.
final
floatingActionButtonLocation → FloatingActionButtonLocation?
The location of the floating action button.
final
hashCode → int
The hash code for this object.
no setterinherited
iconColor → Color?
The color of the icons.
final
items → PageEntries
The page entries for the scaffold.
final
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
labelColor → Color?
The color of the tab labels.
final
leading → Widget?
The leading widget for the app bar.
final
leadingWidth → double?
final
onNavigate → void Function(int oldPageIndex, int oldTabIndex, int newPageIndex, int newTabIndex)?
The callback function for navigation events.
final
pageTabController → PageTabController
The controller for managing the state of the scaffold.
final
primary → bool
Whether the scaffold is the primary scaffold.
final
resizeToAvoidBottomInset → bool?
Whether to resize the scaffold to avoid the bottom inset.
final
restorationId → String?
The restoration ID for the scaffold.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
scaffoldKey → GlobalKey<ScaffoldState>?
The global key for the scaffold state.
final
scrollableTabs → bool?
Whether the tabs are scrollable.
final
showUnselectedLabels → bool
Whether to show unselected labels in the bottom navigation bar.
final
subtitle → dynamic
The subtitle of the scaffold.
final
tabBuilder → Widget Function(PageEntry page, TabEntry tab)?
The builder function for tabs.
final
tabHeight → double?
The height of the tabs.
final
text → string

Available on Widget, provided by the WidgetExt extension

get all the Text children in the widget tree and return their text as string
no setter
texts → Iterable<string>

Available on Widget, provided by the WidgetExt extension

get all the Text children in the widget tree and return their text as list of string
no setter
title → dynamic
The title of the scaffold.
final
titleColor → Color?
The color of the title.
final
useDrawerInstedOfBottomNavigationBar → bool
Whether to use the drawer instead of the bottom navigation bar.
final
wrapper → Widget Function(Widget)?
The wrapper function for the scaffold body.
final

Methods

alignAtBottomCenter({Key? key, double? heightFactor, double? widthFactor}) → Align

Available on Widget, provided by the AlignExtensions extension

Aligns the widget at the bottom center of its parent.
alignAtBottomLeft({Key? key, double? heightFactor, double? widthFactor}) → Align

Available on Widget, provided by the AlignExtensions extension

Aligns the widget at the bottom left of its parent.
alignAtBottomRight({Key? key, double? heightFactor, double? widthFactor}) → Align

Available on Widget, provided by the AlignExtensions extension

Aligns the widget at the bottom right of its parent.
alignAtCenter({Key? key, double? heightFactor, double? widthFactor}) → Align

Available on Widget, provided by the AlignExtensions extension

Aligns the widget at the center of its parent.
alignAtCenterLeft({Key? key, double? heightFactor, double? widthFactor}) → Align

Available on Widget, provided by the AlignExtensions extension

Aligns the widget at the center left of its parent.
alignAtCenterRight({Key? key, double? heightFactor, double? widthFactor}) → Align

Available on Widget, provided by the AlignExtensions extension

Aligns the widget at the center right of its parent.
alignAtLERP(Alignment a, Alignment b, double t, {Key? key, double? heightFactor, double? widthFactor}) → Align

Available on Widget, provided by the AlignExtensions extension

Aligns the widget at a linear interpolation between two alignments.
alignAtTopCenter({Key? key, double? heightFactor, double? widthFactor}) → Align

Available on Widget, provided by the AlignExtensions extension

Aligns the widget at the top center of its parent.
alignAtTopLeft({Key? key, double? heightFactor, double? widthFactor}) → Align

Available on Widget, provided by the AlignExtensions extension

Aligns the widget at the top left of its parent.
alignAtTopRight({Key? key, double? heightFactor, double? widthFactor}) → Align

Available on Widget, provided by the AlignExtensions extension

Aligns the widget at the top right of its parent.
alignXY(double x, double y, {Key? key, double? heightFactor, double? widthFactor}) → Align

Available on Widget, provided by the AlignExtensions extension

Aligns the widget at a specific x and y coordinate within its parent.
applyShimmer({bool enable = true, Color? baseColor, Color? highlightColor}) → Widget

Available on Widget, provided by the ShimmerEffect extension

blurEffect([double sigmaX = 5, double sigmaY = 5, TileMode tileMode = TileMode.clamp]) → Widget

Available on Widget, provided by the WidgetExt extension

createElement() → StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → State<PageTabScaffold>
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
expanded({int flex = 1}) → Expanded

Available on Widget, provided by the ExpandedExtension extension

flexible({int flex = 1}) → Flexible

Available on Widget, provided by the FlexibleExtension extension

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
paddingAll(double value, {Key? key}) → Padding

Available on Widget, provided by the PaddingX extension

paddingFromViewPadding(ViewPadding padding, double devicePixelRatio, {Key? key}) → Padding

Available on Widget, provided by the PaddingX extension

paddingLTRB(double left, double top, double right, double bottom, {Key? key}) → Padding

Available on Widget, provided by the PaddingX extension

paddingOnly({double left = 0.0, double top = 0.0, double right = 0.0, double bottom = 0.0, Key? key}) → Padding

Available on Widget, provided by the PaddingX extension

paddingSymmetric({double vertical = 0.0, double horizontal = 0.0, Key? key}) → Padding

Available on Widget, provided by the PaddingX extension

positionBottom({Key? key, required double bottom, double? width, double? height}) → Positioned

Available on Widget, provided by the PositionedExtensions extension

positionLeft({Key? key, required double left, double? width, double? height}) → Positioned

Available on Widget, provided by the PositionedExtensions extension

positionLR({Key? key, required double left, required double right, double? width, double? height}) → Positioned

Available on Widget, provided by the PositionedExtensions extension

positionLRTB({Key? key, required double top, required double bottom, required double left, required double right, double? width, double? height}) → Positioned

Available on Widget, provided by the PositionedExtensions extension

positionRight({Key? key, required double right, double? width, double? height}) → Positioned

Available on Widget, provided by the PositionedExtensions extension

positionTB({Key? key, required double top, required double bottom, double? width, double? height}) → Positioned

Available on Widget, provided by the PositionedExtensions extension

positionTop({Key? key, required double top, double? width, double? height}) → Positioned

Available on Widget, provided by the PositionedExtensions extension

setOpacity({required double opacity}) → Opacity

Available on Widget, provided by the OpacityExtension extension

toCenter() → Center

Available on Widget, provided by the CenterExtension extension

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, int wrapWidth = 65}) → 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
withTooltip(String message, {Decoration? decoration, double? height, bool? preferBelow, EdgeInsetsGeometry? padding, TextStyle? textStyle, Duration? waitDuration, EdgeInsetsGeometry? margin}) → Widget

Available on Widget, provided by the WidgetsExtension extension

wrapIf(bool test, Widget func(Widget wrappedChild)) → Widget

Available on Widget, provided by the WidgetExt extension

wrap a widget using a Function if test is true

Operators

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