ShadSidebarScaffold class

Lays out a ShadSidebar next to the page content, mirroring shadcn/ui's SidebarProvider + SidebarInset.

Above the md breakpoint the sidebar renders inline and collapses according to its collapsible mode; below it the sidebar disappears and ShadSidebarTrigger (or the controller) presents it as a modal sheet. ⌘B/Ctrl+B toggles it.

ShadSidebarScaffold(
  sidebar: ShadSidebar(
    header: ...,
    children: [ShadSidebarGroup(...)],
  ),
  child: page,
)
Inheritance
Available extensions

Constructors

ShadSidebarScaffold({Key? key, required ShadSidebar sidebar, required Widget child, ShadSidebarController? controller, bool defaultOpen = true, ValueChanged<bool>? onOpenChange, bool keyboardShortcut = true, BorderRadiusGeometry? borderRadius})
Lays out a ShadSidebar next to the page content, mirroring shadcn/ui's SidebarProvider + SidebarInset.
const

Properties

borderRadius → BorderRadiusGeometry?
Rounds and clips the scaffold's corners.
final
child → Widget
The page content next to the sidebar.
final
controller → ShadSidebarController?
An external controller for the open state.
final
defaultOpen → bool
Whether the sidebar starts open. Ignored when controller is set.
final
hashCode → int
The hash code for this object.
no setterinherited
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
keyboardShortcut → bool
Whether ⌘B/Ctrl+B toggles the sidebar.
final
onOpenChange → ValueChanged<bool>?
Called whenever the desktop open state changes.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
The sidebar configuration and content.
final

Methods

animate({Key? key, List<Effect>? effects, AnimateCallback? onInit, AnimateCallback? onPlay, AnimateCallback? onComplete, bool? autoPlay, Duration? delay, AnimationController? controller, Adapter? adapter, double? target, double? value}) → Animate

Available on Widget, provided by the AnimateWidgetExtensions extension

Wraps the target Widget in an Animate instance, and returns the instance for chaining calls. Ex. myWidget.animate() is equivalent to Animate(child: myWidget).
createElement() → StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → State<ShadSidebarScaffold>
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.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
positionedWith(ShadPosition position) → Widget

Available on Widget, provided by the PositionedExt extension

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

Operators

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