SheetState class
A data class containing state information about the SlidingSheet such as the extent and scroll offset.
Constructors
- SheetState(_SheetExtent? _extent, {required double extent, required bool isLaidOut, required double maxExtent, required double minExtent})
- A data class containing state information about the SlidingSheet at the time this state was emitted.
- SheetState.inital()
-
A default constructor which can be used to initial
ValueNotifers
for instance.
Properties
- currentScrollOffset → double
-
The current scroll offset of the Scrollable inside the sheet.
read-only
- extent → double
-
The current extent the sheet covers.
final
- hashCode → int
-
The hash code for this object.
read-onlyinherited
- isAtBottom → bool
-
Whether the SlidingSheet has reached its maximum scroll extent.
final
- isAtTop → bool
-
Whether the SlidingSheet has a scrollOffset of zero.
final
- isCollapsed → bool
-
Whether the SlidingSheet has reached its minimum extent.
final
- isExpanded → bool
-
Whether the SlidingSheet has reached its maximum extent.
final
- isHidden → bool
-
Whether the sheet is hidden to the user.
final
- isLaidOut → bool
-
Whether the sheet has finished measuring its children and computed
the correct extents. This takes until the first frame was drawn.
final
- isShown → bool
-
Whether the sheet is visible to the user.
final
- maxExtent → double
-
The maximum extent that the sheet will cover
until it begins scrolling.
final
- maxScrollExtent → double
-
The maximum amount the Scrollable inside the sheet can scroll.
read-only
- minExtent → double
-
The minimum extent that the sheet will cover.
final
- progress → double
-
The progress between minExtent and maxExtent of the current extent.
A progress of 1 means the sheet is fully expanded, while
a progress of 0 means the sheet is fully collapsed.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
read-onlyinherited
- scrollOffset → double
-
The scroll offset of the Scrollable inside the sheet
at the time this SheetState was emitted.
final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
override
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
notifier(
BuildContext context) → ValueNotifier< SheetState> - private