PanelBehavior class final

Which interactions a panel accepts.

These are configuration, not state: they gate which transitions are legal but never change on their own.

stashable and collapsible are the two optional stages rather than gates on one gesture: turning either off removes that resting place entirely, and every route into it — a gesture, a timer, a command — lands on the next stage instead.

Annotations

Constructors

PanelBehavior({bool draggable = true, bool tapToExpand = true, bool stashable = true, bool collapsible = true, bool expandOnUnstash = false, bool dismissible = false, bool collapseOnTapOutside = true, bool stashOnTapOutside = true, Duration? idleStashDelay = const Duration(seconds: 5), bool avoidKeyboard = true, bool hapticsEnabled = true, PanelSnapPolicy snapPolicy = PanelSnapPolicy.edges})
const

Properties

avoidKeyboard → bool
Whether the panel keeps clear of the software keyboard while expanded.
final
collapseOnTapOutside → bool
Whether tapping outside an expanded panel collapses it.
final
collapsible → bool
Whether the panel has a collapsed resting stage — the small window it sits in between a park and being open.
final
dismissible → bool
Whether flinging the panel clear of the viewport hides it.
final
draggable → bool
Whether the collapsed panel can be dragged around.
final
expandOnUnstash → bool
Whether pulling the panel out of a park opens it, instead of stopping at the collapsed window on the way.
final
hapticsEnabled → bool
Whether committed transitions fire haptic feedback.
final
hashCode → int
The hash code for this object.
no setteroverride
idleStashDelay → Duration?
How long a collapsed panel waits, untouched, before parking itself.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
snapPolicy → PanelSnapPolicy
Where the panel settles after a drag.
final
stashable → bool
Whether dragging the panel against a side edge parks it there.
final
stashOnTapOutside → bool
Whether touching anywhere off a collapsed panel parks it at its edge.
final
tapToExpand → bool
Whether tapping the collapsed panel expands it.
final

Methods

copyWith({bool? draggable, bool? tapToExpand, bool? stashable, bool? collapsible, bool? expandOnUnstash, bool? dismissible, bool? collapseOnTapOutside, bool? stashOnTapOutside, Duration? idleStashDelay, bool clearIdleStashDelay = false, bool? avoidKeyboard, bool? hapticsEnabled, PanelSnapPolicy? snapPolicy}) → PanelBehavior
Returns a copy with the given fields replaced.
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.
override