ReorderableBuilder class
Enables animated drag and drop behaviour for built widgets in builder.
Be sure not to replace, add or remove your children while you are dragging because this can lead to an unexpected behavior.
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatefulWidget
- ReorderableBuilder
Constructors
-
ReorderableBuilder({required List<
Widget> children, required DraggableBuilder builder, ScrollController? scrollController, ReorderListCallback? onReorder, List<int> lockedIndices = const [], bool enableLongPress = true, Duration longPressDelay = kLongPressTimeout, bool enableDraggable = true, double automaticScrollExtent = 80.0, bool enableScrollingWhileDragging = true, BoxDecoration? dragChildBoxDecoration, Duration? initDelay, VoidCallback? onDragStarted, VoidCallback? onDragEnd, Key? key}) -
const
Properties
- automaticScrollExtent → double
-
Defines the height of the top or bottom before the dragged child indicates a scrolling.
final
- builder → DraggableBuilder
-
Callback to return updated children.
final
-
children
→ List<
Widget> -
Updating children with some widgets to enable animations.
final
- dragChildBoxDecoration → BoxDecoration?
-
BoxDecoration for the child that is dragged around.
final
- enableDraggable → bool
-
When disabling draggable, the drag and drop behavior is not working.
final
- enableLongPress → bool
-
The drag of a child can be started with the long press.
final
- enableScrollingWhileDragging → bool
-
Enables the functionality to scroll while dragging a child to the top or bottom.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- initDelay → Duration?
-
Adding delay after initializing children.
final
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
-
lockedIndices
→ List<
int> -
Specify indices for children that should not change their position while dragging.
final
- longPressDelay → Duration
-
Specify the Duration for the pressed child before starting the dragging.
final
- onDragEnd → VoidCallback?
-
Callback when the dragged child was released.
final
- onDragStarted → VoidCallback?
-
Callback when dragging starts.
final
- onReorder → ReorderListCallback?
-
After releasing the dragged child, onReorder is called.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- scrollController → ScrollController?
-
ScrollController to get the current scroll position. Important for calculations!
final
Methods
-
createElement(
) → StatefulElement -
Creates a StatefulElement to manage this widget's location in the tree.
inherited
-
createState(
) → State< ReorderableBuilder> -
Creates the mutable state for this widget at a given location in the tree.
override
-
debugDescribeChildren(
) → List< DiagnosticsNode> -
Returns a list of
DiagnosticsNodeobjects 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