OudsFormInputDecoration class
Configuration for decorating the OudsTextField and OudsPhoneNumberInput widgets.
Provides properties to customize labels, hints, icons, helper and error texts, loading states, and styling.
Parameters:
-
labelText: The main label text displayed above or inside the input field.
-
helperText: Additional information displayed below the input, often used to guide or assist the user. Supports strong text formatting using
**bold**. Hyperlinks are not supported in helper text. Use the dedicated helper link component instead. -
hintText: A short placeholder or hint shown inside the input when empty, describing the expected input.
-
suffixIcon: A widget displayed at the end of the input field, commonly used for actions like clearing or toggling visibility.
-
onSuffixPressed: - Assign a function to handle specific actions, that is invoked when the suffixIcon is pressed. - If
null, tapping the suffix icon will have no effect. -
prefixIcon: The name or path of an icon displayed at the start of the input field, typically to indicate the type or purpose of input.
-
prefix: A string displayed before the user's input, usually static text or units.
-
suffix: A string displayed after the user's input, often used for units or context.
-
errorText: Text shown below the input indicating an error state or invalid input. Supports strong text formatting using
**bold**. -
loader: When true, displays a loading indicator inside the input.
-
outlined: A boolean that determines if the input uses an outlined style or not.
-
constrainedMaxWidth: When
true, the item width is constrained to a maximum value defined by the design system. Whenfalse, no specific width constraint is applied, allowing the component to size itself or follow external modifiers. Defaults tofalse.
- Implementers
Constructors
- OudsFormInputDecoration({String? labelText, String? helperText, String? hintText, String? suffixIcon, String? prefixIcon, String? prefix, bool hasPrefix = false, String? suffix, String? errorText, bool? loader, bool? outlined = false, VoidCallback? onSuffixPressed, bool constrainedMaxWidth = false})
-
const
Properties
- constrainedMaxWidth → bool
-
final
- errorText → String?
-
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- hasPrefix → bool
-
final
- helperText → String?
-
final
- hintText → String?
-
final
- labelText → String?
-
final
- loader → bool?
-
final
- onSuffixPressed → VoidCallback?
-
final
- outlined → bool?
-
final
- prefix → String?
-
final
- prefixIcon → String?
-
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- suffix → String?
-
final
- suffixIcon → String?
-
final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited