SliverDraggableList class

A sliver list that allows the user to interactively drag the list items.

It is up to the application to wrap each child (or an internal part of the child) with a drag listener that will recognize the start of an item drag and then start the drag by calling SliverDraggableListState.startItemDrag. This is most easily achieved by wrapping each child in a DraggableDragStartListener or a DraggableDelayedDragStartListener. These will take care of recognizing the start of a drag gesture and call the list state's start item drag method.

This widget's SliverDraggableListState can be used to manually start an item drag, or cancel a current drag that's already underway. To refer to the SliverDraggableListState either provide a GlobalKey or use the static SliverDraggableList.of method from an item's build method.

Constructors

SliverDraggableList({Key key, @required IndexedWidgetBuilder itemBuilder, @required int itemCount, @required DragEndCallback onDragEnd, @required DragStartCallback onDragStart, @required DragingCallback onDraging, @required DragCancelCallback onDragCancel, DraggableItemProxyDecorator proxyDecorator}): Creates a sliver list that allows the user to interactively drag its items.
const

Properties

hashCode → int: The hash code for this object.
read-onlyinherited
itemBuilder → IndexedWidgetBuilder: Called, as needed, to build list item widgets.
final
itemCount → int: The number of items in the list.
final
key → Key: Controls how one widget replaces another widget in the tree.
finalinherited
onDragCancel → DragCancelCallback: final
onDragEnd → DragEndCallback: A callback used by the list to report that a list item has been dragged to a new location in the list and the application should update the order of the items.
final
onDraging → DragingCallback: final
onDragStart → DragStartCallback: final
proxyDecorator → DraggableItemProxyDecorator: A callback that allows the app to add an animated decoration around an item when it is being dragged.
final
runtimeType → Type: A representation of the runtime type of the object.
read-onlyinherited

Methods

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

Static Methods

maybeOf(BuildContext context) → SliverDraggableListState: The state from the closest instance of this class that encloses the given context.
of(BuildContext context) → SliverDraggableListState: The state from the closest instance of this class that encloses the given context.