Scrollbars class

A widget that provides scrollbars for a scrollable child.

Scrollbars wraps a scrollable widget and adds vertical and/or horizontal scrollbars as needed. The scrollbars automatically show/hide based on content overflow and provide both track-tapping and thumb-dragging interactions.

The scrollbars can be customized independently, and you can control whether they pad the content (pushing it inward) or overlay it.

Example:

Scrollbars(
  verticalScrollbar: DefaultScrollbar(
    thumbDecoration: BoxDecoration(color: Colors.blue),
  ),
  verticalScrollbarThickness: 16.0,
  verticalScrollbarPadsContent: true,
  child: FlexBox(
    // Scrollable content here
  ),
)
Inheritance
Available extensions

Constructors

Scrollbars({Key? key, required Widget child, Widget corner = const SizedBox.shrink(), Widget verticalScrollbar = const DefaultScrollbar(), Widget horizontalScrollbar = const DefaultScrollbar(), bool verticalScrollbarPadsContent = false, bool horizontalScrollbarPadsContent = false, double verticalScrollbarThickness = 12.0, double horizontalScrollbarThickness = 12.0})
Creates a widget with scrollbars for the given child.
const

Properties

asAbsoluteItem → Widget

Available on Widget, provided by the WidgetExtension extension

Explicitly wraps this widget as an AbsoluteItem.
no setter
asFlexItem → Widget

Available on Widget, provided by the WidgetExtension extension

Explicitly wraps this widget as a FlexItem.
no setter
child → Widget
The scrollable content widget.
final
corner → Widget
Widget to display in the corner where scrollbars meet.
final
hashCode → int
The hash code for this object.
no setterinherited
horizontalScrollbar → Widget
The scrollbar widget to use for horizontal scrolling.
final
horizontalScrollbarPadsContent → bool
Whether the horizontal scrollbar should push content inward.
final
horizontalScrollbarThickness → double
Height of the horizontal scrollbar in pixels.
final
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
verticalScrollbar → Widget
The scrollbar widget to use for vertical scrolling.
final
verticalScrollbarPadsContent → bool
Whether the vertical scrollbar should push content inward.
final
verticalScrollbarThickness → double
Width of the vertical scrollbar in pixels.
final

Methods

aspectRatio(double aspectRatio, [Key? key]) → Widget

Available on Widget, provided by the WidgetExtension extension

Sets the aspect ratio constraint for this widget.
bottom(PositionUnit bottom, [Key? key]) → Widget

Available on Widget, provided by the WidgetExtension extension

Sets the distance from the bottom edge of the parent container.
constrained({SizeUnit? minWidth, SizeUnit? maxWidth, SizeUnit? minHeight, SizeUnit? maxHeight, Key? key}) → Widget

Available on Widget, provided by the WidgetExtension extension

Sets comprehensive size constraints including both minimum and maximum bounds.
createElement() → StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → State<Scrollbars>
Creates the mutable state for this widget at a given location in the tree.
override
debugDescribeChildren() → List<DiagnosticsNode>
Returns a list of DiagnosticsNode objects describing this node's children.
inherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → void
Add additional properties associated with the node.
override
flexGrow(double flexGrow, [Key? key]) → Widget

Available on Widget, provided by the WidgetExtension extension

Sets the flex grow factor for this widget within a flex container.
flexShrink(double flexShrink, [Key? key]) → Widget

Available on Widget, provided by the WidgetExtension extension

Sets the flex shrink factor for this widget within a flex container.
height(SizeUnit height, [Key? key]) → Widget

Available on Widget, provided by the WidgetExtension extension

Sets the height of this widget using a SizeUnit.
id(Object valueKey) → Widget

Available on Widget, provided by the WidgetExtension extension

Assigns a ValueKey to this widget using the provided value.
key(Key key) → Widget

Available on Widget, provided by the WidgetExtension extension

Assigns a Key to this widget.
left(PositionUnit left, [Key? key]) → Widget

Available on Widget, provided by the WidgetExtension extension

Sets the distance from the left edge of the parent container.
maxHeight(SizeUnit maxHeight, [Key? key]) → Widget

Available on Widget, provided by the WidgetExtension extension

Sets the maximum height constraint for this widget using a SizeUnit.
maxSized({SizeUnit? maxWidth, SizeUnit? maxHeight, Key? key}) → Widget

Available on Widget, provided by the WidgetExtension extension

Sets maximum width and height constraints simultaneously.
maxWidth(SizeUnit maxWidth, [Key? key]) → Widget

Available on Widget, provided by the WidgetExtension extension

Sets the maximum width constraint for this widget using a SizeUnit.
minHeight(SizeUnit minHeight, [Key? key]) → Widget

Available on Widget, provided by the WidgetExtension extension

Sets the minimum height constraint for this widget using a SizeUnit.
minSized({SizeUnit? minWidth, SizeUnit? minHeight, Key? key}) → Widget

Available on Widget, provided by the WidgetExtension extension

Sets minimum width and height constraints simultaneously.
minWidth(SizeUnit minWidth, [Key? key]) → Widget

Available on Widget, provided by the WidgetExtension extension

Sets the minimum width constraint for this widget using a SizeUnit.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
paintOrder(int paintOrder, [Key? key]) → Widget

Available on Widget, provided by the WidgetExtension extension

Sets the paint order for this widget within its parent container.
position(PositionType position, [Key? key]) → Widget

Available on Widget, provided by the WidgetExtension extension

Sets the position type for this widget to control positioning context.
positioned({PositionUnit? top, PositionUnit? left, PositionUnit? bottom, PositionUnit? right, Key? key}) → Widget

Available on Widget, provided by the WidgetExtension extension

Positions the widget using multiple edge offsets simultaneously.

Available on Widget, provided by the WidgetExtension extension

Sets the distance from the right edge of the parent container.
selfAligned(BoxAlignmentGeometry alignSelf, [Key? key]) → Widget

Available on Widget, provided by the WidgetExtension extension

Sets the alignment of this widget within its parent flex container.
sized({SizeUnit? width, SizeUnit? height, Key? key}) → Widget

Available on Widget, provided by the WidgetExtension extension

Sets both width and height dimensions simultaneously.
toDiagnosticsNode({String? name, DiagnosticsTreeStyle? style}) → DiagnosticsNode
Returns a debug representation of the object that is used by debugging tools and by DiagnosticsNode.toStringDeep.
inherited
top(PositionUnit top, [Key? key]) → Widget

Available on Widget, provided by the WidgetExtension extension

Sets the distance from the top edge of the parent container.
toString({DiagnosticLevel minLevel = DiagnosticLevel.info}) → String
A string representation of this object.
inherited
toStringDeep({String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug, int wrapWidth = 65}) → String
Returns a string representation of this node and its descendants.
inherited
toStringShallow({String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String
Returns a one-line detailed description of the object.
inherited
toStringShort() → String
A short, textual description of this widget.
inherited
width(SizeUnit width, [Key? key]) → Widget

Available on Widget, provided by the WidgetExtension extension

Sets the width of this widget using a SizeUnit.

Operators

operator ==(Object other) → bool
The equality operator.
inherited