FScaffold class

A layout structure that contains a header, content, and footer.

A scaffold provides the basic visual structure for an application, containing elements like header, sidebar, content area, and footer. It is highly recommended to use a scaffold when creating a page even if other elements are not required.

The layout structure (LTR) is organized as follows:

┌─────────┬─────────────────────┐
│         │       HEADER        │
│         ├─────────────────────┤
│         │                     │
│         │                     │
│ SIDEBAR │    CONTENT AREA     │
│         │                     │
│         │                     │
│         ├─────────────────────┤
│         │       FOOTER        │
└─────────┴─────────────────────┘

See:

Inheritance

Constructors

FScaffold({required Widget child, FScaffoldStyle scaffoldStyle(FScaffoldStyle style)?, FToasterStyle toasterStyle(FToasterStyle style)?, Widget? header, Widget? sidebar, Widget? footer, bool childPad = true, bool resizeToAvoidBottomInset = true, Key? key})
Creates a FScaffold.
const

Properties

child → Widget
The main content area of the scaffold.
final
childPad → bool
True if FScaffoldStyle.childPadding should be applied to the child. Defaults to true.
final
The optional footer displayed at the bottom of the scaffold.
final
hashCode → int
The hash code for this object.
no setterinherited
The optional header displayed at the top of the scaffold.
final
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
resizeToAvoidBottomInset → bool
If true, the child 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
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
scaffoldStyle → FScaffoldStyle Function(FScaffoldStyle style)?
The style. Defaults to FThemeData.scaffoldStyle.
final
The optional sidebar displayed at the side of the scaffold.
final
toasterStyle → FToasterStyle Function(FToasterStyle style)?
The toaster style.
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.
override
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, 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

Operators

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