CkSearch class
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatefulWidget
- CkSearch
- Available extensions
Constructors
- CkSearch({Key? key, dynamic onSearch(String value)?, String? hintText, TextEditingController? controller, Widget? prefixIcon, Widget? suffixIcon, Widget? suffixBuilder(TextEditingController controller, FocusNode focusNode)?, Widget? prefixBuilder(TextEditingController controller, FocusNode focusNode)?, Color? borderColor, Color? backgroundColor, double? borderRadius, double borderWidth = 1.2, CkBorderType borderType = CkBorderType.outline, double paddingHorizontal = 16, double paddingVertical = 14, bool isReadOnly = false, TextInputAction textInputAction = TextInputAction.search, int? maxLength, double? fontSize, TextStyle? textStyle, TextStyle? hintStyle, TextAlign textAlign = TextAlign.left, VoidCallback? onTap, dynamic onFocusChanged(FocusNode focusNode)?, int baseDelayMs = 300, int incrementMs = 100, int maxDelayMs = 800, bool showClearButton = true})
-
const
Properties
- backgroundColor → Color?
-
final
- baseDelayMs → int
-
Base debounce delay in milliseconds. Default: 300ms.
final
- borderColor → Color?
-
final
- borderRadius → double?
-
final
- borderType → CkBorderType
-
final
- borderWidth → double
-
final
- center → Widget
-
Available on Widget, provided by the Alignments extension
no setter - controller → TextEditingController?
-
final
- end → Widget
-
Available on Widget, provided by the Alignments extension
no setter - fontSize → double?
-
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- hintStyle → TextStyle?
-
final
- hintText → String?
-
final
- incrementMs → int
-
Extra milliseconds added to the delay per keystroke since the last fire.
Grows the delay while the user is typing continuously (fast typers
get a longer grace window). Default: 100ms.
final
- isReadOnly → bool
-
final
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- marginZero → Widget
-
Available on Widget, provided by the WidgetMarginX extension
no setter - maxDelayMs → int
-
Upper cap for the adaptive delay. Default: 800ms.
final
- maxLength → int?
-
final
- onFocusChanged → dynamic Function(FocusNode focusNode)?
-
final
- onSearch → dynamic Function(String value)?
-
Debounced callback — fires only when the user pauses typing AND the text
has actually changed since the last fired value.
final
- onTap → VoidCallback?
-
final
- paddingHorizontal → double
-
final
- paddingVertical → double
-
final
- paddingZero → Widget
-
Available on Widget, provided by the WidgetPaddingX extension
no setter - prefixBuilder → Widget? Function(TextEditingController controller, FocusNode focusNode)?
-
Dynamic prefix builder. When provided, overrides prefixIcon.
final
- prefixIcon → Widget?
-
Left-side icon. Defaults to Icons.search when null.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- showClearButton → bool
-
Shows a x clear button when the field is non-empty.
Suppressed if suffixIcon or suffixBuilder is provided.
final
- sliverBox → Widget
-
Available on Widget, provided by the WidgetSliverBoxX extension
no setter - start → Widget
-
Available on Widget, provided by the Alignments extension
no setter - suffixBuilder → Widget? Function(TextEditingController controller, FocusNode focusNode)?
-
Dynamic suffix builder. When provided, suppresses the built-in clear button.
final
- suffixIcon → Widget?
-
Right-side icon. When provided, suppresses the built-in clear button.
final
- textAlign → TextAlign
-
final
- textInputAction → TextInputAction
-
final
- textStyle → TextStyle?
-
final
Methods
-
createElement(
) → StatefulElement -
Creates a StatefulElement to manage this widget's location in the tree.
inherited
-
createState(
) → State< CkSearch> -
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
-
marginAll(
double margin) → Widget -
Available on Widget, provided by the WidgetMarginX extension
-
marginOnly(
{double left = 0.0, double top = 0.0, double right = 0.0, double bottom = 0.0}) → Widget -
Available on Widget, provided by the WidgetMarginX extension
-
marginSymmetric(
{double horizontal = 0.0, double vertical = 0.0}) → Widget -
Available on Widget, provided by the WidgetMarginX extension
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
paddingAll(
double padding) → Widget -
Available on Widget, provided by the WidgetPaddingX extension
-
paddingOnly(
{double left = 0.0, double top = 0.0, double right = 0.0, double bottom = 0.0}) → Widget -
Available on Widget, provided by the WidgetPaddingX extension
-
paddingSymmetric(
{double horizontal = 0.0, double vertical = 0.0}) → Widget -
Available on Widget, provided by the WidgetPaddingX extension
-
toAr(
num width, num height) → Widget -
Available on Widget, provided by the WidgetAspectRatio extension
-
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