Reorder is a component that allows an item to be dragged to change its order within a group of items. It must be used within a reorder group to provide a visual drag and drop interface.
The reorder is the anchor used to drag and drop the items. Once the reorder is complete, the
ionItemReorder event will be dispatched from the reorder group and the
complete method needs to be called.
The most basic example of a reorder is slotting it inside of an item. By default, the reorder functionality is disabled for a reorder group. It can be enabled by setting the
disabled property on the reorder group to
false. The reorder icon can then be used to drag and drop the items and reorder them.
In some cases, it may be desired to have the option to toggle the reorder functionality. This can be done by making the
disabled property reactive, based on a function or variable.
Custom Reorder Icon
The reorder component uses a reorder icon with three lines on iOS and two lines on Material Design. This can be customized by adding an Icon component inside of the reorder with any of the available Ionicons.
Reorder can also be used as a wrapper around an item, making the item itself the anchor. Click anywhere on an item below and drag it to reorder the list.
complete method is called on the reorder group with no parameters, the DOM nodes will be reordered. If the items are rendered from an array of data that needs to be sorted, this can result in the data and DOM being out of sync.
In order to sort the array upon completion of the reorder, the array should be passed as a parameter to the
complete method. The
complete method will sort the array and return it so it can be reassigned. Note that passing the array will prevent Ionic from reordering the DOM nodes.
In some cases, it may be necessary for an app to reorder both the array and the DOM nodes on its own. If this is required,
false should be passed as a parameter to the
complete method. This will prevent Ionic from reordering any DOM nodes inside of the reorder group.
Regardless of the approach taken, a stable identity should be provided to reorder items if provided in a loop. This means using
trackBy for Angular, and
key for React and Vue.
Usage with Virtual Scroll
Reorder requires a scroll container to work properly. When using a virtual scrolling solution, a custom scroll target needs to be provided. Scrolling on the content needs to be disabled and the
.ion-content-scroll-host class needs to be added to the element responsible for scrolling.
No properties available for this component.
No events available for this component.
No public methods available for this component.
CSS Shadow Parts
|The icon of the reorder handle (uses ion-icon).|
CSS Custom Properties
No CSS custom properties available for this component.
No slots available for this component.