packages/flutter/lib/src/cupertino/search_field.dart - mirrors/flutter - Git at Google

 // Copyright 2014 The Flutter Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.

 import 'package:flutter/services.dart';
 import 'package:flutter/widgets.dart';

 import 'button.dart';
 import 'colors.dart';
 import 'icons.dart';
 import 'localizations.dart';
 import 'text_field.dart';

 export 'package:flutter/services.dart' show SmartDashesType, SmartQuotesType;

 /// A [CupertinoTextField] that mimics the look and behavior of UIKit's
 /// `UISearchTextField`.
 ///
 /// This control defaults to showing the basic parts of a `UISearchTextField`,
 /// like the 'Search' placeholder, prefix-ed Search icon, and suffix-ed
 /// X-Mark icon.
 ///
 /// To control the text that is displayed in the text field, use the
 /// [controller]. For example, to set the initial value of the text field, use
 /// a [controller] that already contains some text such as:
 ///
 /// {@tool dartpad}
 /// This examples shows how to provide initial text to a [CupertinoSearchTextField]
 /// using the [controller] property.
 ///
 /// ** See code in examples/api/lib/cupertino/search_field/cupertino_search_field.0.dart **
 /// {@end-tool}
 ///
 /// It is recommended to pass a [ValueChanged<String>] to both [onChanged] and
 /// [onSubmitted] parameters in order to be notified once the value of the
 /// field changes or is submitted by the keyboard:
 ///
 /// {@tool dartpad}
 /// This examples shows how to be notified of field changes or submitted text from
 /// a [CupertinoSearchTextField].
 ///
 /// ** See code in examples/api/lib/cupertino/search_field/cupertino_search_field.1.dart **
 /// {@end-tool}
 ///
 /// See also:
 ///
 ///  * <https://developer.apple.com/design/human-interface-guidelines/ios/bars/search-bars/>
 class CupertinoSearchTextField extends StatefulWidget {
   /// Creates a [CupertinoTextField] that mimics the look and behavior of
   /// UIKit's `UISearchTextField`.
   ///
   /// Similar to [CupertinoTextField], to provide a prefilled text entry, pass
   /// in a [TextEditingController] with an initial value to the [controller]
   /// parameter.
   ///
   /// The [onChanged] parameter takes a [ValueChanged<String>] which is invoked
   /// upon a change in the text field's value.
   ///
   /// The [onSubmitted] parameter takes a [ValueChanged<String>] which is
   /// invoked when the keyboard submits.
   ///
   /// To provide a hint placeholder text that appears when the text entry is
   /// empty, pass a [String] to the [placeholder] parameter. This defaults to
   /// 'Search'.
   // TODO(DanielEdrisian): Localize the 'Search' placeholder.
   ///
   /// The [style] and [placeholderStyle] properties allow changing the style of
   /// the text and placeholder of the text field. [placeholderStyle] defaults
   /// to the gray [CupertinoColors.secondaryLabel] iOS color.
   ///
   /// To set the text field's background color and border radius, pass a
   /// [BoxDecoration] to the [decoration] parameter. This defaults to the
   /// default translucent tertiarySystemFill iOS color and 9 px corner radius.
   // TODO(DanielEdrisian): Must make border radius continuous, see
   // https://github.com/flutter/flutter/issues/13914.
   ///
   /// The [itemColor] and [itemSize] properties allow changing the icon color
   /// and icon size of the search icon (prefix) and X-Mark (suffix).
   /// They default to [CupertinoColors.secondaryLabel] and `20.0`.
   ///
   /// The [padding], [prefixInsets], and [suffixInsets] let you set the padding
   /// insets for text, the search icon (prefix), and the X-Mark icon (suffix).
   /// They default to values that replicate the `UISearchTextField` look. These
   /// default fields were determined using the comparison tool in
   /// https://github.com/flutter/platform_tests/.
   ///
   /// To customize the prefix icon, pass a [Widget] to [prefixIcon]. This
   /// defaults to the search icon.
   ///
   /// To customize the suffix icon, pass an [Icon] to [suffixIcon]. This
   /// defaults to the X-Mark.
   ///
   /// To dictate when the X-Mark (suffix) should be visible, a.k.a. only on when
   /// editing, not editing, on always, or on never, pass a
   /// [OverlayVisibilityMode] to [suffixMode]. This defaults to only on when
   /// editing.
   ///
   /// To customize the X-Mark (suffix) action, pass a [VoidCallback] to
   /// [onSuffixTap]. This defaults to clearing the text.
   const CupertinoSearchTextField({
     super.key,
     this.controller,
     this.onChanged,
     this.onSubmitted,
     this.style,
     this.placeholder,
     this.placeholderStyle,
     this.decoration,
     this.backgroundColor,
     this.borderRadius,
     this.keyboardType = TextInputType.text,
     this.padding = const EdgeInsetsDirectional.fromSTEB(5.5, 8, 5.5, 8),
     this.itemColor = CupertinoColors.secondaryLabel,
     this.itemSize = 20.0,
     this.prefixInsets = const EdgeInsetsDirectional.fromSTEB(6, 0, 0, 3),
     this.prefixIcon = const Icon(CupertinoIcons.search),
     this.suffixInsets = const EdgeInsetsDirectional.fromSTEB(0, 0, 5, 2),
     this.suffixIcon = const Icon(CupertinoIcons.xmark_circle_fill),
     this.suffixMode = OverlayVisibilityMode.editing,
     this.onSuffixTap,
     this.restorationId,
     this.focusNode,
     this.smartQuotesType,
     this.smartDashesType,
     this.enableIMEPersonalizedLearning = true,
     this.autofocus = false,
     this.onTap,
     this.autocorrect = true,
     this.enabled,
   })  : assert(
           !((decoration != null) && (backgroundColor != null)),
           'Cannot provide both a background color and a decoration\n'
           'To provide both, use "decoration: BoxDecoration(color: '
           'backgroundColor)"',
         ),
         assert(
           !((decoration != null) && (borderRadius != null)),
           'Cannot provide both a border radius and a decoration\n'
           'To provide both, use "decoration: BoxDecoration(borderRadius: '
           'borderRadius)"',
         );

   /// Controls the text being edited.
   ///
   /// Similar to [CupertinoTextField], to provide a prefilled text entry, pass
   /// in a [TextEditingController] with an initial value to the [controller]
   /// parameter. Defaults to creating its own [TextEditingController].
   final TextEditingController? controller;

   /// Invoked upon user input.
   final ValueChanged<String>? onChanged;

   /// Invoked upon keyboard submission.
   final ValueChanged<String>? onSubmitted;

   /// Allows changing the style of the text.
   ///
   /// Defaults to the gray [CupertinoColors.secondaryLabel] iOS color.
   final TextStyle? style;

   /// A hint placeholder text that appears when the text entry is empty.
   ///
   /// Defaults to 'Search' localized in each supported language.
   final String? placeholder;

   /// Sets the style of the placeholder of the text field.
   ///
   /// Defaults to the gray [CupertinoColors.secondaryLabel] iOS color.
   final TextStyle? placeholderStyle;

   /// Sets the decoration for the text field.
   ///
   /// This property is automatically set using the [backgroundColor] and
   /// [borderRadius] properties, which both have default values. Therefore,
   /// [decoration] has a default value upon building the widget. It is designed
   /// to mimic the look of a `UISearchTextField`.
   final BoxDecoration? decoration;

   /// Set the [decoration] property's background color.
   ///
   /// Can't be set along with the [decoration]. Defaults to the translucent
   /// [CupertinoColors.tertiarySystemFill] iOS color.
   final Color? backgroundColor;

   /// Sets the [decoration] property's border radius.
   ///
   /// Can't be set along with the [decoration]. Defaults to 9 px circular
   /// corner radius.
   // TODO(DanielEdrisian): Must make border radius continuous, see
   // https://github.com/flutter/flutter/issues/13914.
   final BorderRadius? borderRadius;

   /// The keyboard type for this search field.
   ///
   /// Defaults to [TextInputType.text].
   final TextInputType? keyboardType;

   /// Sets the padding insets for the text and placeholder.
   ///
   /// Cannot be null. Defaults to padding that replicates the
   /// `UISearchTextField` look. The inset values were determined using the
   /// comparison tool in https://github.com/flutter/platform_tests/.
   final EdgeInsetsGeometry padding;

   /// Sets the color for the suffix and prefix icons.
   ///
   /// Cannot be null. Defaults to [CupertinoColors.secondaryLabel].
   final Color itemColor;

   /// Sets the base icon size for the suffix and prefix icons.
   ///
   /// Cannot be null. The size of the icon is scaled using the accessibility
   /// font scale settings. Defaults to `20.0`.
   final double itemSize;

   /// Sets the padding insets for the suffix.
   ///
   /// Cannot be null. Defaults to padding that replicates the
   /// `UISearchTextField` suffix look. The inset values were determined using
   /// the comparison tool in https://github.com/flutter/platform_tests/.
   final EdgeInsetsGeometry prefixInsets;

   /// Sets a prefix widget.
   ///
   /// Cannot be null. Defaults to an [Icon] widget with the [CupertinoIcons.search] icon.
   final Widget prefixIcon;

   /// Sets the padding insets for the prefix.
   ///
   /// Cannot be null. Defaults to padding that replicates the
   /// `UISearchTextField` prefix look. The inset values were determined using
   /// the comparison tool in https://github.com/flutter/platform_tests/.
   final EdgeInsetsGeometry suffixInsets;

   /// Sets the suffix widget's icon.
   ///
   /// Cannot be null. Defaults to the X-Mark [CupertinoIcons.xmark_circle_fill].
   /// "To change the functionality of the suffix icon, provide a custom
   /// onSuffixTap callback and specify an intuitive suffixIcon.
   final Icon suffixIcon;

   /// Dictates when the X-Mark (suffix) should be visible.
   ///
   /// Cannot be null. Defaults to only on when editing.
   final OverlayVisibilityMode suffixMode;

   /// Sets the X-Mark (suffix) action.
   ///
   /// Defaults to clearing the text. The suffix action is customizable
   /// so that users can override it with other functionality, that isn't
   /// necessarily clearing text.
   final VoidCallback? onSuffixTap;

   /// {@macro flutter.material.textfield.restorationId}
   final String? restorationId;

   /// {@macro flutter.widgets.Focus.focusNode}
   final FocusNode? focusNode;

   /// {@macro flutter.widgets.editableText.autofocus}
   final bool autofocus;

   /// {@macro flutter.material.textfield.onTap}
   final VoidCallback? onTap;

   /// {@macro flutter.widgets.editableText.autocorrect}
   final bool autocorrect;

   /// Whether to allow the platform to automatically format quotes.
   ///
   /// This flag only affects iOS, where it is equivalent to [`UITextSmartQuotesType`](https://developer.apple.com/documentation/uikit/uitextsmartquotestype?language=objc).
   ///
   /// When set to [SmartQuotesType.enabled], it passes
   /// [`UITextSmartQuotesTypeYes`](https://developer.apple.com/documentation/uikit/uitextsmartquotestype/uitextsmartquotestypeyes?language=objc),
   /// and when set to [SmartQuotesType.disabled], it passes
   /// [`UITextSmartQuotesTypeNo`](https://developer.apple.com/documentation/uikit/uitextsmartquotestype/uitextsmartquotestypeno?language=objc).
   ///
   /// If set to null, [SmartQuotesType.enabled] will be used.
   ///
   /// As an example of what this does, a standard vertical double quote
   /// character will be automatically replaced by a left or right double quote
   /// depending on its position in a word.
   ///
   /// Defaults to null.
   ///
   /// See also:
   ///
   ///  * [smartDashesType]
   ///  * <https://developer.apple.com/documentation/uikit/uitextinputtraits>
   final SmartQuotesType? smartQuotesType;

   /// Whether to allow the platform to automatically format dashes.
   ///
   /// This flag only affects iOS versions 11 and above, where it is equivalent to [`UITextSmartDashesType`](https://developer.apple.com/documentation/uikit/uitextsmartdashestype?language=objc).
   ///
   /// When set to [SmartDashesType.enabled], it passes
   /// [`UITextSmartDashesTypeYes`](https://developer.apple.com/documentation/uikit/uitextsmartdashestype/uitextsmartdashestypeyes?language=objc),
   /// and when set to [SmartDashesType.disabled], it passes
   /// [`UITextSmartDashesTypeNo`](https://developer.apple.com/documentation/uikit/uitextsmartdashestype/uitextsmartdashestypeno?language=objc).
   ///
   /// If set to null, [SmartDashesType.enabled] will be used.
   ///
   /// As an example of what this does, two consecutive hyphen characters will be
   /// automatically replaced with one en dash, and three consecutive hyphens
   /// will become one em dash.
   ///
   /// Defaults to null.
   ///
   /// See also:
   ///
   ///  * [smartQuotesType]
   ///  * <https://developer.apple.com/documentation/uikit/uitextinputtraits>
   final SmartDashesType? smartDashesType;

   /// {@macro flutter.services.TextInputConfiguration.enableIMEPersonalizedLearning}
   final bool enableIMEPersonalizedLearning;

   /// Disables the text field when false.
   ///
   /// Text fields in disabled states have a light grey background and don't
   /// respond to touch events including the [prefixIcon] and [suffixIcon] button.
   final bool? enabled;

   @override
   State<StatefulWidget> createState() => _CupertinoSearchTextFieldState();
 }

 class _CupertinoSearchTextFieldState extends State<CupertinoSearchTextField>
     with RestorationMixin {
   /// Default value for the border radius. Radius value was determined using the
   /// comparison tool in https://github.com/flutter/platform_tests/.
   final BorderRadius _kDefaultBorderRadius =
       const BorderRadius.all(Radius.circular(9.0));

   RestorableTextEditingController? _controller;

   TextEditingController get _effectiveController =>
       widget.controller ?? _controller!.value;

   @override
   void initState() {
     super.initState();
     if (widget.controller == null) {
       _createLocalController();
     }
   }

   @override
   void didUpdateWidget(CupertinoSearchTextField oldWidget) {
     super.didUpdateWidget(oldWidget);
     if (widget.controller == null && oldWidget.controller != null) {
       _createLocalController(oldWidget.controller!.value);
     } else if (widget.controller != null && oldWidget.controller == null) {
       unregisterFromRestoration(_controller!);
       _controller!.dispose();
       _controller = null;
     }
   }

   @override
   void restoreState(RestorationBucket? oldBucket, bool initialRestore) {
     if (_controller != null) {
       _registerController();
     }
   }

   void _registerController() {
     assert(_controller != null);
     registerForRestoration(_controller!, 'controller');
   }

   void _createLocalController([TextEditingValue? value]) {
     assert(_controller == null);
     _controller = value == null
         ? RestorableTextEditingController()
         : RestorableTextEditingController.fromValue(value);
     if (!restorePending) {
       _registerController();
     }
   }

   @override
   String? get restorationId => widget.restorationId;

   void _defaultOnSuffixTap() {
     final bool textChanged = _effectiveController.text.isNotEmpty;
     _effectiveController.clear();
     if (widget.onChanged != null && textChanged) {
       widget.onChanged!(_effectiveController.text);
     }
   }

   @override
   Widget build(BuildContext context) {
     final String placeholder = widget.placeholder ??
         CupertinoLocalizations.of(context).searchTextFieldPlaceholderLabel;

     final TextStyle placeholderStyle = widget.placeholderStyle ??
         const TextStyle(color: CupertinoColors.systemGrey);

     // The icon size will be scaled by a factor of the accessibility text scale,
     // to follow the behavior of `UISearchTextField`.
     final double scaledIconSize = MediaQuery.textScalerOf(context).textScaleFactor * widget.itemSize;

     // If decoration was not provided, create a decoration with the provided
     // background color and border radius.
     final BoxDecoration decoration = widget.decoration ??
         BoxDecoration(
           color: widget.backgroundColor ?? CupertinoColors.tertiarySystemFill,
           borderRadius: widget.borderRadius ?? _kDefaultBorderRadius,
         );

     final IconThemeData iconThemeData = IconThemeData(
       color: CupertinoDynamicColor.resolve(widget.itemColor, context),
       size: scaledIconSize,
     );

     final Widget prefix = Padding(
       padding: widget.prefixInsets,
       child: IconTheme(
         data: iconThemeData,
         child: widget.prefixIcon,
       ),
     );

     final Widget suffix = Padding(
       padding: widget.suffixInsets,
       child: CupertinoButton(
         onPressed: widget.onSuffixTap ?? _defaultOnSuffixTap,
         minSize: 0,
         padding: EdgeInsets.zero,
         child: IconTheme(
           data: iconThemeData,
           child: widget.suffixIcon,
         ),
       ),
     );

     return CupertinoTextField(
       controller: _effectiveController,
       decoration: decoration,
       style: widget.style,
       prefix: prefix,
       suffix: suffix,
       keyboardType: widget.keyboardType,
       onTap: widget.onTap,
       enabled: widget.enabled,
       suffixMode: widget.suffixMode,
       placeholder: placeholder,
       placeholderStyle: placeholderStyle,
       padding: widget.padding,
       onChanged: widget.onChanged,
       onSubmitted: widget.onSubmitted,
       focusNode: widget.focusNode,
       autofocus: widget.autofocus,
       autocorrect: widget.autocorrect,
       smartQuotesType: widget.smartQuotesType,
       smartDashesType: widget.smartDashesType,
       enableIMEPersonalizedLearning: widget.enableIMEPersonalizedLearning,
       textInputAction: TextInputAction.search,
     );
   }
 }
	// Copyright 2014 The Flutter Authors. All rights reserved.
	// Use of this source code is governed by a BSD-style license that can be
	// found in the LICENSE file.

	import 'package:flutter/services.dart';
	import 'package:flutter/widgets.dart';

	import 'button.dart';
	import 'colors.dart';
	import 'icons.dart';
	import 'localizations.dart';
	import 'text_field.dart';

	export 'package:flutter/services.dart' show SmartDashesType, SmartQuotesType;

	/// A [CupertinoTextField] that mimics the look and behavior of UIKit's
	/// `UISearchTextField`.
	///
	/// This control defaults to showing the basic parts of a `UISearchTextField`,
	/// like the 'Search' placeholder, prefix-ed Search icon, and suffix-ed
	/// X-Mark icon.
	///
	/// To control the text that is displayed in the text field, use the
	/// [controller]. For example, to set the initial value of the text field, use
	/// a [controller] that already contains some text such as:
	///
	/// {@tool dartpad}
	/// This examples shows how to provide initial text to a [CupertinoSearchTextField]
	/// using the [controller] property.
	///
	/// See code in examples/api/lib/cupertino/search_field/cupertino_search_field.0.dart
	/// {@end-tool}
	///
	/// It is recommended to pass a [ValueChanged<String>] to both [onChanged] and
	/// [onSubmitted] parameters in order to be notified once the value of the
	/// field changes or is submitted by the keyboard:
	///
	/// {@tool dartpad}
	/// This examples shows how to be notified of field changes or submitted text from
	/// a [CupertinoSearchTextField].
	///
	/// See code in examples/api/lib/cupertino/search_field/cupertino_search_field.1.dart
	/// {@end-tool}
	///
	/// See also:
	///
	/// * <https://developer.apple.com/design/human-interface-guidelines/ios/bars/search-bars/>
	class CupertinoSearchTextField extends StatefulWidget {
	/// Creates a [CupertinoTextField] that mimics the look and behavior of
	/// UIKit's `UISearchTextField`.
	///
	/// Similar to [CupertinoTextField], to provide a prefilled text entry, pass
	/// in a [TextEditingController] with an initial value to the [controller]
	/// parameter.
	///
	/// The [onChanged] parameter takes a [ValueChanged<String>] which is invoked
	/// upon a change in the text field's value.
	///
	/// The [onSubmitted] parameter takes a [ValueChanged<String>] which is
	/// invoked when the keyboard submits.
	///
	/// To provide a hint placeholder text that appears when the text entry is
	/// empty, pass a [String] to the [placeholder] parameter. This defaults to
	/// 'Search'.
	// TODO(DanielEdrisian): Localize the 'Search' placeholder.
	///
	/// The [style] and [placeholderStyle] properties allow changing the style of
	/// the text and placeholder of the text field. [placeholderStyle] defaults
	/// to the gray [CupertinoColors.secondaryLabel] iOS color.
	///
	/// To set the text field's background color and border radius, pass a
	/// [BoxDecoration] to the [decoration] parameter. This defaults to the
	/// default translucent tertiarySystemFill iOS color and 9 px corner radius.
	// TODO(DanielEdrisian): Must make border radius continuous, see
	// https://github.com/flutter/flutter/issues/13914.
	///
	/// The [itemColor] and [itemSize] properties allow changing the icon color
	/// and icon size of the search icon (prefix) and X-Mark (suffix).
	/// They default to [CupertinoColors.secondaryLabel] and `20.0`.
	///
	/// The [padding], [prefixInsets], and [suffixInsets] let you set the padding
	/// insets for text, the search icon (prefix), and the X-Mark icon (suffix).
	/// They default to values that replicate the `UISearchTextField` look. These
	/// default fields were determined using the comparison tool in
	/// https://github.com/flutter/platform_tests/.
	///
	/// To customize the prefix icon, pass a [Widget] to [prefixIcon]. This
	/// defaults to the search icon.
	///
	/// To customize the suffix icon, pass an [Icon] to [suffixIcon]. This
	/// defaults to the X-Mark.
	///
	/// To dictate when the X-Mark (suffix) should be visible, a.k.a. only on when
	/// editing, not editing, on always, or on never, pass a
	/// [OverlayVisibilityMode] to [suffixMode]. This defaults to only on when
	/// editing.
	///
	/// To customize the X-Mark (suffix) action, pass a [VoidCallback] to
	/// [onSuffixTap]. This defaults to clearing the text.
	const CupertinoSearchTextField({
	super.key,
	this.controller,
	this.onChanged,
	this.onSubmitted,
	this.style,
	this.placeholder,
	this.placeholderStyle,
	this.decoration,
	this.backgroundColor,
	this.borderRadius,
	this.keyboardType = TextInputType.text,
	this.padding = const EdgeInsetsDirectional.fromSTEB(5.5, 8, 5.5, 8),
	this.itemColor = CupertinoColors.secondaryLabel,
	this.itemSize = 20.0,
	this.prefixInsets = const EdgeInsetsDirectional.fromSTEB(6, 0, 0, 3),
	this.prefixIcon = const Icon(CupertinoIcons.search),
	this.suffixInsets = const EdgeInsetsDirectional.fromSTEB(0, 0, 5, 2),
	this.suffixIcon = const Icon(CupertinoIcons.xmark_circle_fill),
	this.suffixMode = OverlayVisibilityMode.editing,
	this.onSuffixTap,
	this.restorationId,
	this.focusNode,
	this.smartQuotesType,
	this.smartDashesType,
	this.enableIMEPersonalizedLearning = true,
	this.autofocus = false,
	this.onTap,
	this.autocorrect = true,
	this.enabled,
	}) : assert(
	!((decoration != null) && (backgroundColor != null)),
	'Cannot provide both a background color and a decoration\n'
	'To provide both, use "decoration: BoxDecoration(color: '
	'backgroundColor)"',
	),
	assert(
	!((decoration != null) && (borderRadius != null)),
	'Cannot provide both a border radius and a decoration\n'
	'To provide both, use "decoration: BoxDecoration(borderRadius: '
	'borderRadius)"',
	);

	/// Controls the text being edited.
	///
	/// Similar to [CupertinoTextField], to provide a prefilled text entry, pass
	/// in a [TextEditingController] with an initial value to the [controller]
	/// parameter. Defaults to creating its own [TextEditingController].
	final TextEditingController? controller;

	/// Invoked upon user input.
	final ValueChanged<String>? onChanged;

	/// Invoked upon keyboard submission.
	final ValueChanged<String>? onSubmitted;

	/// Allows changing the style of the text.
	///
	/// Defaults to the gray [CupertinoColors.secondaryLabel] iOS color.
	final TextStyle? style;

	/// A hint placeholder text that appears when the text entry is empty.
	///
	/// Defaults to 'Search' localized in each supported language.
	final String? placeholder;

	/// Sets the style of the placeholder of the text field.
	///
	/// Defaults to the gray [CupertinoColors.secondaryLabel] iOS color.
	final TextStyle? placeholderStyle;

	/// Sets the decoration for the text field.
	///
	/// This property is automatically set using the [backgroundColor] and
	/// [borderRadius] properties, which both have default values. Therefore,
	/// [decoration] has a default value upon building the widget. It is designed
	/// to mimic the look of a `UISearchTextField`.
	final BoxDecoration? decoration;

	/// Set the [decoration] property's background color.
	///
	/// Can't be set along with the [decoration]. Defaults to the translucent
	/// [CupertinoColors.tertiarySystemFill] iOS color.
	final Color? backgroundColor;

	/// Sets the [decoration] property's border radius.
	///
	/// Can't be set along with the [decoration]. Defaults to 9 px circular
	/// corner radius.
	// TODO(DanielEdrisian): Must make border radius continuous, see
	// https://github.com/flutter/flutter/issues/13914.
	final BorderRadius? borderRadius;

	/// The keyboard type for this search field.
	///
	/// Defaults to [TextInputType.text].
	final TextInputType? keyboardType;

	/// Sets the padding insets for the text and placeholder.
	///
	/// Cannot be null. Defaults to padding that replicates the
	/// `UISearchTextField` look. The inset values were determined using the
	/// comparison tool in https://github.com/flutter/platform_tests/.
	final EdgeInsetsGeometry padding;

	/// Sets the color for the suffix and prefix icons.
	///
	/// Cannot be null. Defaults to [CupertinoColors.secondaryLabel].
	final Color itemColor;

	/// Sets the base icon size for the suffix and prefix icons.
	///
	/// Cannot be null. The size of the icon is scaled using the accessibility
	/// font scale settings. Defaults to `20.0`.
	final double itemSize;

	/// Sets the padding insets for the suffix.
	///
	/// Cannot be null. Defaults to padding that replicates the
	/// `UISearchTextField` suffix look. The inset values were determined using
	/// the comparison tool in https://github.com/flutter/platform_tests/.
	final EdgeInsetsGeometry prefixInsets;

	/// Sets a prefix widget.
	///
	/// Cannot be null. Defaults to an [Icon] widget with the [CupertinoIcons.search] icon.
	final Widget prefixIcon;

	/// Sets the padding insets for the prefix.
	///
	/// Cannot be null. Defaults to padding that replicates the
	/// `UISearchTextField` prefix look. The inset values were determined using
	/// the comparison tool in https://github.com/flutter/platform_tests/.
	final EdgeInsetsGeometry suffixInsets;

	/// Sets the suffix widget's icon.
	///
	/// Cannot be null. Defaults to the X-Mark [CupertinoIcons.xmark_circle_fill].
	/// "To change the functionality of the suffix icon, provide a custom
	/// onSuffixTap callback and specify an intuitive suffixIcon.
	final Icon suffixIcon;

	/// Dictates when the X-Mark (suffix) should be visible.
	///
	/// Cannot be null. Defaults to only on when editing.
	final OverlayVisibilityMode suffixMode;

	/// Sets the X-Mark (suffix) action.
	///
	/// Defaults to clearing the text. The suffix action is customizable
	/// so that users can override it with other functionality, that isn't
	/// necessarily clearing text.
	final VoidCallback? onSuffixTap;

	/// {@macro flutter.material.textfield.restorationId}
	final String? restorationId;

	/// {@macro flutter.widgets.Focus.focusNode}
	final FocusNode? focusNode;

	/// {@macro flutter.widgets.editableText.autofocus}
	final bool autofocus;

	/// {@macro flutter.material.textfield.onTap}
	final VoidCallback? onTap;

	/// {@macro flutter.widgets.editableText.autocorrect}
	final bool autocorrect;

	/// Whether to allow the platform to automatically format quotes.
	///
	/// This flag only affects iOS, where it is equivalent to [`UITextSmartQuotesType`](https://developer.apple.com/documentation/uikit/uitextsmartquotestype?language=objc).
	///
	/// When set to [SmartQuotesType.enabled], it passes
	/// [`UITextSmartQuotesTypeYes`](https://developer.apple.com/documentation/uikit/uitextsmartquotestype/uitextsmartquotestypeyes?language=objc),
	/// and when set to [SmartQuotesType.disabled], it passes
	/// [`UITextSmartQuotesTypeNo`](https://developer.apple.com/documentation/uikit/uitextsmartquotestype/uitextsmartquotestypeno?language=objc).
	///
	/// If set to null, [SmartQuotesType.enabled] will be used.
	///
	/// As an example of what this does, a standard vertical double quote
	/// character will be automatically replaced by a left or right double quote
	/// depending on its position in a word.
	///
	/// Defaults to null.
	///
	/// See also:
	///
	/// * [smartDashesType]
	/// * <https://developer.apple.com/documentation/uikit/uitextinputtraits>
	final SmartQuotesType? smartQuotesType;

	/// Whether to allow the platform to automatically format dashes.
	///
	/// This flag only affects iOS versions 11 and above, where it is equivalent to [`UITextSmartDashesType`](https://developer.apple.com/documentation/uikit/uitextsmartdashestype?language=objc).
	///
	/// When set to [SmartDashesType.enabled], it passes
	/// [`UITextSmartDashesTypeYes`](https://developer.apple.com/documentation/uikit/uitextsmartdashestype/uitextsmartdashestypeyes?language=objc),
	/// and when set to [SmartDashesType.disabled], it passes
	/// [`UITextSmartDashesTypeNo`](https://developer.apple.com/documentation/uikit/uitextsmartdashestype/uitextsmartdashestypeno?language=objc).
	///
	/// If set to null, [SmartDashesType.enabled] will be used.
	///
	/// As an example of what this does, two consecutive hyphen characters will be
	/// automatically replaced with one en dash, and three consecutive hyphens
	/// will become one em dash.
	///
	/// Defaults to null.
	///
	/// See also:
	///
	/// * [smartQuotesType]
	/// * <https://developer.apple.com/documentation/uikit/uitextinputtraits>
	final SmartDashesType? smartDashesType;

	/// {@macro flutter.services.TextInputConfiguration.enableIMEPersonalizedLearning}
	final bool enableIMEPersonalizedLearning;

	/// Disables the text field when false.
	///
	/// Text fields in disabled states have a light grey background and don't
	/// respond to touch events including the [prefixIcon] and [suffixIcon] button.
	final bool? enabled;

	@override
	State<StatefulWidget> createState() => _CupertinoSearchTextFieldState();
	}

	class _CupertinoSearchTextFieldState extends State<CupertinoSearchTextField>
	with RestorationMixin {
	/// Default value for the border radius. Radius value was determined using the
	/// comparison tool in https://github.com/flutter/platform_tests/.
	final BorderRadius _kDefaultBorderRadius =
	const BorderRadius.all(Radius.circular(9.0));

	RestorableTextEditingController? _controller;

	TextEditingController get _effectiveController =>
	widget.controller ?? _controller!.value;

	@override
	void initState() {
	super.initState();
	if (widget.controller == null) {
	_createLocalController();
	}
	}

	@override
	void didUpdateWidget(CupertinoSearchTextField oldWidget) {
	super.didUpdateWidget(oldWidget);
	if (widget.controller == null && oldWidget.controller != null) {
	_createLocalController(oldWidget.controller!.value);
	} else if (widget.controller != null && oldWidget.controller == null) {
	unregisterFromRestoration(_controller!);
	_controller!.dispose();
	_controller = null;
	}
	}

	@override
	void restoreState(RestorationBucket? oldBucket, bool initialRestore) {
	if (_controller != null) {
	_registerController();
	}
	}

	void _registerController() {
	assert(_controller != null);
	registerForRestoration(_controller!, 'controller');
	}

	void _createLocalController([TextEditingValue? value]) {
	assert(_controller == null);
	_controller = value == null
	? RestorableTextEditingController()
	: RestorableTextEditingController.fromValue(value);
	if (!restorePending) {
	_registerController();
	}
	}

	@override
	String? get restorationId => widget.restorationId;

	void _defaultOnSuffixTap() {
	final bool textChanged = _effectiveController.text.isNotEmpty;
	_effectiveController.clear();
	if (widget.onChanged != null && textChanged) {
	widget.onChanged!(_effectiveController.text);
	}
	}

	@override
	Widget build(BuildContext context) {
	final String placeholder = widget.placeholder ??
	CupertinoLocalizations.of(context).searchTextFieldPlaceholderLabel;

	final TextStyle placeholderStyle = widget.placeholderStyle ??
	const TextStyle(color: CupertinoColors.systemGrey);

	// The icon size will be scaled by a factor of the accessibility text scale,
	// to follow the behavior of `UISearchTextField`.
	final double scaledIconSize = MediaQuery.textScalerOf(context).textScaleFactor * widget.itemSize;

	// If decoration was not provided, create a decoration with the provided
	// background color and border radius.
	final BoxDecoration decoration = widget.decoration ??
	BoxDecoration(
	color: widget.backgroundColor ?? CupertinoColors.tertiarySystemFill,
	borderRadius: widget.borderRadius ?? _kDefaultBorderRadius,
	);

	final IconThemeData iconThemeData = IconThemeData(
	color: CupertinoDynamicColor.resolve(widget.itemColor, context),
	size: scaledIconSize,
	);

	final Widget prefix = Padding(
	padding: widget.prefixInsets,
	child: IconTheme(
	data: iconThemeData,
	child: widget.prefixIcon,
	),
	);

	final Widget suffix = Padding(
	padding: widget.suffixInsets,
	child: CupertinoButton(
	onPressed: widget.onSuffixTap ?? _defaultOnSuffixTap,
	minSize: 0,
	padding: EdgeInsets.zero,
	child: IconTheme(
	data: iconThemeData,
	child: widget.suffixIcon,
	),
	),
	);

	return CupertinoTextField(
	controller: _effectiveController,
	decoration: decoration,
	style: widget.style,
	prefix: prefix,
	suffix: suffix,
	keyboardType: widget.keyboardType,
	onTap: widget.onTap,
	enabled: widget.enabled,
	suffixMode: widget.suffixMode,
	placeholder: placeholder,
	placeholderStyle: placeholderStyle,
	padding: widget.padding,
	onChanged: widget.onChanged,
	onSubmitted: widget.onSubmitted,
	focusNode: widget.focusNode,
	autofocus: widget.autofocus,
	autocorrect: widget.autocorrect,
	smartQuotesType: widget.smartQuotesType,
	smartDashesType: widget.smartDashesType,
	enableIMEPersonalizedLearning: widget.enableIMEPersonalizedLearning,
	textInputAction: TextInputAction.search,
	);
	}
	}