Sidebar class
A macOS-style side bar at left side of the MacosScaffold.
Constructors
- Sidebar({required ScrollableWidgetBuilder builder, required double minWidth, Key? key, BoxDecoration? decoration, bool? isResizable = true, bool dragClosed = true, double? dragClosedBuffer, double? snapToStartBuffer, double? maxWidth = 400.0, double? startWidth, EdgeInsets padding = EdgeInsets.zero, double windowBreakpoint = 556.0, Widget? top, Widget? bottom, double topOffset = 51.0, bool shownByDefault = true})
-
Creates a Sidebar.
const
Properties
- bottom → Widget?
-
Widget that should be displayed at the bottom of the Sidebar.
final
- builder → ScrollableWidgetBuilder
-
The builder that creates a child to display in this widget, which will
use the provided
_scrollControllerto enable the scrollbar to work.final - decoration → BoxDecoration?
-
The BoxDecoration to paint behind the child in the builder.
final
- dragClosed → bool
-
If true, the sidebar will close when dragged below minWidth. Use
dragClosedBuffer configure how far below minWidth it needs to be
dragged to trigger this behavior.
final
- dragClosedBuffer → double
-
If dragClosed is true, the sidebar will be hidden when dragged this far
below minWidth. Defaults to half of minWidth. Set to 0 to cause the
sidebar to close at exactly minWidth.
final
- hashCode → int
-
The hash code for this object.
read-onlyinherited
- isResizable → bool?
-
Specifies whether the Sidebar can be resized by dragging or not.
final
- key → Key?
-
A Key is an identifier for Widgets, Elements and SemanticsNodes.
final
- maxWidth → double?
-
The maximum width that this sidebar can be resized to.
final
- minWidth → double
-
The minimum width that this sidebar can be resized to.
final
- padding → EdgeInsets
-
Empty space to inscribe inside the title bar. The
child, if any, is placed inside this padding.final - runtimeType → Type
-
A representation of the runtime type of the object.
read-onlyinherited
- shownByDefault → bool
-
Whether the sidebar should be open by default or not.
final
- snapToStartBuffer → double?
-
If this and startWidth are both set, the sidebar will snap back to
startWidth when dragged within this many pixels of it.
final
- startWidth → double?
-
The default width that this
Sidebarfirst starts with.final - top → Widget?
-
Widget that should be displayed at the top of the Sidebar.
final
- topOffset → double
-
Specifies the top offset of the sidebar.
final
- windowBreakpoint → double
-
Specifies the width of the window at which this Sidebar will be hidden.
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