RCupertinoTextField#

Cupertino-styled text field with DX-friendly API.

A convenience wrapper around RTextField that provides Cupertino-specific defaults and exposes Cupertino-specific properties directly.

Defaults:

• clearButtonMode = RTextFieldOverlayVisibilityMode.whileEditing
• prefixMode = RTextFieldOverlayVisibilityMode.always
• suffixMode = RTextFieldOverlayVisibilityMode.always
• isBorderless = false

Constructors#

RCupertinoTextField()#

RCupertinoTextField({
  super.key,
  this.value,
  this.controller,
  this.onChanged,
  this.onSubmitted,
  this.onEditingComplete,
  this.onTapOutside,
  this.placeholder,
  this.label,
  this.helperText,
  this.errorText,
  this.prefix,
  this.suffix,
  this.obscureText = false,
  this.enabled = true,
  this.readOnly = false,
  this.autofocus = false,
  this.focusNode,
  this.keyboardType,
  this.textInputAction,
  this.textCapitalization = TextCapitalization.none,
  this.autocorrect = true,
  this.enableSuggestions = true,
  this.smartDashesType,
  this.smartQuotesType,
  this.maxLines = 1,
  this.minLines,
  this.maxLength,
  this.maxLengthEnforcement,
  this.showCursor,
  this.keyboardAppearance,
  this.scrollPadding = const EdgeInsets.all(20.0),
  this.dragStartBehavior = DragStartBehavior.start,
  this.enableInteractiveSelection,
  this.inputFormatters,
  this.clearButtonMode = RTextFieldOverlayVisibilityMode.whileEditing,
  this.prefixMode = RTextFieldOverlayVisibilityMode.always,
  this.suffixMode = RTextFieldOverlayVisibilityMode.always,
  this.padding,
  this.isBorderless = false,
  this.style,
  this.overrides,
}) {
  if (value != null && controller != null) {
    throw ArgumentError(
      'Cannot provide both value and controller. '
      'Use either controlled mode (value + onChanged) or '
      'controller-driven mode (controller only).',
    );
  }
}

RCupertinoTextField.borderless() factory#

Creates a borderless Cupertino text field.

This is a convenience constructor that sets isBorderless to true.

factory RCupertinoTextField.borderless({
  Key? key,
  String? value,
  TextEditingController? controller,
  ValueChanged<String>? onChanged,
  ValueChanged<String>? onSubmitted,
  VoidCallback? onEditingComplete,
  TapRegionCallback? onTapOutside,
  String? placeholder,
  String? label,
  String? helperText,
  String? errorText,
  Widget? prefix,
  Widget? suffix,
  bool obscureText = false,
  bool enabled = true,
  bool readOnly = false,
  bool autofocus = false,
  FocusNode? focusNode,
  TextInputType? keyboardType,
  TextInputAction? textInputAction,
  TextCapitalization textCapitalization = TextCapitalization.none,
  bool autocorrect = true,
  bool enableSuggestions = true,
  SmartDashesType? smartDashesType,
  SmartQuotesType? smartQuotesType,
  int? maxLines = 1,
  int? minLines,
  int? maxLength,
  MaxLengthEnforcement? maxLengthEnforcement,
  bool? showCursor,
  Brightness? keyboardAppearance,
  EdgeInsets scrollPadding = const EdgeInsets.all(20.0),
  DragStartBehavior dragStartBehavior = DragStartBehavior.start,
  bool? enableInteractiveSelection,
  List<TextInputFormatter>? inputFormatters,
  RTextFieldOverlayVisibilityMode clearButtonMode =
      RTextFieldOverlayVisibilityMode.whileEditing,
  RTextFieldOverlayVisibilityMode prefixMode =
      RTextFieldOverlayVisibilityMode.always,
  RTextFieldOverlayVisibilityMode suffixMode =
      RTextFieldOverlayVisibilityMode.always,
  EdgeInsetsGeometry? padding,
  RTextFieldStyle? style,
  RenderOverrides? overrides,
}) {
  return RCupertinoTextField(
    key: key,
    value: value,
    controller: controller,
    onChanged: onChanged,
    onSubmitted: onSubmitted,
    onEditingComplete: onEditingComplete,
    onTapOutside: onTapOutside,
    placeholder: placeholder,
    label: label,
    helperText: helperText,
    errorText: errorText,
    prefix: prefix,
    suffix: suffix,
    obscureText: obscureText,
    enabled: enabled,
    readOnly: readOnly,
    autofocus: autofocus,
    focusNode: focusNode,
    keyboardType: keyboardType,
    textInputAction: textInputAction,
    textCapitalization: textCapitalization,
    autocorrect: autocorrect,
    enableSuggestions: enableSuggestions,
    smartDashesType: smartDashesType,
    smartQuotesType: smartQuotesType,
    maxLines: maxLines,
    minLines: minLines,
    maxLength: maxLength,
    maxLengthEnforcement: maxLengthEnforcement,
    showCursor: showCursor,
    keyboardAppearance: keyboardAppearance,
    scrollPadding: scrollPadding,
    dragStartBehavior: dragStartBehavior,
    enableInteractiveSelection: enableInteractiveSelection,
    inputFormatters: inputFormatters,
    clearButtonMode: clearButtonMode,
    prefixMode: prefixMode,
    suffixMode: suffixMode,
    padding: padding,
    isBorderless: true,
    style: style,
    overrides: overrides,
  );
}

