FloatingSearchBarAction class

A widget to be displayed in a row before or after the input text of a FloatingSearchBar.

Typically this widget wraps a CircularButton.

Inheritance

Constructors

FloatingSearchBarAction({Key? key, Widget? child, Widget builder(BuildContext context, Animation<double> animation)?, bool showIfOpened = false, bool showIfClosed = true})
Creates a widget to be displayed in a row before or after the input text of a FloatingSearchBar.
const
FloatingSearchBarAction.back({double size = 24, Color? color, bool showIfClosed = false})
factory
FloatingSearchBarAction.hamburgerToBack({double size = 24, Color? color, bool isLeading = true})
A hamburger menu that when tapped opens the Drawer of the nearest Scaffold.
factory
FloatingSearchBarAction.icon({required dynamic icon, required VoidCallback onTap, double size = 24.0, bool showIfOpened = false, bool showIfClosed = true})
A convenience factory to wrap an Icon or an IconData into an action.
factory
FloatingSearchBarAction.searchToClear({double size = 24, Color? color, bool showIfClosed = true, Duration duration = const Duration(milliseconds: 900), String searchButtonSemanticLabel = 'Search', String clearButtonSemanticLabel = 'Clear'})
A search icon that transitions into a clear icon when the query of the FloatingSearchBar is not empty.
factory

Properties

builder → (Widget Function(BuildContext context, Animation<double> animation)?)
A builder that can be used when the action needs to react to changes in its FloatingSearchBar.
final
child → Widget?
The action.
final
hashCode → int
The hash code for this object.
no setterinherited
isAlwaysShown → bool
Whether this FloatingSearchBarAction is shown when opened and when closed.
no setter
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
showIfClosed → bool
Whether this action should be shown when the FloatingSearchBar is closed.
final
showIfOpened → bool
Whether this action should be shown when the FloatingSearchBar is opened.
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.
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}) → 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