DEVELOPER REFERENCE · v4.0.0

ReorderList API

Props, callbacks and methods. Select an underlined type to explore its fields, allowed values and callback arguments.

ReorderList11 props2 callbacks0 methods

ReorderList props
Name	Type	Description
`items`Required	`readonly T[]`Inspect type	Ordered items to render. Each item follows the shape shown in the expanded type.
`itemKey`Required	`(item: T) => string \| number`Inspect type	Returns a stable unique key for each reorderable item.
`renderItem`Required	`(item: T, index: number) => ComponentChildren`Inspect type	Renders a list item from its data and index.
`renderHandle`Optional	`((item: T, index: number) => ComponentChildren) \| undefined`Inspect type	Renders the drag handle for a reorderable list item.
`itemAttributes`Optional	`((item: T, index: number) => JSX.HTMLAttributes<HTMLDivElement> & Record<string, unknown>) \| undefined`Inspect type	Returns additional HTML attributes for a reorderable item.
`className`Optional	`string \| undefined`	Additional CSS classes applied to the component root.
`rowClassName`Optional	`string \| ((item: T, index: number) => string) \| undefined`Inspect type	Additional CSS classes for the row part of the component.
`endClassName`Optional	`string \| undefined`	Additional CSS classes for the end part of the component.
`draggedKey`Optional	`string \| number \| undefined`	Key of the item currently being dragged.
`dropIndex`Optional	`number \| undefined`	Insertion boundary at which the current drop indicator is shown.
`empty`Optional	`ComponentChildren`Inspect type	Empty-state flag or empty-state content, according to the declared type.

ReorderList events and callbacks
Name	Type	Description
`onDragOver`Required	`(event: DragEvent, boundary: number) => void`Inspect type	Handles drag movement over an insertion boundary; receives its index.
`onDrop`Required	`(event: DragEvent, boundary: number) => void`Inspect type	Handles a drop at the supplied insertion boundary.

No component-specific imperative methods. Use props and callbacks to control this component.