Properties#

autocorrect final#

final bool autocorrect;

autofocus final#

final bool autofocus;

clearButtonMode final#

Visibility mode for the clear button.

Default is RTextFieldOverlayVisibilityMode.whileEditing (Cupertino default).

final RTextFieldOverlayVisibilityMode clearButtonMode;

controller final#

final TextEditingController? controller;

dragStartBehavior final#

final DragStartBehavior dragStartBehavior;

enabled final#

final bool enabled;

enableInteractiveSelection final#

final bool? enableInteractiveSelection;

enableSuggestions final#

final bool enableSuggestions;

errorText final#

final String? errorText;

focusNode final#

final FocusNode? focusNode;

hashCode no setter inherited#

The hash code for this object.

A hash code is a single integer which represents the state of the object that affects operator == comparisons.

All objects have hash codes. The default hash code implemented by Object represents only the identity of the object, the same way as the default operator == implementation only considers objects equal if they are identical (see identityHashCode).

If operator == is overridden to use the object state instead, the hash code must also be changed to represent that state, otherwise the object cannot be used in hash based data structures like the default Set and Map implementations.

Hash codes must be the same for objects that are equal to each other according to operator ==. The hash code of an object should only change if the object changes in a way that affects equality. There are no further requirements for the hash codes. They need not be consistent between executions of the same program and there are no distribution guarantees.

Objects that are not equal are allowed to have the same hash code. It is even technically allowed that all instances have the same hash code, but if clashes happen too often, it may reduce the efficiency of hash-based data structures like HashSet or HashMap.

If a subclass overrides hashCode, it should override the operator == operator as well to maintain consistency.

Inherited from Object.

external int get hashCode;

helperText final#

final String? helperText;

inputFormatters final#

final List<TextInputFormatter>? inputFormatters;

isBorderless final#

Whether to render without a visible border.

When true, the text field blends with its background.

final bool isBorderless;

keyboardAppearance final#

final Brightness? keyboardAppearance;

keyboardType final#

final TextInputType? keyboardType;

label final#

final String? label;

maxLength final#

final int? maxLength;

maxLengthEnforcement final#

final MaxLengthEnforcement? maxLengthEnforcement;

maxLines final#

final int? maxLines;

minLines final#

final int? minLines;

obscureText final#

final bool obscureText;

onChanged final#

final ValueChanged<String>? onChanged;

onEditingComplete final#

final VoidCallback? onEditingComplete;

onSubmitted final#

final ValueChanged<String>? onSubmitted;

onTapOutside final#

final TapRegionCallback? onTapOutside;

overrides final#

Advanced per-instance overrides.

final RenderOverrides? overrides;

padding final#

Custom padding for the text field container.

Overrides the default iOS 7px padding.

final EdgeInsetsGeometry? padding;

placeholder final#

final String? placeholder;

prefix final#

Widget to display before text inside the input.

final Widget? prefix;

prefixMode final#

Visibility mode for the prefix widget.

final RTextFieldOverlayVisibilityMode prefixMode;

readOnly final#

final bool readOnly;

runtimeType no setter inherited#

A representation of the runtime type of the object.

Inherited from Object.

external Type get runtimeType;

scrollPadding final#

final EdgeInsets scrollPadding;

showCursor final#

final bool? showCursor;

smartDashesType final#

final SmartDashesType? smartDashesType;

smartQuotesType final#

final SmartQuotesType? smartQuotesType;

style final#

Style sugar for common token overrides.

final RTextFieldStyle? style;

suffix final#

Widget to display after text inside the input.

final Widget? suffix;

suffixMode final#

Visibility mode for the suffix widget.

final RTextFieldOverlayVisibilityMode suffixMode;

textCapitalization final#

