SundayCupertinoTextField class

A Cupertino-style text field for the Sunday UI framework.

Inheritance

Constructors

SundayCupertinoTextField({Key? key, String? placeholder, TextEditingController? controller, ValueChanged<String>? onChanged, TextInputType? keyboardType, bool obscureText = false, BoxDecoration? decoration, required Style style, TextStyle? textFieldstyle, bool? autocorrect, Iterable<String>? autofillHints, bool? autofocus, OverlayVisibilityMode? clearButtonMode, String? clearButtonSemanticLabel, Clip? clipBehavior, ContentInsertionConfiguration? contentInsertionConfiguration, EditableTextContextMenuBuilder? contextMenuBuilder, Color? cursorColor, double? cursorHeight, bool? cursorOpacityAnimates, Radius? cursorRadius, double? cursorWidth, DragStartBehavior? dragStartBehavior, bool? enabled, bool? enableIMEPersonalizedLearning, bool? enableInteractiveSelection, bool? enableSuggestions, bool? expands, FocusNode? focusNode, Object? groupId, List<TextInputFormatter>? inputFormatters, Brightness? keyboardAppearance, TextMagnifierConfiguration? magnifierConfiguration, int? maxLength, MaxLengthEnforcement? maxLengthEnforcement, int? maxLines, int? minLines, String? obscuringCharacter, VoidCallback? onEditingComplete, ValueChanged<String>? onSubmitted, GestureTapCallback? onTap, TapRegionCallback? onTapOutside, EdgeInsetsGeometry? padding, TextStyle? placeholderStyle, Widget? prefix, OverlayVisibilityMode? prefixMode, bool? readOnly, String? restorationId, bool? scribbleEnabled, ScrollController? scrollController, EdgeInsets? scrollPadding, ScrollPhysics? scrollPhysics, TextSelectionControls? selectionControls, BoxHeightStyle? selectionHeightStyle, BoxWidthStyle? selectionWidthStyle, bool? showCursor, SmartDashesType? smartDashesType, SmartQuotesType? smartQuotesType, SpellCheckConfiguration? spellCheckConfiguration, StrutStyle? strutStyle, Widget? suffix, OverlayVisibilityMode? suffixMode, TextAlign? textAlign, TextAlignVertical? textAlignVertical, TextCapitalization? textCapitalization, TextDirection? textDirection, TextInputAction? textInputAction, UndoHistoryController? undoController, ValueChanged<bool>? onFocusChange, bool showClearButton = false})
Constructs a SundayCupertinoTextField with the given properties.
const

Properties

