InputDecoration constructor

const InputDecoration({
  1. Widget? icon,
  2. Color? iconColor,
  3. Widget? label,
  4. String? labelText,
  5. TextStyle? labelStyle,
  6. TextStyle? floatingLabelStyle,
  7. Widget? helper,
  8. String? helperText,
  9. TextStyle? helperStyle,
  10. int? helperMaxLines,
  11. String? hintText,
  12. Widget? hint,
  13. TextStyle? hintStyle,
  14. TextDirection? hintTextDirection,
  15. int? hintMaxLines,
  16. Duration? hintFadeDuration,
  17. @Deprecated('Use maintainHintSize instead. ' 'This will maintain both hint height and hint width. ' 'This feature was deprecated after v3.28.0-2.0.pre.') bool maintainHintHeight = true,
  18. bool maintainHintSize = true,
  19. Widget? error,
  20. String? errorText,
  21. TextStyle? errorStyle,
  22. int? errorMaxLines,
  23. FloatingLabelBehavior? floatingLabelBehavior,
  24. FloatingLabelAlignment? floatingLabelAlignment,
  25. bool? isCollapsed,
  26. bool? isDense,
  27. EdgeInsetsGeometry? contentPadding,
  28. Widget? prefixIcon,
  29. BoxConstraints? prefixIconConstraints,
  30. Widget? prefix,
  31. String? prefixText,
  32. TextStyle? prefixStyle,
  33. Color? prefixIconColor,
  34. Widget? suffixIcon,
  35. Widget? suffix,
  36. String? suffixText,
  37. TextStyle? suffixStyle,
  38. Color? suffixIconColor,
  39. BoxConstraints? suffixIconConstraints,
  40. Widget? counter,
  41. String? counterText,
  42. TextStyle? counterStyle,
  43. bool? filled,
  44. Color? fillColor,
  45. Color? focusColor,
  46. Color? hoverColor,
  47. InputBorder? errorBorder,
  48. InputBorder? focusedBorder,
  49. InputBorder? focusedErrorBorder,
  50. InputBorder? disabledBorder,
  51. InputBorder? enabledBorder,
  52. InputBorder? border,
  53. bool enabled = true,
  54. String? semanticCounterText,
  55. bool? alignLabelWithHint,
  56. BoxConstraints? constraints,
})

Creates a bundle of the border, labels, icons, and styles used to decorate a Material Design text field.

Unless specified by ThemeData.inputDecorationTheme, InputDecorator defaults isDense to false and filled to false. The default border is an instance of UnderlineInputBorder. If border is InputBorder.none then no border is drawn.

Only one of prefix and prefixText can be specified.

Similarly, only one of suffix and suffixText can be specified.

Implementation

const InputDecoration({
  this.icon,
  this.iconColor,
  this.label,
  this.labelText,
  this.labelStyle,
  this.floatingLabelStyle,
  this.helper,
  this.helperText,
  this.helperStyle,
  this.helperMaxLines,
  this.hintText,
  this.hint,
  this.hintStyle,
  this.hintTextDirection,
  this.hintMaxLines,
  this.hintFadeDuration,
  @Deprecated(
    'Use maintainHintSize instead. '
    'This will maintain both hint height and hint width. '
    'This feature was deprecated after v3.28.0-2.0.pre.',
  )
  this.maintainHintHeight = true,
  this.maintainHintSize = true,
  this.error,
  this.errorText,
  this.errorStyle,
  this.errorMaxLines,
  this.floatingLabelBehavior,
  this.floatingLabelAlignment,
  this.isCollapsed,
  this.isDense,
  this.contentPadding,
  this.prefixIcon,
  this.prefixIconConstraints,
  this.prefix,
  this.prefixText,
  this.prefixStyle,
  this.prefixIconColor,
  this.suffixIcon,
  this.suffix,
  this.suffixText,
  this.suffixStyle,
  this.suffixIconColor,
  this.suffixIconConstraints,
  this.counter,
  this.counterText,
  this.counterStyle,
  this.filled,
  this.fillColor,
  this.focusColor,
  this.hoverColor,
  this.errorBorder,
  this.focusedBorder,
  this.focusedErrorBorder,
  this.disabledBorder,
  this.enabledBorder,
  this.border,
  this.enabled = true,
  this.semanticCounterText,
  this.alignLabelWithHint,
  this.constraints,
}) : assert(
       !(label != null && labelText != null),
       'Declaring both label and labelText is not supported.',
     ),
     assert(
       hint == null || hintText == null,
       'Declaring both hint and hintText is not supported.',
     ),
     assert(
       !(helper != null && helperText != null),
       'Declaring both helper and helperText is not supported.',
     ),
     assert(
       !(prefix != null && prefixText != null),
       'Declaring both prefix and prefixText is not supported.',
     ),
     assert(
       !(suffix != null && suffixText != null),
       'Declaring both suffix and suffixText is not supported.',
     ),
     assert(
       !(error != null && errorText != null),
       'Declaring both error and errorText is not supported.',
     );