CsSearchComponent class

A search input field. This is a wrapper around the TextField widget.

Inheritance

Constructors

CsSearchComponent({Key? key, Color inputActiveColor = Colors.blueGrey, Color inputInactiveColor = Colors.white, required dynamic clearData(), IconData? suffixIcon, String searchTitle = 'Search', String textResult = 'No results found'})
Creates a search input field.
const

Properties

clearData → dynamic Function()
A function that clears the data. This is called when the clear button is pressed.
final
hashCode → int
The hash code for this object.
no setterinherited
inputActiveColor → Color
This is the color of the search input field when it is active. The default value is Colors.blueGrey. This is used to change the background color of the search input field when it is focused.
final
inputInactiveColor → Color
This is the color of the search input field when it is inactive. The default value is Colors.white. This is used to change the background color of the search input field when it is not focused.
final
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
searchTitle → String
The title of the search input field. This is displayed as a hint text in the search input field.
final
suffixIcon → IconData?
The icon to display at the end of the search input field. This is used to clear the search input field. If this is not provided, a clear button is displayed.
final
textResult → String
The text to display when no results are found. The default value is 'No results found'. This is displayed when the search query does not return any results.
final

Methods

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