TextFieldSpec class
Resolved visual properties for a RemixTextField.
- Implemented types
- Annotations
-
- @MixableSpec.new(target: RemixTextField.new, extraStylerMixins: [RemixBoxStylerMixin, LabelStyleMixin])
Constructors
-
TextFieldSpec({StyleSpec<
TextSpec> ? text, StyleSpec<TextSpec> ? hintText, TextAlign? textAlign = TextAlign.start, double? cursorWidth = 2.0, double? cursorHeight, Radius? cursorRadius, Color? cursorColor, BoxHeightStyle? selectionHeightStyle = BoxHeightStyle.tight, BoxWidthStyle? selectionWidthStyle = BoxWidthStyle.tight, EdgeInsets? scrollPadding = const EdgeInsets.all(20.0), Brightness? keyboardAppearance, bool? cursorOpacityAnimates, StyleSpec<BoxSpec> ? container, double? spacing, CrossAxisAlignment? crossAxisAlignment, StyleSpec<FlexBoxSpec> ? layout, StyleSpec<TextSpec> ? helperText, StyleSpec<TextSpec> ? label, RemixBoxEffectsSpec? containerEffects}) -
Creates a TextFieldSpec with optional styling and configuration.
const
Properties
-
container
→ StyleSpec<
BoxSpec> -
Styling specification for the text field's container.
final
- containerEffects → RemixBoxEffectsSpec?
-
final
- crossAxisAlignment → CrossAxisAlignment?
-
Cross-axis alignment for the input row's editor and accessories.
final
- cursorColor → Color?
-
Color of the text cursor.
final
- cursorHeight → double?
-
Height of the text cursor in logical pixels.
final
- cursorOpacityAnimates → bool?
-
Whether the cursor opacity should animate.
final
- cursorRadius → Radius?
-
Border radius of the text cursor.
final
- cursorWidth → double?
-
Width of the text cursor in logical pixels.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
-
helperText
→ StyleSpec<
TextSpec> -
Styling specification for helper text.
final
-
hintText
→ StyleSpec<
TextSpec> -
Styling specification for the hint/placeholder text.
final
- keyboardAppearance → Brightness?
-
Appearance of the keyboard for this text field.
final
-
label
→ StyleSpec<
TextSpec> -
Styling specification for the text field's label.
final
-
layout
→ StyleSpec<
FlexBoxSpec> -
Styling specification for the layout that wraps the label, input
container, and helper text.
final
-
props
→ List<
Object?> -
The properties based on which equality and hash code are computed.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- scrollPadding → EdgeInsets?
-
Padding around the scrollable area of the text field.
final
- selectionHeightStyle → BoxHeightStyle?
-
How tall the selection highlight should be.
final
- selectionWidthStyle → BoxWidthStyle?
-
How wide the selection highlight should be.
final
- spacing → double?
-
Spacing between the leading widget, editor, and trailing widget.
final
- stringify → bool
-
Whether to use a detailed string representation of the object.
no setterinherited
-
text
→ StyleSpec<
TextSpec> -
Styling specification for the input text.
final
- textAlign → TextAlign?
-
Horizontal alignment of the text within the input field.
final
- type → Type
-
no setterinherited
Methods
-
copyWith(
{StyleSpec< TextSpec> ? text, StyleSpec<TextSpec> ? hintText, TextAlign? textAlign, double? cursorWidth, double? cursorHeight, Radius? cursorRadius, Color? cursorColor, BoxHeightStyle? selectionHeightStyle, BoxWidthStyle? selectionWidthStyle, EdgeInsets? scrollPadding, Brightness? keyboardAppearance, bool? cursorOpacityAnimates, StyleSpec<BoxSpec> ? container, double? spacing, CrossAxisAlignment? crossAxisAlignment, StyleSpec<FlexBoxSpec> ? layout, StyleSpec<TextSpec> ? helperText, StyleSpec<TextSpec> ? label, RemixBoxEffectsSpec? containerEffects}) → TextFieldSpec -
Creates a copy of this spec with the given fields
replaced by the non-null parameter values.
inherited
-
debugFillProperties(
DiagnosticPropertiesBuilder properties) → void -
Add additional properties associated with the node.
inherited
-
getDiff(
Equatable other) → Map< String, String> -
Returns a map of properties that differ between this object and another.
inherited
-
lerp(
covariant TextFieldSpec? other, double t) → TextFieldSpec - Linearly interpolates with another Spec object.
-
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
-
toStringShort(
) → String -
A brief description of this object, usually just the runtimeType and the
hashCode.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited