FSidebar class

A sidebar widget that provides an opinionated layout on the side of the screen.

The FSidebar widget is useful for creating navigation sidebars with a header (sticky), content (scrollable), and footer (sticky) sections.

The layout structure is organized as follows:

┌────────────────────-┐
│   Header (Sticky)   │
├────────────────────-┤
│                     │
│                     │
│      Content        │
│    (Scrollable)     │
│                     │
│                     │
├────────────────────-┤
│   Footer (Sticky)   │
└────────────────────-┘

See:

• https://forui.dev/docs/layout/sidebar for working examples.
• FSidebarStyle for customizing a sidebar's appearance.

Inheritance

• Object
• DiagnosticableTree
• Widget
• StatelessWidget
• FSidebar

Constructors

FSidebar.new({required List<Widget> children, Widget? header, Widget? footer, FSidebarStyle? style, double? width, Key? key})

Creates a sidebar with a list of children that will be wrapped in a ListView.

FSidebar.builder({required Widget itemBuilder(BuildContext, int), required int itemCount, FSidebarStyle? style, Widget? header, Widget? footer, double? width, Key? key})

Creates a sidebar with a builder function that will be wrapped in a ListView.builder.

FSidebar.raw({required Widget child, Widget? header, Widget? footer, FSidebarStyle? style, double? width, Key? key})

Creates a sidebar with a custom content widget.

const

Properties

child → Widget

The main scrollable content widget.

final

footer → Widget?

The optional sticky footer widget.

final

hashCode → int

The hash code for this object.

no setter, inherited

header → Widget?

The optional sticky header widget.

final

key → Key?

Controls how one widget replaces another widget in the tree.

final, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

style → FSidebarStyle?

The style.

final

width → double?

The optional width of the sidebar. If not provided, the width from the style will be used.

final

Methods

build(BuildContext context) → Widget

Describes the part of the user interface represented by this widget.

override

createElement() → StatelessElement

Creates a StatelessElement to manage this widget's location in the tree.

inherited

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

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

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