Hidable class
Hidable is a widget that makes any static located widget hideable while scrolling.
To use Hidable, wrap your static located widget with Hidable. This will enable scroll-to-hide functionality for the widget.
Note: The scroll controller provided to Hidable must also be given to your scrollable widget, such as ListView, GridView, etc.
For more information, refer to the documentation.
- Inheritance
- Implemented types
Constructors
- Hidable({Key? key, required Widget child, required ScrollController controller, @deprecated bool wOpacity = true, bool enableOpacityAnimation = true, Size preferredWidgetSize = const Size.fromHeight(56), HidableVisibility? visibility, double deltaFactor = 0.06})
-
const
Properties
- child → Widget
-
The child widget to which you want to add scroll-to-hide effect.
final
- controller → ScrollController
-
The main scroll controller that listens to user's scrolls.
final
- deltaFactor → double
-
A factor that determines the speed at which the child widget's visibility changes
when scrolling occurs.
final
- enableOpacityAnimation → bool
-
Enable or disable opacity animation.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- preferredSize → Size
-
The size this widget would prefer if it were otherwise unconstrained.
no setteroverride
- preferredWidgetSize → Size
-
A customization field for Hidable's
preferredSize
.final - runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- visibility → HidableVisibility?
-
This parameter allows you to define a custom visibility behavior for the child widget
based on scrolling actions. You can provide a function of type
HidableVisibility
to determine when and how the widget should be hidden or revealed during scrolling.final - wOpacity → bool
-
Enable or disable opacity animation.
final
Methods
-
build(
BuildContext context) → Widget -
Describes the part of the user interface represented by this widget.
override
-
createElement(
) → StatelessElement -
Creates a StatelessElement to manage this widget's location in the tree.
inherited
-
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