sortable

Interfaces

SortableItemProps

Defined in: packages/ui/build/sortable/index.d.ts:7

Properties

child

child: Snippet<[{
  props: {
     class: string;
     data-sortable-disabled: string | undefined;
     data-sortable-id: string | number;
     isDragging: boolean;
  };
}]>;

Defined in: packages/ui/build/sortable/index.d.ts:10

disabled?

optional disabled?: boolean;

Defined in: packages/ui/build/sortable/index.d.ts:9

id

id: string | number;

Defined in: packages/ui/build/sortable/index.d.ts:8

SortableRootProps

Defined in: packages/ui/build/sortable/index.d.ts:43

Root props (headless).

IMPORTANT:

items must be primitive IDs (string | number) in display order.
onSort emits the new order as primitive IDs.
Prefer targetEl for binding; targetClass is a fallback.

Properties

child

child: Snippet<[{
  sortedItems: (string | number)[];
}]>;

Defined in: packages/ui/build/sortable/index.d.ts:63

delay?

optional delay?: number;

Defined in: packages/ui/build/sortable/index.d.ts:56

delayOnTouchOnly?

optional delayOnTouchOnly?: boolean;

Defined in: packages/ui/build/sortable/index.d.ts:57

direction?

optional direction?: "vertical" | "horizontal";

Defined in: packages/ui/build/sortable/index.d.ts:46

disabled?

optional disabled?: boolean;

Defined in: packages/ui/build/sortable/index.d.ts:55

element

element: HTMLElement | null;

Defined in: packages/ui/build/sortable/index.d.ts:44

fallbackTolerance?

optional fallbackTolerance?: number;

Defined in: packages/ui/build/sortable/index.d.ts:59

ghostClass?

optional ghostClass?: string;

Defined in: packages/ui/build/sortable/index.d.ts:47

handle?

optional handle?: string;

Defined in: packages/ui/build/sortable/index.d.ts:48

items

items: (string | number)[];

Defined in: packages/ui/build/sortable/index.d.ts:45

onDragEnd?

optional onDragEnd?: (evt) => void;

Defined in: packages/ui/build/sortable/index.d.ts:54

Parameters

Parameter	Type
`evt`	`SortableEvent`

Returns

void

onDragStart?

optional onDragStart?: (id, evt) => void;

Defined in: packages/ui/build/sortable/index.d.ts:53

Parameters

Parameter	Type
`id`	`string`
`evt`	`SortableEvent`

Returns

void

onSort?

optional onSort?: (orderedIds, evt) => void;

Defined in: packages/ui/build/sortable/index.d.ts:52

Parameters

Parameter	Type
`orderedIds`	`string`[]
`evt`	`SortableEvent`

Returns

void

scroll?

optional scroll?: boolean;

Defined in: packages/ui/build/sortable/index.d.ts:60

scrollSensitivity?

optional scrollSensitivity?: number;

Defined in: packages/ui/build/sortable/index.d.ts:61

scrollSpeed?

optional scrollSpeed?: number;

Defined in: packages/ui/build/sortable/index.d.ts:62

sort?

optional sort?: boolean;

Defined in: packages/ui/build/sortable/index.d.ts:51

sortableGroup?

optional sortableGroup?: string | GroupOptions;

Defined in: packages/ui/build/sortable/index.d.ts:50

SortableJS group option (renamed to avoid Svelte {group} shorthand collisions).

touchStartThreshold?

optional touchStartThreshold?: number;

Defined in: packages/ui/build/sortable/index.d.ts:58

Type Aliases

SortableContext

type SortableContext = object;

Defined in: packages/ui/build/sortable/index.d.ts:67

Properties

Property	Type	Defined in
`draggedItemId`	`string` \| `number` \| `null`	packages/ui/build/sortable/index.d.ts:68

SortableGroupOption

type SortableGroupOption = 
  | string
  | {
  name: string;
  pull?: boolean | "clone" | ((to, from) => boolean | string);
  put?: boolean | string[] | ((to, from) => boolean);
  revertClone?: boolean;
};