CNBottomToolbar class

A native iOS bottom toolbar with expandable search.

This component implements the "Search in a bottom toolbar" pattern from Apple HIG. When search is tapped, it expands to fill the toolbar while showing the current context.

Example:

CNBottomToolbar(
  leadingAction: CNToolbarAction.button(
    icon: CupertinoIcons.line_horizontal_3,
    onTap: () => showMenu(),
  ),
  searchPlaceholder: 'Search',
  onSearchChanged: (text) => updateResults(text),
  trailingAction: CNToolbarAction.button(
    icon: CupertinoIcons.square_pencil,
    onTap: () => compose(),
  ),
  currentTabIcon: CupertinoIcons.house_fill, // Shows context when searching
  currentTabLabel: 'Home',
)
Inheritance

Constructors

CNBottomToolbar({Key? key, Widget? leadingAction, Widget? trailingAction, String searchPlaceholder = 'Search', ValueChanged<String>? onSearchChanged, ValueChanged<String>? onSearchSubmitted, ValueChanged<bool>? onSearchFocusChanged, IconData? currentTabIcon, String? currentTabLabel, double height = 50.0, Color? backgroundColor})
Creates a bottom toolbar with expandable search.
const

Properties

backgroundColor → Color?
Background color
final
currentTabIcon → IconData?
Icon to show when search is expanded (current tab context)
final
currentTabLabel → String?
Label to show when search is expanded (current tab context)
final
hashCode → int
The hash code for this object.
no setterinherited
height → double
Toolbar height
final
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
leadingAction → Widget?
Optional leading button (e.g., menu, filter)
final
onSearchChanged → ValueChanged<String>?
Called when search text changes
final
onSearchFocusChanged → ValueChanged<bool>?
Called when search field gains/loses focus
final
onSearchSubmitted → ValueChanged<String>?
Called when search is submitted
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
searchPlaceholder → String
Placeholder text for the search field
final
trailingAction → Widget?
Optional trailing button (e.g., compose, add)
final

Methods

createElement() → StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → State<CNBottomToolbar>
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
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