CupertinoSliverNavigationBar class

An iOS-styled navigation bar with iOS-11-style large titles using slivers.

The CupertinoSliverNavigationBar must be placed in a sliver group such as the CustomScrollView.

This navigation bar consists of two sections, a pinned static section on top and a sliding section containing iOS-11-style large title below it.

It should be placed at top of the screen and automatically accounts for the iOS status bar.

Minimally, a largeTitle widget will appear in the middle of the app bar when the sliver is collapsed and transfer to the area below in larger font when the sliver is expanded.

For advanced uses, an optional middle widget can be supplied to show a different widget in the middle of the navigation bar when the sliver is collapsed.

Like CupertinoNavigationBar, it also supports a leading and trailing widget on the static section on top that remains while scrolling.

The leading widget will automatically be a back chevron icon button (or a close button in case of a fullscreen dialog) to pop the current route if none is provided and automaticallyImplyLeading is true (true by default).

The largeTitle widget will automatically be a title text from the current CupertinoPageRoute if none is provided and automaticallyImplyTitle is true (true by default).

When transitionBetweenRoutes is true, this navigation bar will transition on top of the routes instead of inside them if the route being transitioned to also has a CupertinoNavigationBar or a CupertinoSliverNavigationBar with transitionBetweenRoutes set to true. If transitionBetweenRoutes is true, none of the Widget parameters can contain any GlobalKeys in their subtrees since those widgets will exist in multiple places in the tree simultaneously.

By default, only one CupertinoNavigationBar or CupertinoSliverNavigationBar should be present in each PageRoute to support the default transitions. Use transitionBetweenRoutes or heroTag to customize the transition behavior for multiple navigation bars per route.

CupertinoSliverNavigationBar has its text scale factor set to 1.0 by default and does not respond to text scale factor changes from the operating system, to match the native iOS behavior. To override this behavior, wrap each of the CupertinoSliverNavigationBar's components inside a MediaQuery with the desired MediaQueryData.textScaleFactor value. The text scale factor value from the operating system can be retrieved in many ways, such as querying MediaQuery.textScaleFactorOf against CupertinoApp's BuildContext.

See also:



CupertinoSliverNavigationBar({Key key, Widget largeTitle, Widget leading, bool automaticallyImplyLeading = true, bool automaticallyImplyTitle = true, String previousPageTitle, Widget middle, Widget trailing, Border border = _kDefaultNavBarBorder, Color backgroundColor, EdgeInsetsDirectional padding, Color actionsForegroundColor, bool transitionBetweenRoutes = true, Object heroTag = _defaultHeroTag, double navBarLargeTitleHeightExtension = _kNavBarLargeTitleHeightExtension, bool backdropFilter = true, double navBarPersistentHeight})
Creates a navigation bar for scrolling lists. [...]


actionsForegroundColor Color
Default color used for text and icons of the leading and trailing widgets in the navigation bar. [...]
@Deprecated('Use CupertinoTheme and primaryColor to propagate color. ' 'This feature was deprecated after v1.1.2.'), final
automaticallyImplyLeading bool
Controls whether we should try to imply the leading widget if null. [...]
automaticallyImplyTitle bool
Controls whether we should try to imply the largeTitle widget if null. [...]
backdropFilter bool
backgroundColor Color
The background color of the navigation bar. If it contains transparency, the tab bar will automatically produce a blurring effect to the content behind it. [...]
border Border
The border of the navigation bar. By default renders a single pixel bottom border side. [...]
hashCode int
The hash code for this object. [...]
@nonVirtual, read-only, inherited
heroTag Object
Tag for the navigation bar's Hero widget if transitionBetweenRoutes is true. [...]
key Key
Controls how one widget replaces another widget in the tree. [...]
final, inherited
largeTitle Widget
The navigation bar's title. [...]
leading Widget
Widget to place at the start of the navigation bar. Normally a back button for a normal page or a cancel button for full page dialogs. [...]
middle Widget
A widget to place in the middle of the static navigation bar instead of the largeTitle. [...]
custom navBarLargeTitleHeight
custom height
opaque bool
True if the navigation bar's background color has no transparency.
padding EdgeInsetsDirectional
Padding for the contents of the navigation bar. [...]
previousPageTitle String
Manually specify the previous route's title when automatically implying the leading back button. [...]
runtimeType Type
A representation of the runtime type of the object.
read-only, inherited
trailing Widget
Widget to place at the end of the navigation bar. Normally additional actions taken on the page such as a search or edit function. [...]
transitionBetweenRoutes bool
Whether to transition between navigation bars. [...]


createElement() StatefulElement
Creates a StatefulElement to manage this widget's location in the tree. [...]
createState() → _CupertinoSliverNavigationBarState
Creates the mutable state for this widget at a given location in the tree. [...]
debugDescribeChildren() List<DiagnosticsNode>
Returns a list of DiagnosticsNode objects describing this node's children. [...]
@protected, inherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → void
Add additional properties associated with the node. [...]
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed. [...]
toDiagnosticsNode({String name, DiagnosticsTreeStyle style}) DiagnosticsNode
Returns a debug representation of the object that is used by debugging tools and by DiagnosticsNode.toStringDeep. [...]
toString({DiagnosticLevel minLevel =}) String
A string representation of this object. [...]
toStringDeep({String prefixLineOne = '', String prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug}) String
Returns a string representation of this node and its descendants. [...]
toStringShallow({String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) String
Returns a one-line detailed description of the object. [...]
toStringShort() String
A short, textual description of this widget.


operator ==(Object other) bool
The equality operator. [...]
@nonVirtual, inherited