final TextCapitalization textCapitalization;

textInputAction final#

final TextInputAction? textInputAction;

value final#

final String? value;

Methods#

build()#

@override
Widget build(BuildContext context) {
  // Build Cupertino-specific overrides
  final cupertinoOverrides = CupertinoTextFieldOverrides(
    padding: padding,
    isBorderless: isBorderless,
  );

  // Merge overrides
  final baseOverrides = RenderOverrides.only(cupertinoOverrides);
  final effectiveOverrides =
      overrides != null ? baseOverrides.merge(overrides!) : baseOverrides;

  // Build slots
  final slots = (prefix != null || suffix != null)
      ? RTextFieldSlots(prefix: prefix, suffix: suffix)
      : null;

  return RTextField(
    value: value,
    controller: controller,
    onChanged: onChanged,
    onSubmitted: onSubmitted,
    onEditingComplete: onEditingComplete,
    onTapOutside: onTapOutside,
    placeholder: placeholder,
    label: label,
    helperText: helperText,
    errorText: errorText,
    obscureText: obscureText,
    enabled: enabled,
    readOnly: readOnly,
    autofocus: autofocus,
    focusNode: focusNode,
    keyboardType: keyboardType,
    textInputAction: textInputAction,
    textCapitalization: textCapitalization,
    autocorrect: autocorrect,
    enableSuggestions: enableSuggestions,
    smartDashesType: smartDashesType,
    smartQuotesType: smartQuotesType,
    maxLines: maxLines,
    minLines: minLines,
    maxLength: maxLength,
    maxLengthEnforcement: maxLengthEnforcement,
    showCursor: showCursor,
    keyboardAppearance: keyboardAppearance,
    scrollPadding: scrollPadding,
    dragStartBehavior: dragStartBehavior,
    enableInteractiveSelection: enableInteractiveSelection,
    inputFormatters: inputFormatters,
    clearButtonMode: clearButtonMode,
    prefixMode: prefixMode,
    suffixMode: suffixMode,
    style: style,
    slots: slots,
    overrides: effectiveOverrides,
  );
}

noSuchMethod() inherited#

Invoked when a nonexistent method or property is accessed.

A dynamic member invocation can attempt to call a member which doesn't exist on the receiving object. Example:

dynamic object = 1;
object.add(42); // Statically allowed, run-time error

This invalid code will invoke the noSuchMethod method of the integer 1 with an Invocation representing the .add(42) call and arguments (which then throws).

Classes can override noSuchMethod to provide custom behavior for such invalid dynamic invocations.

A class with a non-default noSuchMethod invocation can also omit implementations for members of its interface. Example:

class MockList<T> implements List<T> {
  noSuchMethod(Invocation invocation) {
    log(invocation);
    super.noSuchMethod(invocation); // Will throw.
  }
}
void main() {
  MockList().add(42);
}

This code has no compile-time warnings or errors even though the MockList class has no concrete implementation of any of the List interface methods. Calls to List methods are forwarded to noSuchMethod, so this code will log an invocation similar to Invocation.method(#add, [42]) and then throw.

If a value is returned from noSuchMethod, it becomes the result of the original invocation. If the value is not of a type that can be returned by the original invocation, a type error occurs at the invocation.

The default behavior is to throw a NoSuchMethodError.

Inherited from Object.

@pragma("vm:entry-point")
@pragma("wasm:entry-point")
external dynamic noSuchMethod(Invocation invocation);

toString() inherited#

A string representation of this object.

Some classes have a default textual representation, often paired with a static parse function (like int.parse). These classes will provide the textual representation as their string representation.

Other classes have no meaningful textual representation that a program will care about. Such classes will typically override toString to provide useful information when inspecting the object, mainly for debugging or logging.

Inherited from Object.

external String toString();

Operators#

operator ==() inherited#

The equality operator.

The default behavior for all Objects is to return true if and only if this object and other are the same object.

Override this method to specify a different equality relation on a class. The overriding method must still be an equivalence relation. That is, it must be:

• Total: It must return a boolean for all arguments. It should never throw.

• Reflexive: For all objects o, o == o must be true.

• Symmetric: For all objects o1 and o2, o1 == o2 and o2 == o1 must either both be true, or both be false.

• Transitive: For all objects o1, o2, and o3, if o1 == o2 and o2 == o3 are true, then o1 == o3 must be true.

The method should also be consistent over time, so whether two objects are equal should only change if at least one of the objects was modified.

If a subclass overrides the equality operator, it should override the hashCode method as well to maintain consistency.

Inherited from Object.

external bool operator ==(Object other);