Sortable List
A Polaris ResourceList made drag-and-drop reorderable with dnd-kit, keeping a dedicated drag handle so row clicks and keyboard sorting both keep working.
Preview
Code
Example.jsx
import { useState } from 'react';
import { Avatar, Badge, BlockStack, Box, Button, Card, Icon, InlineStack, ResourceItem, ResourceList, Text } from '@shopify/polaris';
import { DragHandleIcon, XIcon } from '@shopify/polaris-icons';
const SORTABLE_STYLES = `
.SortableList-Action {
opacity: 0.6;
}
.SortableList-Action:hover {
opacity: 1;
}
`;
const TONE_BY_STATUS = { active: 'success', draft: 'info' };
const SortableRow = ({ id, title, status, onRemove }) => {
const { attributes, listeners, setNodeRef, transform, transition, isDragging } = useSortable({
id,
});
const style = {
...(transform
? { transform: `translate3d(${transform.x}px, ${transform.y}px, 0)`, transition }
: {}),
zIndex: isDragging ? 1000 : 0,
position: 'relative',
};
return (
<div ref={setNodeRef} style={style}>
<ResourceItem id={String(id)} accessibilityLabel={`View details for ${title}`} onClick={() => null}>
<InlineStack align="space-between" blockAlign="center">
<InlineStack gap="400" blockAlign="center">
<div
{...attributes}
{...listeners}
onClick={(event) => event.stopPropagation()}
className="SortableList-Action"
style={{ touchAction: 'none', display: 'flex' }}
>
<Icon source={DragHandleIcon} />
</div>
<Avatar size="md" name={title} />
<Text variant="bodyMd" as="h3">
{title}
</Text>
</InlineStack>
<InlineStack gap="400" blockAlign="center">
<Badge tone={TONE_BY_STATUS[status]} size="small">
{`${status.charAt(0).toUpperCase()}${status.slice(1)}`}
</Badge>
<div
className="SortableList-Action"
onClick={(event) => {
event.stopPropagation();
onRemove(id);
}}
>
<Button icon={XIcon} variant="monochromePlain" accessibilityLabel={`Remove ${title}`} />
</div>
</InlineStack>
</InlineStack>
</ResourceItem>
</div>
);
};
export const Example = () => {
const [items, setItems] = useState([
{ id: 1, title: 'T-Shirt', status: 'active' },
{ id: 2, title: 'Skateboard', status: 'active' },
{ id: 3, title: 'Snowboard', status: 'archived' },
{ id: 4, title: 'Ultimate Snowboard', status: 'active' },
{ id: 5, title: 'Mechanical Pencil', status: 'draft' },
]);
const sensors = useSensors(
useSensor(PointerSensor),
useSensor(KeyboardSensor, { coordinateGetter: sortableKeyboardCoordinates }),
);
const handleDragEnd = ({ active, over }) => {
if (!over || active.id === over.id) return;
setItems((current) => {
const from = current.findIndex((item) => item.id === active.id);
const to = current.findIndex((item) => item.id === over.id);
return arrayMove(current, from, to);
});
};
return (
<Card padding="0">
<style>{SORTABLE_STYLES}</style>
<BlockStack gap="300">
<Box paddingBlockStart="300" paddingInlineStart="300">
<Text as="h3" variant="headingSm">
Sortable Products
</Text>
</Box>
<DndContext
sensors={sensors}
collisionDetection={closestCenter}
onDragEnd={handleDragEnd}
modifiers={[restrictToVerticalAxis, restrictToParentElement]}
>
<SortableContext items={items} strategy={verticalListSortingStrategy}>
<ResourceList
resourceName={{ singular: 'product', plural: 'products' }}
items={items}
renderItem={(item) => (
<SortableRow
{...item}
onRemove={(id) => setItems((current) => current.filter((row) => row.id !== id))}
/>
)}
/>
</SortableContext>
</DndContext>
</BlockStack>
</Card>
);
};