SliverToolBar class

A variant of ToolBar that is compatible with slivers.

It is nearly identical to ToolBar, with the exception that this widget must only be used ScrollViews that allow slivers, such as CustomScrollView and NestedScrollView. It contains three additional properties that are relevant to its usage in such ScrollViews: pinned, floating, and toolbarOpacity.

See also:

Inheritance
Mixed in types

Constructors

SliverToolBar({Key? key, double height = _kToolbarHeight, Alignment alignment = Alignment.center, Widget? title, double titleWidth = _kTitleWidth, EdgeInsets padding = const EdgeInsets.symmetric(horizontal: 8, vertical: 4.0), BoxDecoration? decoration, Widget? leading, bool automaticallyImplyLeading = true, List<ToolbarItem>? actions, bool centerTitle = false, Color? dividerColor, bool pinned = true, bool floating = false, double toolbarOpacity = 0.9, bool allowWallpaperTintingOverrides = true})
A variant of ToolBar that is compatible with slivers.
const

Properties

actions List<ToolbarItem>?
A list of ToolbarItem widgets to display in a row after the title widget, as the toolbar actions.
final
alignment Alignment
Aligns the title within the ToolBar.
final
allowWallpaperTintingOverrides bool
Whether this SliverToolBar is allowed to perform wallpaper tinting overrides.
final
automaticallyImplyLeading bool
Controls whether we should try to imply the leading widget if null.
final
centerTitle bool
Whether the title should be centered.
final
decoration BoxDecoration?
The decoration to paint behind the title.
final
dividerColor Color?
The color of the divider below the toolbar.
final
floating bool
Whether the toolbar should become visible as soon as the user scrolls upwards.
final
hashCode int
The hash code for this object.
no setterinherited
height double
Specifies the height of this ToolBar.
final
key Key?
Controls how one widget replaces another widget in the tree.
finalinherited
leading Widget?
A widget to display before the toolbar's title.
final
padding EdgeInsets
Empty space to inscribe inside the toolbar. The title, if any, is placed inside this padding.
final
pinned bool
Whether the toolbar should remain visible at the start of the scroll view.
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
title Widget?
The title of the toolbar.
final
titleWidth double
Specifies the width of the title of the ToolBar.
final
toolbarOpacity double
The opacity of the toolbar when content is scrolled underneath it.
final

Methods

createElement() StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() State<SliverToolBar>
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.
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}) 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 brief description of this object, usually just the runtimeType and the hashCode.
inherited

Operators

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