Unverified Commit 3f52d580 authored by Darren Austin's avatar Darren Austin Committed by GitHub

Fixed some issues and clarified the docs for ReorderableListView. (#98954)

parent a1a5c149
...@@ -16,13 +16,6 @@ import 'theme.dart'; ...@@ -16,13 +16,6 @@ import 'theme.dart';
/// A list whose items the user can interactively reorder by dragging. /// A list whose items the user can interactively reorder by dragging.
/// ///
/// This class is appropriate for views with a small number of
/// children because constructing the [List] requires doing work for every
/// child that could possibly be displayed in the list view instead of just
/// those children that are actually visible.
///
/// All list items must have a key.
///
/// {@youtube 560 315 https://www.youtube.com/watch?v=3fB1mxOsqJE} /// {@youtube 560 315 https://www.youtube.com/watch?v=3fB1mxOsqJE}
/// ///
/// This sample shows by dragging the user can reorder the items of the list. /// This sample shows by dragging the user can reorder the items of the list.
...@@ -34,19 +27,35 @@ import 'theme.dart'; ...@@ -34,19 +27,35 @@ import 'theme.dart';
/// ** See code in examples/api/lib/material/reorderable_list/reorderable_list_view.0.dart ** /// ** See code in examples/api/lib/material/reorderable_list/reorderable_list_view.0.dart **
/// {@end-tool} /// {@end-tool}
/// ///
/// This example demonstrates using the [proxyDecorator] callback to customize the appearance of /// By default, on [TargetPlatformVariant.desktop] platforms each item will
/// a list item while it's being dragged. /// have a drag handle added on top of it that will allow the user to grab it
/// to move the item. On [TargetPlatformVariant.mobile], no drag handle will be
/// added, but when the user long presses anywhere on the item it will start
/// moving the item. Displaying drag handles can be controlled with
/// [ReorderableListView.buildDefaultDragHandles].
///
/// All list items must have a key.
///
/// This example demonstrates using the [proxyDecorator] callback to customize
/// the appearance of a list item while it's being dragged.
/// {@tool snippet} /// {@tool snippet}
/// ///
/// While a drag is underway, the widget returned by the [proxyDecorator] serves as a "proxy" (a substitute) /// While a drag is underway, the widget returned by the [proxyDecorator]
/// for the item in the list. The proxy is created with the original list item as its child. The [proxyDecorator] /// serves as a "proxy" (a substitute) for the item in the list. The proxy is
/// in this example is similar to the default one except that it changes the proxy item's background color. /// created with the original list item as its child. The [proxyDecorator]
/// in this example is similar to the default one except that it changes the
/// proxy item's background color.
/// ///
/// ** See code in examples/api/lib/material/reorderable_list/reorderable_list_view.1.dart ** /// ** See code in examples/api/lib/material/reorderable_list/reorderable_list_view.1.dart **
/// {@end-tool} /// {@end-tool}
class ReorderableListView extends StatefulWidget { class ReorderableListView extends StatefulWidget {
/// Creates a reorderable list from a pre-built list of widgets. /// Creates a reorderable list from a pre-built list of widgets.
/// ///
/// This constructor is appropriate for lists with a small number of
/// children because constructing the [List] requires doing work for every
/// child that could possibly be displayed in the list view instead of just
/// those children that are actually visible.
///
/// See also: /// See also:
/// ///
/// * [ReorderableListView.builder], which allows you to build a reorderable /// * [ReorderableListView.builder], which allows you to build a reorderable
...@@ -111,7 +120,6 @@ class ReorderableListView extends StatefulWidget { ...@@ -111,7 +120,6 @@ class ReorderableListView extends StatefulWidget {
/// list items are built lazily on demand. /// list items are built lazily on demand.
/// {@tool dartpad} /// {@tool dartpad}
/// ///
///
/// ** See code in examples/api/lib/material/reorderable_list/reorderable_list_view.reorderable_list_view_builder.0.dart ** /// ** See code in examples/api/lib/material/reorderable_list/reorderable_list_view.reorderable_list_view_builder.0.dart **
/// {@end-tool} /// {@end-tool}
/// See also: /// See also:
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment