ZetaSearchBar class Components

ZetaSearchBar provides input field for searching.

Figma: https://www.figma.com/design/JesXQFLaPJLc1BdBM4sisI/%F0%9F%A6%93-ZDS---Components?node-id=875-17463&node-type=canvas&m=dev

Widgetbook: https://zeta-ds.web.app/flutter/widgetbook/index.html#/?path=components/search-bar

Inheritance
Available Extensions

Constructors

ZetaSearchBar({AutovalidateMode? autovalidateMode, FormFieldValidator<String>? validator, FormFieldSetter<String>? onSaved, ValueChanged<String?>? onChange, @Deprecated('Use onFieldSubmitted instead. ' 'deprecated as of 0.15.0') ValueChanged<String?>? onSubmit, ValueChanged<String?>? onFieldSubmitted, ZetaFormFieldRequirement? requirementLevel, TextEditingController? controller, bool disabled = false, String? initialValue, ZetaWidgetSize size = ZetaWidgetSize.medium, ZetaWidgetBorder shape = ZetaWidgetBorder.rounded, @Deprecated('hint has been removed. ' 'deprecated as of 0.15.0') String? hint, @Deprecated('Use placeholder instead. ' 'deprecated as of 0.16.0') String? hintText, String? placeholder, Future<String?> onSpeechToText()?, bool showSpeechToText = true, @Deprecated('Use disabled instead. ' 'enabled is deprecated as of 0.11.0') bool enabled = true, FocusNode? focusNode, TextInputAction? textInputAction, String? microphoneSemanticLabel, String? clearSemanticLabel, Key? key, @Deprecated('Show leading icon is deprecated as of 0.14.2') bool showLeadingIcon = true, @Deprecated('Use onChange instead') ValueChanged<String?>? onChanged})
Constructor for ZetaSearchBar.

Properties

autovalidateMode AutovalidateMode
Used to enable/disable this form field auto validation and update its error text.
finalinherited
builder FormFieldBuilder<String>
Function that returns the widget representing this form field. It is passed the form field state as input, containing the current value and validation state of this field.
finalinherited
clearSemanticLabel String?
Label passed to the clear button for semantic purposes.
final
controller TextEditingController?
The controller for the text form field.
finalinherited
enabled bool
Whether the form is able to receive user input.
finalinherited
focusNode FocusNode?
A FocusNode for the underlying TextFormField
final
forceErrorText String?
An optional property that forces the FormFieldState into an error state by directly setting the FormFieldState.errorText property without running the validator function.
finalinherited
hashCode int
The hash code for this object.
no setterinherited
initialValue String?
An optional value to initialize the form field to, or null otherwise.
finalinherited
key Key?
Controls how one widget replaces another widget in the tree.
finalinherited
microphoneSemanticLabel String?
Label passed to the microphone button for semantic purposes.
final
onChange ValueChanged<String?>?
Called whenever the form field changes.
finalinherited
onFieldSubmitted ValueChanged<String?>?
Called whenever the form field is submitted.
finalinherited
onSaved FormFieldSetter<String>?
An optional method to call with the final value when the form is saved via FormState.save.
finalinherited
onSpeechToText → (Future<String?> Function()?)
A callback, which is invoked when the microphone button is pressed.
final
placeholder String?
Placeholder text for the search field.
final
requirementLevel ZetaFormFieldRequirement?
The requirement level of the form field.
finalinherited
restorationId String?
Restoration ID to save and restore the state of the form field.
finalinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
shape ZetaWidgetBorder
Determines the shape of the input field. Default is ZetaWidgetBorder.rounded
final
showSpeechToText bool
Determines if there should be a Speech-To-Text button. Default is true.
final
size ZetaWidgetSize
Determines the size of the input field. Default is ZetaWidgetSize.medium
final
textInputAction TextInputAction?
The type of action button to use for the keyboard.
final
validator FormFieldValidator<String>?
An optional method that validates an input. Returns an error string to display if the input is invalid, or null otherwise.
finalinherited

Methods

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