CupertinoPageScaffoldModifier class

Implements a single iOS application page's layout.

The scaffold lays out the navigation bar on top and the content between or behind the navigation bar.

When tapping a status bar at the top of the CupertinoPageScaffold, an animation will complete for the current primary ScrollView, scrolling to the beginning. This is done using the PrimaryScrollController that encloses the ScrollView. The ScrollView.primary flag is used to connect a ScrollView to the enclosing PrimaryScrollController.

{@tool dartpad} This example shows a CupertinoPageScaffoldModifier with a ListView as a child. The CupertinoButton is connected to a callback that increments a counter. The backgroundColor can be changed.

** See code in examples/api/lib/cupertino/page_scaffold/cupertino_page_scaffold.0.dart ** {@end-tool}

See also:

• CupertinoTabScaffold, a similar widget for tabbed applications.
• CupertinoPageRoute, a modal page route that typically hosts a CupertinoPageScaffold with support for iOS-style page transitions.

Inheritance

• Object
• DiagnosticableTree
• Widget
• StatelessWidget
• SingleChildStatelessModifier
• CupertinoPageScaffoldModifier

Available extensions

• ModifierTransformer

Constructors

CupertinoPageScaffoldModifier({Key? key, Key? modifierKey, Widget? child, ObstructingPreferredSizeWidget? navigationBar, Color? backgroundColor, bool resizeToAvoidBottomInset = true})

Creates a layout for pages with a navigation bar at the top.

const

Properties

backgroundColor → Color?

The color of the widget that underlies the entire scaffold.

final

hashCode → int

The hash code for this object.

no setter, inherited

key → Key?

Controls how one widget replaces another widget in the tree.

final, inherited

modifierKey → Key?

The actual key of the widget, which Modifier wrapped

final, inherited

navigationBar → ObstructingPreferredSizeWidget?

The navigationBar, typically a CupertinoNavigationBar, is drawn at the top of the screen.

final

resizeToAvoidBottomInset → bool

Whether the child should size itself to avoid the window's bottom inset.

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

build(BuildContext context) → Widget

Describes the part of the user interface represented by this widget.

inherited

buildWithChild(BuildContext context, Widget? child) → Widget

A build method that receives an extra child parameter.

override

createElement() → SingleChildStatelessElement

Create a SingleChildStatelessElement

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

modified() → Modifier

Available on Widget, provided by the ModifierTransformer extension

Transform normal widget to Modifier

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