SliverReorderableListState class

The state for a sliver list that allows the user to interactively reorder the list items.

An app that needs to start a new item drag or cancel an existing one can refer to the SliverReorderableList's state with a global key:

// (e.g. in a stateful widget)
GlobalKey<SliverReorderableListState> listKey = GlobalKey<SliverReorderableListState>();

// ...

@override
Widget build(BuildContext context) {
  return SliverReorderableList(
    key: listKey,
    itemBuilder: (BuildContext context, int index) => const SizedBox(height: 10.0),
    itemCount: 5,
    onReorder: (int oldIndex, int newIndex) {
       // ...
    },
  );
}

// ...

void _stop() {
  listKey.currentState!.cancelReorder();
}

ReorderableDragStartListener and ReorderableDelayedDragStartListener refer to their SliverReorderableList with the static SliverReorderableList.of method.

Inheritance
Mixed in types

Constructors

SliverReorderableListState()

Properties

context BuildContext
The location in the tree where this widget builds.
no setterinherited
hashCode int
The hash code for this object.
no setterinherited
mounted bool
Whether this State object is currently in a tree.
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
widget SliverReorderableList
The current configuration.
no setterinherited

Methods

activate() → void
Called when this object is reinserted into the tree after having been removed via deactivate.
inherited
build(BuildContext context) Widget
Describes the part of the user interface represented by this widget.
override
cancelReorder() → void
Cancel any item drag in progress.
createTicker(TickerCallback onTick) Ticker
Creates a ticker with the given callback.
inherited
deactivate() → void
Called when this object is removed from the tree.
inherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → void
Add additional properties associated with the node.
inherited
didChangeDependencies() → void
Called when a dependency of this State object changes.
override
didUpdateWidget(covariant SliverReorderableList oldWidget) → void
Called whenever the widget configuration changes.
override
dispose() → void
Called when this object is removed from the tree permanently.
override
initState() → void
Called when this object is inserted into the tree.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
reassemble() → void
Called whenever the application is reassembled during debugging, for example during hot reload.
inherited
setState(VoidCallback fn) → void
Notify the framework that the internal state of this object has changed.
inherited
startItemDragReorder({required int index, required PointerDownEvent event, required MultiDragGestureRecognizer recognizer}) → void
Initiate the dragging of the item at index that was started with the pointer down event.
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
toStringShort() String
A brief description of this object, usually just the runtimeType and the hashCode.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited