Elevator class

A widget that creates an elevated overlay effect when hovered.

The Elevator widget creates a hover effect by rendering its child twice: once in the normal widget tree and once in an overlay. When the user hovers over the widget, it shows the overlay version while hiding the original, creating an "elevation" effect.

The overlay version is automatically clipped to stay within any scrollable parent's viewport, supporting both vertical and horizontal scrolling.

Example usage:

Elevator(
  builder: (elevated) => Container(
    decoration: BoxDecoration(
      boxShadow: elevated ? [BoxShadow(...)] : null,
    ),
    child: YourContent(),
  ),
)

The builder function is called with a boolean indicating whether the widget is currently elevated, allowing you to modify the appearance based on the elevation state.

Inheritance

• Object
• DiagnosticableTree
• Widget
• StatefulWidget
• Elevator

Constructors

Elevator({required Widget builder(bool elevated), Key? key, bool dismissOnTap = true})

Creates a new Elevator widget.

const

Properties

builder → Widget Function(bool elevated)

Builder function that creates the widget's content.

final

dismissOnTap → bool

Whether the elevated state should be dismissed when tapping on the overlay.

final

hashCode → int

The hash code for this object.

no setter, inherited

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

Methods

createElement() → StatefulElement

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

inherited

createState() → State<Elevator>

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

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