ScrollView class

A scrollable container for a single child widget.

This is a convenience alias for SingleChildScrollView. The two widgets are interchangeable; ScrollView is kept for backward compatibility.

Inheritance

Constructors

ScrollView({required Widget child, ScrollController? controller, bool handleKeys = true, int mouseWheelDelta = 3, bool enableSelection = false, bool autoCopySelectionOnMouseUp = false, bool autoCopySelectionOnExit = false, bool clearSelectionAfterAutoCopy = true, DateTime nowProvider()?, Key? key})
Creates a scroll view.

Properties

accessibilityLabel → String?
Optional accessibility label.
no setterinherited
accessibilityRole → String
Optional accessibility role.
no setterinherited
autoCopySelectionOnExit → bool
Whether to auto-copy selected text immediately when drag leaves the scroll view's hit-test area.
final
autoCopySelectionOnMouseUp → bool
Whether to auto-copy selected text when mouse button is released.
final
child → Widget
Child widget rendered inside the viewport.
final
children → List<Widget>
Child widgets that receive forwarded messages.
no setterinherited
clearSelectionAfterAutoCopy → bool
Whether to clear selection after auto-copy.
final
controller → ScrollController?
Optional external controller for reading/updating offset.
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
enableSelection → bool
Whether in-app text selection is enabled.
final
focusable → bool
Whether this widget can receive keyboard focus.
no setterinherited
handleKeys → bool
Whether keyboard keys trigger scrolling.
final
hashCode → int
The hash code for this object.
no setterinherited
id → String
Unique identifier for this widget.
no setterinherited
key → Key?
Key for preserving widget identity.
finalinherited
mouseWheelDelta → int
Number of rows scrolled per mouse wheel tick.
final
nowProvider → DateTime Function()
Logical clock used for click sequencing.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
theme → Theme
Access the current theme.
no setterinherited

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 degradationLevel is 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