Skip to content

ui/build/sortable/sortable-root.svelte

ui/build/sortable/sortable-root.svelte

Interfaces

SortableRootProps

Defined in: apps/website/.api-docs-entry/ui/build/sortable/sortable-root.svelte.d.ts:21

Root props (headless).

IMPORTANT:

  • items must be stable string IDs in display order.
  • onSort emits the new order as primitive IDs.
  • element is the caller-owned SortableJS target.

Properties

child
child: Snippet<[{
  draggedItemId: string | null;
  sortedItems: string[];
}]>;

Defined in: apps/website/.api-docs-entry/ui/build/sortable/sortable-root.svelte.d.ts:41

delay?
optional delay?: number;

Defined in: apps/website/.api-docs-entry/ui/build/sortable/sortable-root.svelte.d.ts:34

delayOnTouchOnly?
optional delayOnTouchOnly?: boolean;

Defined in: apps/website/.api-docs-entry/ui/build/sortable/sortable-root.svelte.d.ts:35

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

Defined in: apps/website/.api-docs-entry/ui/build/sortable/sortable-root.svelte.d.ts:24

disabled?
optional disabled?: boolean;

Defined in: apps/website/.api-docs-entry/ui/build/sortable/sortable-root.svelte.d.ts:33

element
element: HTMLElement | null;

Defined in: apps/website/.api-docs-entry/ui/build/sortable/sortable-root.svelte.d.ts:22

fallbackTolerance?
optional fallbackTolerance?: number;

Defined in: apps/website/.api-docs-entry/ui/build/sortable/sortable-root.svelte.d.ts:37

ghostClass?
optional ghostClass?: string;

Defined in: apps/website/.api-docs-entry/ui/build/sortable/sortable-root.svelte.d.ts:25

handle?
optional handle?: string;

Defined in: apps/website/.api-docs-entry/ui/build/sortable/sortable-root.svelte.d.ts:26

items
items: string[];

Defined in: apps/website/.api-docs-entry/ui/build/sortable/sortable-root.svelte.d.ts:23

onDragEnd?
optional onDragEnd?: (evt) => void;

Defined in: apps/website/.api-docs-entry/ui/build/sortable/sortable-root.svelte.d.ts:32

Parameters
Parameter Type
evt SortableEvent
Returns

void

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

Defined in: apps/website/.api-docs-entry/ui/build/sortable/sortable-root.svelte.d.ts:31

Parameters
Parameter Type
id string
evt SortableEvent
Returns

void

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

Defined in: apps/website/.api-docs-entry/ui/build/sortable/sortable-root.svelte.d.ts:30

Parameters
Parameter Type
orderedIds string[]
evt SortableEvent
Returns

void

scroll?
optional scroll?: boolean;

Defined in: apps/website/.api-docs-entry/ui/build/sortable/sortable-root.svelte.d.ts:38

scrollSensitivity?
optional scrollSensitivity?: number;

Defined in: apps/website/.api-docs-entry/ui/build/sortable/sortable-root.svelte.d.ts:39

scrollSpeed?
optional scrollSpeed?: number;

Defined in: apps/website/.api-docs-entry/ui/build/sortable/sortable-root.svelte.d.ts:40

sort?
optional sort?: boolean;

Defined in: apps/website/.api-docs-entry/ui/build/sortable/sortable-root.svelte.d.ts:29

sortableGroup?
optional sortableGroup?: any;

Defined in: apps/website/.api-docs-entry/ui/build/sortable/sortable-root.svelte.d.ts:28

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

touchStartThreshold?
optional touchStartThreshold?: number;

Defined in: apps/website/.api-docs-entry/ui/build/sortable/sortable-root.svelte.d.ts:36

Type Aliases

default

type default = ReturnType<typeof default>;

Defined in: apps/website/.api-docs-entry/ui/build/sortable/sortable-root.svelte.d.ts:46

SortableGroupOption

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

Defined in: apps/website/.api-docs-entry/ui/build/sortable/sortable-root.svelte.d.ts:7

SortableJS group option type — extracted from SortableJS definitions. Keep broad for flexibility; narrow in your codebase if needed.

Variables

default

const default: Component;

Defined in: apps/website/.api-docs-entry/ui/build/sortable/sortable-root.svelte.d.ts:46