FloatingPullUpCardLayout class

Inheritance

Constructors

FloatingPullUpCardLayout({Key? key, required Widget child, required Widget body, double? height, double? width, double cardElevation = 4, bool dismissable = false, FloatingPullUpState? state = FloatingPullUpState.collapsed, ValueChanged<FloatingPullUpState?>? onStateChange, DragHandleBuilder? dragHandleBuilder, Color cardColor = const Color(0xFFFFFFFF), FloatingCardBuilder? cardBuilder, BorderRadius borderRadius = const BorderRadius.only(topLeft: Radius.circular(16), topRight: Radius.circular(16)), StateOffsetFunction? collpsedStateOffset, StateOffsetFunction? hiddenStateOffset, UncollapsedStateOffsetFunction? uncollpsedStateOffset, dynamic autoPadding = true, FloatingPullUpState? onOutsideTap()?, bool withOverlay = false, Color overlayColor = const Color(0x66000000)})

Properties

autoPadding → dynamic
if true , this automatically adds padding to the child container, avoiding the card to float on top of child content defaults to true
final
body Widget
The Widget to be used as the content of the floating card
final
borderRadius BorderRadius
Set a custom borderRadius of the default Card material
final
cardBuilder FloatingCardBuilder?
Defines a custom cardBuilder
final
cardColor Color
Set a custom card color to the card background defaults to Colors.white
final
cardElevation double
Set a cardElevation for the material, defaults to 4
final
child Widget
The Widget to be used as the content of the main layout, not the card content
final
collpsedStateOffset StateOffsetFunction?
Sets a custom function that return a custom Y Offset for state FloatingPullUpState.collapsed Please take into account that offset start from top to bottom
final
dismissable bool
If true , the card can be dragged until it's hidden from screen defaults to false
final
dragHandleBuilder DragHandleBuilder?
Defines a custom dragHandleBuilder
final
hashCode int
The hash code for this object.
no setterinherited
height double?
Set a custom height for the floating card, defaults to 86% of total height of parent container or screen height if no finite height can be assumed
final
hiddenStateOffset StateOffsetFunction
Sets a custom function that return a custom Y Offset for state FloatingPullUpState.hidden Please take into account that offset start from top to bottom
final
key Key?
Controls how one widget replaces another widget in the tree.
finalinherited
onOutsideTap FloatingPullUpState? Function()?
Defines a callback to be called when a user taps outside the card If function returns FloatingPullUpState it will change state to the returned one Take into account that this is not getting called if a widget inside body is already handling a Gesture
final
onStateChange ValueChanged<FloatingPullUpState?>?
Called each time the FloatingPullUpState is changed
final
overlayColor Color
Defines the color of the overlay , this only takes effect of withOverlayOption is true
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
state FloatingPullUpState?
Sets the state of the floating card, See enum FloatingPullUpState for more details Defaults to FloatingPullUpState.collapsed
final
uncollpsedStateOffset UncollapsedStateOffsetFunction
Sets a custom function that return a custom Y Offset for state FloatingPullUpState.uncollapsed Please take into account that offset start from top to bottom
final
width double?
Set a custom width for the floating card, defaults to 100% of total width of parent container or screen width if no finite width can be assumed
final
withOverlay bool
If true, this will show an overlay behind the card tht obscures content behind Defaults tofalse
final

Methods

createElement() StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → _FloatingPullUpCardLayoutState
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}) 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