autocorrect bool?
Whether to enable autocorrection.
final
autofillHints Iterable<String>?
A list of strings that helps the autofill service identify the type of this text input.
final
autofocus bool?
Whether this text field should focus itself if nothing else is already focused.
final
clearButtonMode OverlayVisibilityMode?
Show an iOS-style clear button to clear the current text entry.
final
clearButtonSemanticLabel String?
The semantic label for the clear button used by screen readers.
final
clipBehavior Clip?
The content will be clipped (or not) according to this option.
final
contentInsertionConfiguration ContentInsertionConfiguration?
Configuration of handler for media content inserted via the system input method.
final
contextMenuBuilder EditableTextContextMenuBuilder?
Builds the text selection toolbar when requested by the user.
final
controller TextEditingController?
Controls the text being edited.
final
cursorColor Color?
The color to use when painting the cursor.
final
cursorHeight double?
How tall the cursor will be.
final
cursorOpacityAnimates bool?
Whether the cursor will animate from fully transparent to fully opaque during each cursor blink.
final
cursorRadius Radius?
How rounded the corners of the cursor should be.
final
cursorWidth double?
How thick the cursor will be.
final
decoration BoxDecoration?
Controls the BoxDecoration of the box behind the text input.
final
dragStartBehavior DragStartBehavior?
Determines the way that drag start behavior is handled.
final
enabled bool?
Disables the text field when false.
final
enableIMEPersonalizedLearning bool?
Whether to enable that the IME update personalized data such as typing history and user dictionary data.
final
enableInteractiveSelection bool?
Whether to enable user interface affordances for changing the text selection.
final
enableSuggestions bool?
Whether to show input suggestions as the user types.
final
expands bool?
Whether this widget's height will be sized to fill its parent.
final
focusNode FocusNode?
An optional focus node to use as the focus node for this widget.
final
groupId Object?
The group identifier for the TextFieldTapRegion of this text field.
final
hashCode int
The hash code for this object.
no setterinherited
inputFormatters List<TextInputFormatter>?
Optional input validation and formatting overrides.
final
key Key?
Controls how one widget replaces another widget in the tree.
finalinherited
keyboardAppearance Brightness?
The appearance of the keyboard.
final
keyboardType TextInputType?
The type of keyboard to use for editing the text.
final
magnifierConfiguration TextMagnifierConfiguration?
Configuration for the text field magnifier.
final
maxLength int?
The maximum number of characters to allow in the text field.
final
maxLengthEnforcement MaxLengthEnforcement?
Determines how the maxLength limit should be enforced.
final
maxLines int?
The maximum number of lines to show at one time, wrapping if necessary.
final
minLines int?
The minimum number of lines to occupy when the content spans fewer lines.
final
obscureText bool
Whether to hide the text being edited (e.g., for passwords).
final
obscuringCharacter String?
Character used for obscuring text if obscureText is true.
final
onChanged ValueChanged<String>?
Called when the user initiates a change to the TextField's value.
final
onEditingComplete VoidCallback?
Called when the user submits editable content.
final
onFocusChange ValueChanged<bool>?
Called when the text field gains or loses focus.
final
onSubmitted ValueChanged<String>?
Called when the user indicates they are done editing the text.
final
onTap GestureTapCallback?
Called for the first tap in a series of taps.
final
onTapOutside TapRegionCallback?
Called for each tap outside when the text field is focused.
final
padding EdgeInsetsGeometry?
Padding around the text entry area.
final
placeholder String?
A lighter colored placeholder hint.
final
placeholderStyle TextStyle?
The style to use for the placeholder text.
final
prefix Widget?
An optional Widget to display before the text.
final
prefixMode OverlayVisibilityMode?
Controls the visibility of the prefix widget.
final
readOnly bool?
Whether the text can be changed.
final
restorationId String?
Restoration ID to save and restore the state.
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
scribbleEnabled bool?
Whether iOS 14 Scribble features are enabled.
final
scrollController ScrollController?
The ScrollController to use when vertically scrolling.
final
scrollPadding EdgeInsets?
Configures padding to edges surrounding a Scrollable.
final
scrollPhysics ScrollPhysics?
The ScrollPhysics to use when vertically scrolling.
final
selectionControls TextSelectionControls?
Optional delegate for building text selection handles.
final
selectionHeightStyle BoxHeightStyle?
Controls how tall the selection highlight boxes are.
final
selectionWidthStyle BoxWidthStyle?
Controls how wide the selection highlight boxes are.
final
showClearButton bool
Whether to show a clear button when not empty.
final
showCursor bool?
Whether to show cursor.
final
smartDashesType SmartDashesType?
Whether to allow automatic dash formatting.
final
smartQuotesType SmartQuotesType?
Whether to allow automatic quote formatting.
final
spellCheckConfiguration SpellCheckConfiguration?
Configuration for spell check.
final
strutStyle StrutStyle?
The strut style for vertical layout.
final
style Style
The style to use for this text field.
final
suffix Widget?
An optional Widget to display after the text.
final
suffixMode OverlayVisibilityMode?
Controls the visibility of the suffix widget.
final
textAlign TextAlign?
How the text should be aligned horizontally.
final
textAlignVertical TextAlignVertical?
How the text should be aligned vertically.
final
textCapitalization TextCapitalization?
Configures the keyboard's uppercase/lowercase selection.
final
textDirection TextDirection?
The directionality of the text.
final
textFieldstyle TextStyle?
The style to use for the text being edited.
final
textInputAction TextInputAction?
The type of action button for the keyboard.
final
undoController UndoHistoryController?
Controls the undo state.
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, 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