TextArea class
A multi-line text editor widget powered by the bubbles textarea model.
- Inheritance
-
- Object
- Widget
- StatefulWidget
- TextArea
Constructors
- TextArea({TextAreaModel? model, TextAreaController? controller, String? prompt, String? placeholder, int? width, int height = 6, bool showLineNumbers = true, int? charLimit, bool softWrap = true, bool? useVirtualCursor, TextAreaStyles? styles, TextAreaKeyMap? keyMap, CursorModel? cursor, TextChangedCallback? onChanged, FocusController? focusController, String? focusId, bool autofocus = false, bool enabled = true, int mouseXOffset = 0, String? zoneId, Key? key})
Properties
- accessibilityLabel → String?
-
Optional accessibility label.
no setterinherited
- accessibilityRole → String
-
Optional accessibility role.
no setterinherited
- autofocus → bool
-
Whether to request focus on first build.
final
- charLimit → int?
-
Maximum characters allowed (0 = unlimited).
final
-
children
→ List<
Widget> -
Child widgets that receive forwarded messages.
no setterinherited
- controller → TextAreaController?
-
Optional controller to hold textarea state.
final
- cursor → CursorModel?
-
Optional cursor model. Defaults to a static cursor.
final
- debugRenderObjectPassthrough → bool
-
Whether this widget is intentionally transparent to render-object layouts.
no setterinherited
- degradationSignal → WidgetDegradationSignal
-
Signal that controls this widget's render budget behavior.
no setterinherited
- enabled → bool
-
Whether input is enabled.
final
- focusable → bool
-
Whether this widget can receive keyboard focus.
no setterinherited
- focusController → FocusController?
-
Optional focus controller for focus coordination.
final
- focusId → String?
-
Optional focus identifier.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- height → int
-
Visible textarea height in rows.
final
- id → String
-
Unique identifier for this widget.
no setterinherited
- key → Key?
-
Key for preserving widget identity.
finalinherited
- keyMap → TextAreaKeyMap?
-
Optional key bindings.
final
- model → TextAreaModel?
-
Optional model to use for textarea behavior.
final
- mouseXOffset → int
-
Optional horizontal offset correction for mouse hit coordinates.
final
- onChanged → TextChangedCallback?
-
Called when the text changes.
final
- placeholder → String?
-
Placeholder text when the textarea is empty.
final
- prompt → String?
-
Prompt displayed before each line.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- showLineNumbers → bool
-
Whether to show line numbers.
final
- softWrap → bool
-
Whether to soft-wrap long lines.
final
- styles → TextAreaStyles?
-
Styles used for focused/blurred textarea rendering.
final
- theme → Theme
-
Access the current theme.
no setterinherited
- useVirtualCursor → bool?
-
Whether to render a virtual cursor.
final
- width → int?
-
Explicit textarea width in cells.
final
- zoneId → String?
-
Optional zone id for mouse interactions.
final
Methods
-
buildCachedView<
T> (T builder(), Object? cacheKey) → T -
Returns a cached view if the cache key matches.
inherited
-
createState(
) → State< StatefulWidget> -
Creates the mutable State associated with this widget.
override
-
handleInit(
) → Cmd? -
Override this instead of init for widget-specific initialization.
inherited
-
handleIntercept(
Msg msg) → (Widget, Cmd?) -
Override this to handle messages before they reach children.
inherited
-
handleUpdate(
Msg msg) → (Widget, Cmd?) -
Override this to handle messages specific to this widget.
inherited
-
init(
) → Cmd? -
Called once when the widget is first mounted.
inherited
-
invalidateCachedView(
) → void -
Clears any cached view for this widget.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
shouldRenderAt(
DegradationLevel degradationLevel, {required bool subtreeHasFocusedWidget}) → bool -
Whether this widget should participate in the current render when
degradationLevelis active.inherited -
toString(
) → String -
A string representation of this object.
inherited
-
update(
Msg msg) → (Model, Cmd?) -
Handles messages by forwarding to children then calling handleUpdate.
inherited
-
view(
) → Object -
Renders the widget to a string or View.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited