WoltSideSheetType class
A customizable side sheet modal that extends WoltModalType.
- Inheritance
-
- Object
- WoltModalType
- WoltSideSheetType
Constructors
- WoltSideSheetType({ShapeBorder shapeBorder = _defaultShapeBorder, bool forceMaxHeight = true, Duration transitionDuration = _defaultEnterDuration, Duration reverseTransitionDuration = _defaultExitDuration, WoltModalDismissDirection dismissDirection = WoltModalDismissDirection.endToStart, double minFlingVelocity = 365.0, double closeProgressThreshold = 0.5, bool? barrierDismissible})
-
Constructs a WoltSideSheetType.
const
Properties
- barrierDismissible → bool?
-
finalinherited
- closeProgressThreshold → double
-
Threshold value for determining when the modal should close during a drag gesture.
If the animation's progress value falls below this threshold during a drag,
the modal will be dismissed. The value should be between 0.0 and 1.0, where:
finalinherited
- dismissDirection → WoltModalDismissDirection?
-
The direction in which the modal can be dismissed when drag to dismiss is enabled.
finalinherited
- forceMaxHeight → bool
-
Forces the modal content to use the maximum available height if set to
true.finalinherited - hashCode → int
-
The hash code for this object.
no setterinherited
- isDragToDismissEnabled → bool?
-
Depending on the value of dismissDirection, determines whether the modal is draggable.
no setterinherited
- minFlingVelocity → double
-
The minimum velocity required for a drag gesture to be considered a fling.
finalinherited
- reverseTransitionDuration → Duration
-
The duration of the modal's reverse transition animation.
finalinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- shapeBorder → ShapeBorder
-
The border shape of the modal.
finalinherited
- showDragHandle → bool?
-
Determines whether the modal should show a drag handle on the top centered position.
finalinherited
- transitionDuration → Duration
-
The duration of the modal's forward transition animation.
finalinherited
Methods
-
buildTransitions(
BuildContext context, Animation< double> animation, Animation<double> secondaryAnimation, Widget child) → Widget -
Animates the modal's appearance with a slide transition adjusted for text direction.
override
-
copyWith(
{ShapeBorder? shapeBorder, bool? forceMaxHeight, Duration? transitionDuration, Duration? reverseTransitionDuration, WoltModalDismissDirection? dismissDirection, double? minFlingVelocity, double? closeProgressThreshold, bool? barrierDismissible}) → WoltSideSheetType -
Provides a way to create a new
WoltDialogTypeinstance with modified properties. -
decorateModal(
BuildContext context, Widget modal, bool useSafeArea) → Widget -
Applies additional decorations to the modal content.
override
-
decoratePageContent(
BuildContext context, Widget child, bool useSafeArea) → Widget -
Enhances the visual presentation of the modal's content by optionally incorporating safe area insets
and a tinted background color.
override
-
layoutModal(
Size availableSize) → BoxConstraints -
Specifies the size constraints for the modal based on the available space.
override
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
positionModal(
Size availableSize, Size modalContentSize, TextDirection textDirection) → Offset -
Calculates the position of the modal within the screen based on text direction.
This ensures correct alignment with the screen's edge appropriate for the text direction.
override
-
routeLabel(
BuildContext context) → String -
Provides an accessibility label that describes the side sheet's function and type.
override
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited