Row moving

Change the order of rows, either manually (dragging them to another location), or programmatically (using Handsontable’s API methods).

Enable the `ManualRowMove` plugin

To enable row moving, set the manualRowMove option to true.

A draggable move handle appears above the selected row header. You can click and drag it to any location in the row header body.

1
import { HotTable } from '@handsontable/react-wrapper';
2
import { registerAllModules } from 'handsontable/registry';
3

4
// register Handsontable's modules
5
registerAllModules();
6

7
// generate an array of arrays with dummy data
8
const data = new Array(200) // number of rows
9
  .fill(0)
10
  .map((_, row) =>
11
    new Array(20) // number of columns
12
      .fill(0)
13
      .map((_, column) => `${row}, ${column}`)
14
  );
15

16
const ExampleComponent = () => {
17
  return (
18
    <HotTable
19
      data={data}
20
      width="100%"
21
      height={320}
22
      rowHeaders={true}
23
      colHeaders={true}
24
      colWidths={100}
25
      manualRowMove={true}
26
      autoWrapRow={true}
27
      autoWrapCol={true}
28
      licenseKey="non-commercial-and-evaluation"
29
    />
30
  );
31
};
32

33
export default ExampleComponent;

1
import { HotTable } from '@handsontable/react-wrapper';
2
import { registerAllModules } from 'handsontable/registry';
3

4
// register Handsontable's modules
5
registerAllModules();
6

7
// generate an array of arrays with dummy data
8
const data = new Array(200) // number of rows
9
  .fill(0)
10
  .map((_, row) =>
11
    new Array(20) // number of columns
12
      .fill(0)
13
      .map((_, column) => `${row}, ${column}`)
14
  );
15

16
const ExampleComponent = () => {
17
  return (
18
    <HotTable
19
      data={data}
20
      width="100%"
21
      height={320}
22
      rowHeaders={true}
23
      colHeaders={true}
24
      colWidths={100}
25
      manualRowMove={true}
26
      autoWrapRow={true}
27
      autoWrapCol={true}
28
      licenseKey="non-commercial-and-evaluation"
29
    />
30
  );
31
};
32

33
export default ExampleComponent;

Set a pre-defined row order

Instead of setting manualRowMove to true, you can pass an array of physical row indexes to define the initial visual order of rows on render.

Each position in the array corresponds to a visual (display) position, and the value at that position is the physical (source data) row index. For example:

1
manualRowMove: [2, 0, 1]

This renders the rows in the following order:

Visual position 0 → physical row 2
Visual position 1 → physical row 0
Visual position 2 → physical row 1

The array must contain all physical row indexes (its length must equal the total number of rows). After the initial render, users can still drag rows to change the order further.

Drag and move actions of `manualRowMove` plugin

There are significant differences between the plugin’s dragRows and moveRows API functions. Both of them change the order of rows, but they rely on different kinds of indexes. The differences between them are shown in the diagrams below.

Both of these methods trigger the beforeRowMove and afterRowMove hooks, but only dragRows passes the dropIndex argument to them.

The dragRows method has a dropIndex parameter, which points to where the elements are being dropped.

dragRows method

The moveRows method has a finalIndex parameter, which points to where the elements will be placed after the moving action - finalIndex being the index of the first moved element.

moveRows method

The moveRows function cannot perform some actions, e.g., more than one element can’t be moved to the last position. In this scenario, the move will be cancelled. The Plugin’s isMovePossible API method and the movePossible parameters beforeRowMove and afterRowMove hooks help in determine such situations.

Configuration options

Core methods

Hooks

Plugins