This reference includes every export reachable from the npm package public entry points and every declaration member in the inventory. Search names and signatures to find the exact import path and type contract.
export identities / unique exports / reachable contracts / members / CSS variables
comins-sortable/coreexport type AfterDragReason = 'drop' | 'outside' | 'pointer-cancel' | 'escape' | 'blur' | 'disabled' | 'not-accepted' | 'nested-cycle' | 'unmounted' | 'state-not-committed' | 'destroyed' | 'error';dist/core/model.d.ts:91
comins-sortable/coreexport interface AfterDragResult {
status: 'dropped' | 'cancelled' | 'rejected';
reason: AfterDragReason;
change?: SortableChange;
}dist/core/model.d.ts:92
comins-sortable/coreexport declare function buildCopyChange(sourceItemIds: readonly SortableId[], destinationItemIds: readonly SortableId[], source: SortableLocation, destination: SortableLocation, itemId: SortableId): SortableChange;dist/core/operations.d.ts:9
comins-sortable/coreexport type CopyItem<T> = (item: T, context: CopyItemContext) => T;dist/core/model.d.ts:80
comins-sortable/coreexport interface CopyItemContext extends DragContext {
destination: SortableLocation;
}dist/core/model.d.ts:77
comins-sortableexport declare function createSortable(element: Element | string, options: VanillaSortableOptions): Sortable;dist/vanilla/create-sortable.d.ts:2
comins-sortable/corecomins-sortable/svelteexport declare function createSortableScope(options?: SortableScopeOptions): SortableScope;export declare function createSortableScope<T>(options?: SvelteSortableScopeOptions<T>): SvelteSortableScope<T>;dist/core/scope.d.ts:3 · dist/svelte/scope.d.ts:20
comins-sortable/coreexport declare function createSortableTree<T>(options: SortableTreeOptions<T>): SortableTree<T>;dist/core/tree.d.ts:23
comins-sortable/coreexport interface DragContext {
itemId: SortableId;
source: SortableLocation;
destination: SortableLocation | null;
pointer: PointerSnapshot;
}dist/core/model.d.ts:71
comins-sortable/coreexport type FrameworkSortableChange<T> = SortableChange & {
updates: readonly SortableAreaUpdate<T>[];
};dist/core/model.d.ts:57
comins-sortable/coreexport interface InsertDragAreaEvent extends DragContext {
previousDestination: SortableLocation | null;
destination: SortableLocation;
}dist/core/model.d.ts:87
comins-sortable/coreexport type ItemKey<T> = keyof T | ((item: T) => SortableId);dist/core/model.d.ts:2
comins-sortable/coreexport interface PointerSnapshot {
type: 'mouse' | 'touch' | 'pen';
clientX: number;
clientY: number;
deltaX: number;
deltaY: number;
altKey: boolean;
ctrlKey: boolean;
metaKey: boolean;
shiftKey: boolean;
}dist/core/model.d.ts:60
comins-sortable/coreexport declare function reorder<T>(items: readonly T[], fromIndex: number, toIndex: number): readonly T[];dist/core/operations.d.ts:2
comins-sortable/svelteexport declare function sortable<T>(node: HTMLElement, initialOptions: SvelteSortableOptions<T>): SvelteActionReturn<T>;dist/svelte/sortable.d.ts:41
comins-sortableexport interface Sortable {
registerArea(element: Element | string, options: VanillaSortableAreaOptions): () => void;
updateArea(areaId: string, patch: VanillaSortableAreaPatch): void;
refreshArea(areaId: string): void;
cancel(): void;
destroy(): void;
}dist/vanilla/types.d.ts:9
comins-sortable/coreexport type SortableAnimation = false | number | SortableAnimationOptions;dist/core/model.d.ts:17
comins-sortable/coreexport interface SortableAnimationOptions {
duration: number;
easing?: string;
}dist/core/model.d.ts:13
comins-sortable/reactcomins-sortable/vueexport declare function SortableArea<T>(props: SortableAreaProps<T>): ReactElement;SortableArea: VueSortableAreaComponentdist/react/SortableArea.d.ts:32 · dist/vue/SortableArea.d.ts:153
comins-sortable/coreexport interface SortableAreaOptions {
areaId: string;
group?: SortableGroup;
item: string;
getItemId?: (element: Element) => SortableId;
direction?: SortableDirection;
disabled?: boolean;
handle?: string;
ignore?: string;
activationDistance?: number;
emptyInsertThreshold?: number;
/** Fraction of a hovered item that activates insertion, from 0 through 1. */
swapThreshold?: number;
/** Move threshold activation from the item center toward its edges. */
invertSwap?: boolean;
/** Exchange the dragged and hovered items instead of insertion sorting. */
swap?: boolean;
/** Enable modifier selection and moving selected items as one ordered group. */
multiDrag?: boolean;
/** Class applied to selected items. */
selectedClass?: string;
autoScroll?: boolean;
animation?: SortableAnimation;
placeholder?: SortablePlaceholderOptions;
parent?: SortableParentLocation;
accept?: (context: DragContext) => boolean;
prepareCopy?: (context: CopyItemContext) => SortableId;
}dist/core/model.d.ts:97
comins-sortable/coreexport type SortableAreaPatch = Partial<Omit<SortableAreaOptions, 'areaId'>>;dist/core/model.d.ts:125
comins-sortable/reactexport interface SortableAreaProps<T> {
areaId: string;
group?: SortableGroup;
items: readonly T[];
itemKey: ItemKey<T>;
onItemsChange(items: readonly T[]): void;
children(item: T, index: number): ReactElement;
direction?: SortableDirection;
disabled?: boolean;
handle?: string;
ignore?: string;
activationDistance?: number;
emptyInsertThreshold?: number;
swapThreshold?: number;
invertSwap?: boolean;
swap?: boolean;
multiDrag?: boolean;
selectedClass?: string;
autoScroll?: boolean;
accept?: (context: DragContext) => boolean;
copyItem?: CopyItem<T>;
animation?: SortableAnimation;
placeholder?: SortablePlaceholderOptions;
parent?: SortableParentLocation;
as?: ElementType;
areaProps?: HTMLAttributes<HTMLElement>;
header?: ReactNode;
footer?: ReactNode;
}dist/react/SortableArea.d.ts:3
comins-sortable/coreexport interface SortableAreaUpdate<T> {
areaId: string;
items: readonly T[];
}dist/core/model.d.ts:53
comins-sortable/coreexport type SortableChange = SortableMoveChange | SortableCopyChange | SortableSwapChange;dist/core/model.d.ts:52
comins-sortable/coreexport interface SortableCopyChange extends SortableChangeBase {
operation: 'copy';
sourceItemId: SortableId;
}dist/core/model.d.ts:44
comins-sortable/coreexport type SortableDirection = 'vertical' | 'horizontal' | 'grid' | 'auto';dist/core/model.d.ts:3
comins-sortable/coreexport declare class SortableError extends Error {
readonly code: SortableErrorCode;
constructor(code: SortableErrorCode);
}dist/core/errors.d.ts:2
comins-sortable/coreexport type SortableErrorCode = 'INVALID_ELEMENT' | 'DUPLICATE_AREA_ID' | 'DUPLICATE_ITEM_ID' | 'MISSING_ITEM_ID' | 'INVALID_OPTION';dist/core/errors.d.ts:1
comins-sortable/coreexport type SortableGroup = string | SortableGroupOptions;dist/core/model.d.ts:86
comins-sortable/coreexport interface SortableGroupOptions {
name: string;
pull?: false | SortableTransferMode | ((context: DragContext) => false | SortableTransferMode);
put?: boolean | readonly string[] | ((context: DragContext) => boolean);
}dist/core/model.d.ts:81
comins-sortable/coreexport type SortableId = string | number;dist/core/model.d.ts:1
comins-sortable/coreexport interface SortableLocation {
areaId: string;
index: number;
}dist/core/model.d.ts:5
comins-sortable/coreexport type SortableMoveChange = SortableReorderChange | SortableTransferChange;dist/core/model.d.ts:43
comins-sortable/coreexport interface SortableOrder {
areaId: string;
itemIds: readonly SortableId[];
}dist/core/model.d.ts:25
comins-sortable/coreexport interface SortableParentLocation {
areaId: string;
itemId: SortableId;
}dist/core/model.d.ts:9
comins-sortable/coreexport interface SortablePlaceholderOptions {
/** Consumer classes added alongside the stable Comins placeholder class. */
className?: string;
/** Optional visual preset. Skeleton is drag feedback, not a loading state. */
preset?: SortablePlaceholderPreset;
}dist/core/model.d.ts:19
comins-sortable/coreexport type SortablePlaceholderPreset = 'default' | 'skeleton';dist/core/model.d.ts:18
comins-sortable/coreexport interface SortableReorderChange extends SortableChangeBase {
operation: 'reorder';
}dist/core/model.d.ts:37
comins-sortable/reactcomins-sortable/vueexport declare function SortableRoot<T>(props: SortableRootProps<T>): ReactElement;SortableRoot: VueSortableRootComponentdist/react/SortableRoot.d.ts:7 · dist/vue/SortableRoot.d.ts:35
comins-sortable/reactexport interface SortableRootProps<T> extends Omit<SortableScopeOptions, 'onChange'> {
children?: ReactNode;
onChange?: (change: FrameworkSortableChange<T>) => void;
}dist/react/SortableRoot.d.ts:3
comins-sortable/coreexport interface SortableScope {
registerArea(element: Element, options: SortableAreaOptions): () => void;
updateArea(areaId: string, patch: SortableAreaPatch): void;
refreshArea?(areaId: string): void;
cancel(): void;
destroy(): void;
}dist/core/model.d.ts:135
comins-sortable/coreexport interface SortableScopeOptions {
onBeforeDragStart?: (context: DragContext) => boolean | void;
onDragStart?: (context: DragContext) => void;
onDrag?: (context: DragContext) => void;
onInsertDragArea?: (event: InsertDragAreaEvent) => void;
onChange?: (change: SortableChange) => void;
onAfterDrag?: (result: AfterDragResult) => void;
onError?: (error: unknown) => void;
}dist/core/model.d.ts:126
comins-sortable/coreexport interface SortableSwapChange extends SortableChangeBase {
operation: 'swap';
swapItemId: SortableId;
}dist/core/model.d.ts:48
comins-sortable/coreexport interface SortableTransferChange extends SortableChangeBase {
operation: 'transfer';
}dist/core/model.d.ts:40
comins-sortable/coreexport type SortableTransferMode = 'move' | 'copy';dist/core/model.d.ts:4
comins-sortable/coreexport interface SortableTree<T> {
getAreas(nodes: readonly T[]): readonly SortableTreeArea<T>[];
updateArea(nodes: readonly T[], areaId: string, items: readonly T[]): readonly T[];
applyChange(nodes: readonly T[], change: FrameworkSortableChange<T>): readonly T[];
}dist/core/tree.d.ts:14
comins-sortable/coreexport interface SortableTreeArea<T> {
areaId: string;
items: readonly T[];
parent?: SortableParentLocation;
}dist/core/tree.d.ts:9
comins-sortable/coreexport interface SortableTreeOptions<T> {
rootAreaId: string;
getNodeId(node: T): SortableId;
getChildren(node: T): readonly T[];
withChildren(node: T, children: readonly T[]): T;
getChildrenAreaId(node: T): string;
}dist/core/tree.d.ts:2
comins-sortable/svelteexport interface SvelteActionReturn<T> {
update(options: SvelteSortableOptions<T>): void;
destroy(): void;
}dist/svelte/sortable.d.ts:30
comins-sortable/svelteexport interface SvelteSortableOptions<T> {
scope?: SvelteSortableScope<T>;
areaId: string;
group?: SortableGroup;
items: readonly T[];
itemKey: ItemKey<T>;
onItemsChange(items: readonly T[]): void;
direction?: SortableDirection;
disabled?: boolean;
handle?: string;
ignore?: string;
activationDistance?: number;
emptyInsertThreshold?: number;
swapThreshold?: number;
invertSwap?: boolean;
swap?: boolean;
multiDrag?: boolean;
selectedClass?: string;
autoScroll?: boolean;
accept?: (context: DragContext) => boolean;
copyItem?: CopyItem<T>;
animation?: SortableAnimation;
placeholder?: SortablePlaceholderOptions;
parent?: SortableParentLocation;
item?: string;
}dist/svelte/sortable.d.ts:4
comins-sortable/svelteexport interface SvelteSortableScope<T> {
readonly [svelteScopeBrand]: (item: T) => T;
cancel(): void;
destroy(): void;
}dist/svelte/scope.d.ts:15
comins-sortable/svelteexport interface SvelteSortableScopeOptions<T> extends Omit<SortableScopeOptions, 'onChange'> {
onChange?: (change: FrameworkSortableChange<T>) => void;
}dist/svelte/scope.d.ts:4
comins-sortable/coreexport declare function transfer<T>(sourceItems: readonly T[], destinationItems: readonly T[], sourceIndex: number, destinationIndex: number): {
sourceItems: readonly T[];
destinationItems: readonly T[];
};dist/core/operations.d.ts:3
comins-sortableexport interface VanillaSortableAreaOptions extends Omit<SortableAreaOptions, 'getItemId' | 'prepareCopy'> {
getItemId?: (element: Element) => SortableId;
copyElement?: (source: Element, context: CopyItemContext) => Element;
}dist/vanilla/types.d.ts:2
comins-sortableexport type VanillaSortableAreaPatch = Partial<Omit<VanillaSortableAreaOptions, 'areaId'>>;dist/vanilla/types.d.ts:6
comins-sortableexport interface VanillaSortableOptions extends VanillaSortableAreaOptions, SortableScopeOptions {
}dist/vanilla/types.d.ts:7
comins-sortable/vueexport type VueSortableAreaComponent = Omit<typeof SortableAreaComponent, never> & {
new <T>(props: VueSortableAreaProps<T> & VNodeProps & AllowedComponentProps & ComponentCustomProps): Omit<InstanceType<typeof SortableAreaComponent>, '$props' | '$slots' | '$emit'> & {
$props: VueSortableAreaProps<T> & VNodeProps & AllowedComponentProps & ComponentCustomProps & {
'onUpdate:modelValue'?: (items: T[]) => void;
};
$slots: VueSortableAreaSlots<T>;
$emit(event: 'update:modelValue', items: T[]): void;
};
};dist/vue/SortableArea.d.ts:144
comins-sortable/vueexport interface VueSortableAreaProps<T> {
modelValue: readonly T[];
areaId: string;
group?: SortableGroup;
itemKey: ItemKey<T>;
direction?: SortableDirection;
disabled?: boolean;
handle?: string;
ignore?: string;
activationDistance?: number;
emptyInsertThreshold?: number;
swapThreshold?: number;
invertSwap?: boolean;
swap?: boolean;
multiDrag?: boolean;
selectedClass?: string;
autoScroll?: boolean;
accept?: (context: DragContext) => boolean;
copyItem?: CopyItem<T>;
animation?: SortableAnimation;
placeholder?: SortablePlaceholderOptions;
parent?: SortableParentLocation;
tag?: string | Component;
componentProps?: Readonly<Record<string, unknown>>;
}dist/vue/SortableArea.d.ts:3
comins-sortable/vueexport interface VueSortableAreaSlots<T> {
item(props: {
item: T;
index: number;
}): VNodeChild;
header?(): VNodeChild;
footer?(): VNodeChild;
}dist/vue/SortableArea.d.ts:28
comins-sortable/vueexport type VueSortableRootComponent = typeof SortableRootComponent & {
new <T>(): {
$props: VueSortableRootProps<T>;
$slots: VueSortableRootSlots;
$emit(event: 'change', change: FrameworkSortableChange<T>): void;
};
};dist/vue/SortableRoot.d.ts:28
comins-sortable/vueexport interface VueSortableRootOptions<T> extends Omit<SortableScopeOptions, 'onChange'> {
onChange?: (change: FrameworkSortableChange<T>) => void;
}dist/vue/context.d.ts:5
comins-sortable/vueexport interface VueSortableRootProps<T> extends Omit<SortableScopeOptions, 'onChange'> {
onChange?: (change: FrameworkSortableChange<T>) => void;
}dist/vue/SortableRoot.d.ts:3
comins-sortable/vueexport interface VueSortableRootSlots {
default?(): VNodeChild;
}dist/vue/SortableRoot.d.ts:6
Package-owned declarations and members reachable from public export signatures.
export type SortableErrorCode = 'INVALID_ELEMENT' | 'DUPLICATE_AREA_ID' | 'DUPLICATE_ITEM_ID' | 'MISSING_ITEM_ID' | 'INVALID_OPTION';dist/core/errors.d.ts:1
export declare class SortableError extends Error {
readonly code: SortableErrorCode;
constructor(code: SortableErrorCode);
}dist/core/errors.d.ts:2
readonly code: SortableErrorCode;dist/core/errors.d.ts:3constructor(code: SortableErrorCode);dist/core/errors.d.ts:4export type SortableId = string | number;dist/core/model.d.ts:1
export type SortableAreaPatch = Partial<Omit<SortableAreaOptions, 'areaId'>>;dist/core/model.d.ts:125
export interface SortableScopeOptions {
onBeforeDragStart?: (context: DragContext) => boolean | void;
onDragStart?: (context: DragContext) => void;
onDrag?: (context: DragContext) => void;
onInsertDragArea?: (event: InsertDragAreaEvent) => void;
onChange?: (change: SortableChange) => void;
onAfterDrag?: (result: AfterDragResult) => void;
onError?: (error: unknown) => void;
}dist/core/model.d.ts:126
onBeforeDragStart?: (context: DragContext) => boolean | void;dist/core/model.d.ts:127onDragStart?: (context: DragContext) => void;dist/core/model.d.ts:128onDrag?: (context: DragContext) => void;dist/core/model.d.ts:129onInsertDragArea?: (event: InsertDragAreaEvent) => void;dist/core/model.d.ts:130onChange?: (change: SortableChange) => void;dist/core/model.d.ts:131onAfterDrag?: (result: AfterDragResult) => void;dist/core/model.d.ts:132onError?: (error: unknown) => void;dist/core/model.d.ts:133export interface SortableAnimationOptions {
duration: number;
easing?: string;
}dist/core/model.d.ts:13
duration: number;dist/core/model.d.ts:14easing?: string;dist/core/model.d.ts:15export interface SortableScope {
registerArea(element: Element, options: SortableAreaOptions): () => void;
updateArea(areaId: string, patch: SortableAreaPatch): void;
refreshArea?(areaId: string): void;
cancel(): void;
destroy(): void;
}dist/core/model.d.ts:135
registerArea(element: Element, options: SortableAreaOptions): () => void;dist/core/model.d.ts:136updateArea(areaId: string, patch: SortableAreaPatch): void;dist/core/model.d.ts:137refreshArea?(areaId: string): void;dist/core/model.d.ts:138cancel(): void;dist/core/model.d.ts:139destroy(): void;dist/core/model.d.ts:140export type SortableAnimation = false | number | SortableAnimationOptions;dist/core/model.d.ts:17
export type SortablePlaceholderPreset = 'default' | 'skeleton';dist/core/model.d.ts:18
export interface SortablePlaceholderOptions {
/** Consumer classes added alongside the stable Comins placeholder class. */
className?: string;
/** Optional visual preset. Skeleton is drag feedback, not a loading state. */
preset?: SortablePlaceholderPreset;
}dist/core/model.d.ts:19
className?: string;dist/core/model.d.ts:21preset?: SortablePlaceholderPreset;dist/core/model.d.ts:23export type ItemKey<T> = keyof T | ((item: T) => SortableId);dist/core/model.d.ts:2
export interface SortableOrder {
areaId: string;
itemIds: readonly SortableId[];
}dist/core/model.d.ts:25
areaId: string;dist/core/model.d.ts:26itemIds: readonly SortableId[];dist/core/model.d.ts:27interface SortableChangeBase {
itemId: SortableId;
/** All items moved by a multi-drag, in their original visual order. */
itemIds?: readonly SortableId[];
source: SortableLocation;
destination: SortableLocation;
orders: readonly SortableOrder[];
}dist/core/model.d.ts:29
itemId: SortableId;dist/core/model.d.ts:30itemIds?: readonly SortableId[];dist/core/model.d.ts:32source: SortableLocation;dist/core/model.d.ts:33destination: SortableLocation;dist/core/model.d.ts:34orders: readonly SortableOrder[];dist/core/model.d.ts:35export type SortableDirection = 'vertical' | 'horizontal' | 'grid' | 'auto';dist/core/model.d.ts:3
export interface SortableReorderChange extends SortableChangeBase {
operation: 'reorder';
}dist/core/model.d.ts:37
operation: 'reorder';dist/core/model.d.ts:38export type SortableTransferMode = 'move' | 'copy';dist/core/model.d.ts:4
export interface SortableTransferChange extends SortableChangeBase {
operation: 'transfer';
}dist/core/model.d.ts:40
operation: 'transfer';dist/core/model.d.ts:41export type SortableMoveChange = SortableReorderChange | SortableTransferChange;dist/core/model.d.ts:43
export interface SortableCopyChange extends SortableChangeBase {
operation: 'copy';
sourceItemId: SortableId;
}dist/core/model.d.ts:44
operation: 'copy';dist/core/model.d.ts:45sourceItemId: SortableId;dist/core/model.d.ts:46export interface SortableSwapChange extends SortableChangeBase {
operation: 'swap';
swapItemId: SortableId;
}dist/core/model.d.ts:48
operation: 'swap';dist/core/model.d.ts:49swapItemId: SortableId;dist/core/model.d.ts:50export interface SortableLocation {
areaId: string;
index: number;
}dist/core/model.d.ts:5
areaId: string;dist/core/model.d.ts:6index: number;dist/core/model.d.ts:7export type SortableChange = SortableMoveChange | SortableCopyChange | SortableSwapChange;dist/core/model.d.ts:52
export interface SortableAreaUpdate<T> {
areaId: string;
items: readonly T[];
}dist/core/model.d.ts:53
areaId: string;dist/core/model.d.ts:54items: readonly T[];dist/core/model.d.ts:55export type FrameworkSortableChange<T> = SortableChange & {
updates: readonly SortableAreaUpdate<T>[];
};dist/core/model.d.ts:57
export interface PointerSnapshot {
type: 'mouse' | 'touch' | 'pen';
clientX: number;
clientY: number;
deltaX: number;
deltaY: number;
altKey: boolean;
ctrlKey: boolean;
metaKey: boolean;
shiftKey: boolean;
}dist/core/model.d.ts:60
type: 'mouse' | 'touch' | 'pen';dist/core/model.d.ts:61clientX: number;dist/core/model.d.ts:62clientY: number;dist/core/model.d.ts:63deltaX: number;dist/core/model.d.ts:64deltaY: number;dist/core/model.d.ts:65altKey: boolean;dist/core/model.d.ts:66ctrlKey: boolean;dist/core/model.d.ts:67metaKey: boolean;dist/core/model.d.ts:68shiftKey: boolean;dist/core/model.d.ts:69export interface DragContext {
itemId: SortableId;
source: SortableLocation;
destination: SortableLocation | null;
pointer: PointerSnapshot;
}dist/core/model.d.ts:71
itemId: SortableId;dist/core/model.d.ts:72source: SortableLocation;dist/core/model.d.ts:73destination: SortableLocation | null;dist/core/model.d.ts:74pointer: PointerSnapshot;dist/core/model.d.ts:75export interface CopyItemContext extends DragContext {
destination: SortableLocation;
}dist/core/model.d.ts:77
destination: SortableLocation;dist/core/model.d.ts:78export type CopyItem<T> = (item: T, context: CopyItemContext) => T;dist/core/model.d.ts:80
export interface SortableGroupOptions {
name: string;
pull?: false | SortableTransferMode | ((context: DragContext) => false | SortableTransferMode);
put?: boolean | readonly string[] | ((context: DragContext) => boolean);
}dist/core/model.d.ts:81
name: string;dist/core/model.d.ts:82pull?: false | SortableTransferMode | ((context: DragContext) => false | SortableTransferMode);dist/core/model.d.ts:83put?: boolean | readonly string[] | ((context: DragContext) => boolean);dist/core/model.d.ts:84export type SortableGroup = string | SortableGroupOptions;dist/core/model.d.ts:86
export interface InsertDragAreaEvent extends DragContext {
previousDestination: SortableLocation | null;
destination: SortableLocation;
}dist/core/model.d.ts:87
previousDestination: SortableLocation | null;dist/core/model.d.ts:88destination: SortableLocation;dist/core/model.d.ts:89export interface SortableParentLocation {
areaId: string;
itemId: SortableId;
}dist/core/model.d.ts:9
areaId: string;dist/core/model.d.ts:10itemId: SortableId;dist/core/model.d.ts:11export type AfterDragReason = 'drop' | 'outside' | 'pointer-cancel' | 'escape' | 'blur' | 'disabled' | 'not-accepted' | 'nested-cycle' | 'unmounted' | 'state-not-committed' | 'destroyed' | 'error';dist/core/model.d.ts:91
export interface AfterDragResult {
status: 'dropped' | 'cancelled' | 'rejected';
reason: AfterDragReason;
change?: SortableChange;
}dist/core/model.d.ts:92
status: 'dropped' | 'cancelled' | 'rejected';dist/core/model.d.ts:93reason: AfterDragReason;dist/core/model.d.ts:94change?: SortableChange;dist/core/model.d.ts:95export interface SortableAreaOptions {
areaId: string;
group?: SortableGroup;
item: string;
getItemId?: (element: Element) => SortableId;
direction?: SortableDirection;
disabled?: boolean;
handle?: string;
ignore?: string;
activationDistance?: number;
emptyInsertThreshold?: number;
/** Fraction of a hovered item that activates insertion, from 0 through 1. */
swapThreshold?: number;
/** Move threshold activation from the item center toward its edges. */
invertSwap?: boolean;
/** Exchange the dragged and hovered items instead of insertion sorting. */
swap?: boolean;
/** Enable modifier selection and moving selected items as one ordered group. */
multiDrag?: boolean;
/** Class applied to selected items. */
selectedClass?: string;
autoScroll?: boolean;
animation?: SortableAnimation;
placeholder?: SortablePlaceholderOptions;
parent?: SortableParentLocation;
accept?: (context: DragContext) => boolean;
prepareCopy?: (context: CopyItemContext) => SortableId;
}dist/core/model.d.ts:97
areaId: string;dist/core/model.d.ts:98group?: SortableGroup;dist/core/model.d.ts:99item: string;dist/core/model.d.ts:100getItemId?: (element: Element) => SortableId;dist/core/model.d.ts:101direction?: SortableDirection;dist/core/model.d.ts:102disabled?: boolean;dist/core/model.d.ts:103handle?: string;dist/core/model.d.ts:104ignore?: string;dist/core/model.d.ts:105activationDistance?: number;dist/core/model.d.ts:106emptyInsertThreshold?: number;dist/core/model.d.ts:107swapThreshold?: number;dist/core/model.d.ts:109invertSwap?: boolean;dist/core/model.d.ts:111swap?: boolean;dist/core/model.d.ts:113multiDrag?: boolean;dist/core/model.d.ts:115selectedClass?: string;dist/core/model.d.ts:117autoScroll?: boolean;dist/core/model.d.ts:118animation?: SortableAnimation;dist/core/model.d.ts:119placeholder?: SortablePlaceholderOptions;dist/core/model.d.ts:120parent?: SortableParentLocation;dist/core/model.d.ts:121accept?: (context: DragContext) => boolean;dist/core/model.d.ts:122prepareCopy?: (context: CopyItemContext) => SortableId;dist/core/model.d.ts:123export declare function reorder<T>(items: readonly T[], fromIndex: number, toIndex: number): readonly T[];dist/core/operations.d.ts:2
export declare function transfer<T>(sourceItems: readonly T[], destinationItems: readonly T[], sourceIndex: number, destinationIndex: number): {
sourceItems: readonly T[];
destinationItems: readonly T[];
};dist/core/operations.d.ts:3
export declare function buildCopyChange(sourceItemIds: readonly SortableId[], destinationItemIds: readonly SortableId[], source: SortableLocation, destination: SortableLocation, itemId: SortableId): SortableChange;dist/core/operations.d.ts:9
export declare function createSortableScope(options?: SortableScopeOptions): SortableScope;dist/core/scope.d.ts:3
export interface SortableTree<T> {
getAreas(nodes: readonly T[]): readonly SortableTreeArea<T>[];
updateArea(nodes: readonly T[], areaId: string, items: readonly T[]): readonly T[];
applyChange(nodes: readonly T[], change: FrameworkSortableChange<T>): readonly T[];
}dist/core/tree.d.ts:14
getAreas(nodes: readonly T[]): readonly SortableTreeArea<T>[];dist/core/tree.d.ts:15updateArea(nodes: readonly T[], areaId: string, items: readonly T[]): readonly T[];dist/core/tree.d.ts:16applyChange(nodes: readonly T[], change: FrameworkSortableChange<T>): readonly T[];dist/core/tree.d.ts:17export interface SortableTreeOptions<T> {
rootAreaId: string;
getNodeId(node: T): SortableId;
getChildren(node: T): readonly T[];
withChildren(node: T, children: readonly T[]): T;
getChildrenAreaId(node: T): string;
}dist/core/tree.d.ts:2
rootAreaId: string;dist/core/tree.d.ts:3getNodeId(node: T): SortableId;dist/core/tree.d.ts:4getChildren(node: T): readonly T[];dist/core/tree.d.ts:5withChildren(node: T, children: readonly T[]): T;dist/core/tree.d.ts:6getChildrenAreaId(node: T): string;dist/core/tree.d.ts:7export declare function createSortableTree<T>(options: SortableTreeOptions<T>): SortableTree<T>;dist/core/tree.d.ts:23
export interface SortableTreeArea<T> {
areaId: string;
items: readonly T[];
parent?: SortableParentLocation;
}dist/core/tree.d.ts:9
areaId: string;dist/core/tree.d.ts:10items: readonly T[];dist/core/tree.d.ts:11parent?: SortableParentLocation;dist/core/tree.d.ts:12export interface SortableAreaProps<T> {
areaId: string;
group?: SortableGroup;
items: readonly T[];
itemKey: ItemKey<T>;
onItemsChange(items: readonly T[]): void;
children(item: T, index: number): ReactElement;
direction?: SortableDirection;
disabled?: boolean;
handle?: string;
ignore?: string;
activationDistance?: number;
emptyInsertThreshold?: number;
swapThreshold?: number;
invertSwap?: boolean;
swap?: boolean;
multiDrag?: boolean;
selectedClass?: string;
autoScroll?: boolean;
accept?: (context: DragContext) => boolean;
copyItem?: CopyItem<T>;
animation?: SortableAnimation;
placeholder?: SortablePlaceholderOptions;
parent?: SortableParentLocation;
as?: ElementType;
areaProps?: HTMLAttributes<HTMLElement>;
header?: ReactNode;
footer?: ReactNode;
}dist/react/SortableArea.d.ts:3
areaId: string;dist/react/SortableArea.d.ts:4group?: SortableGroup;dist/react/SortableArea.d.ts:5items: readonly T[];dist/react/SortableArea.d.ts:6itemKey: ItemKey<T>;dist/react/SortableArea.d.ts:7onItemsChange(items: readonly T[]): void;dist/react/SortableArea.d.ts:8children(item: T, index: number): ReactElement;dist/react/SortableArea.d.ts:9direction?: SortableDirection;dist/react/SortableArea.d.ts:10disabled?: boolean;dist/react/SortableArea.d.ts:11handle?: string;dist/react/SortableArea.d.ts:12ignore?: string;dist/react/SortableArea.d.ts:13activationDistance?: number;dist/react/SortableArea.d.ts:14emptyInsertThreshold?: number;dist/react/SortableArea.d.ts:15swapThreshold?: number;dist/react/SortableArea.d.ts:16invertSwap?: boolean;dist/react/SortableArea.d.ts:17swap?: boolean;dist/react/SortableArea.d.ts:18multiDrag?: boolean;dist/react/SortableArea.d.ts:19selectedClass?: string;dist/react/SortableArea.d.ts:20autoScroll?: boolean;dist/react/SortableArea.d.ts:21accept?: (context: DragContext) => boolean;dist/react/SortableArea.d.ts:22copyItem?: CopyItem<T>;dist/react/SortableArea.d.ts:23animation?: SortableAnimation;dist/react/SortableArea.d.ts:24placeholder?: SortablePlaceholderOptions;dist/react/SortableArea.d.ts:25parent?: SortableParentLocation;dist/react/SortableArea.d.ts:26as?: ElementType;dist/react/SortableArea.d.ts:27areaProps?: HTMLAttributes<HTMLElement>;dist/react/SortableArea.d.ts:28header?: ReactNode;dist/react/SortableArea.d.ts:29footer?: ReactNode;dist/react/SortableArea.d.ts:30export declare function SortableArea<T>(props: SortableAreaProps<T>): ReactElement;dist/react/SortableArea.d.ts:32
export interface SortableRootProps<T> extends Omit<SortableScopeOptions, 'onChange'> {
children?: ReactNode;
onChange?: (change: FrameworkSortableChange<T>) => void;
}dist/react/SortableRoot.d.ts:3
children?: ReactNode;dist/react/SortableRoot.d.ts:4onChange?: (change: FrameworkSortableChange<T>) => void;dist/react/SortableRoot.d.ts:5export declare function SortableRoot<T>(props: SortableRootProps<T>): ReactElement;dist/react/SortableRoot.d.ts:7
svelteScopeBrand: unique symboldist/svelte/scope.d.ts:14
export interface SvelteSortableScope<T> {
readonly [svelteScopeBrand]: (item: T) => T;
cancel(): void;
destroy(): void;
}dist/svelte/scope.d.ts:15
readonly [svelteScopeBrand]: (item: T) => T;dist/svelte/scope.d.ts:16cancel(): void;dist/svelte/scope.d.ts:17destroy(): void;dist/svelte/scope.d.ts:18export declare function createSortableScope<T>(options?: SvelteSortableScopeOptions<T>): SvelteSortableScope<T>;dist/svelte/scope.d.ts:20
export interface SvelteSortableScopeOptions<T> extends Omit<SortableScopeOptions, 'onChange'> {
onChange?: (change: FrameworkSortableChange<T>) => void;
}dist/svelte/scope.d.ts:4
onChange?: (change: FrameworkSortableChange<T>) => void;dist/svelte/scope.d.ts:5export interface SvelteActionReturn<T> {
update(options: SvelteSortableOptions<T>): void;
destroy(): void;
}dist/svelte/sortable.d.ts:30
update(options: SvelteSortableOptions<T>): void;dist/svelte/sortable.d.ts:31destroy(): void;dist/svelte/sortable.d.ts:32export interface SvelteSortableOptions<T> {
scope?: SvelteSortableScope<T>;
areaId: string;
group?: SortableGroup;
items: readonly T[];
itemKey: ItemKey<T>;
onItemsChange(items: readonly T[]): void;
direction?: SortableDirection;
disabled?: boolean;
handle?: string;
ignore?: string;
activationDistance?: number;
emptyInsertThreshold?: number;
swapThreshold?: number;
invertSwap?: boolean;
swap?: boolean;
multiDrag?: boolean;
selectedClass?: string;
autoScroll?: boolean;
accept?: (context: DragContext) => boolean;
copyItem?: CopyItem<T>;
animation?: SortableAnimation;
placeholder?: SortablePlaceholderOptions;
parent?: SortableParentLocation;
item?: string;
}dist/svelte/sortable.d.ts:4
scope?: SvelteSortableScope<T>;dist/svelte/sortable.d.ts:5areaId: string;dist/svelte/sortable.d.ts:6group?: SortableGroup;dist/svelte/sortable.d.ts:7items: readonly T[];dist/svelte/sortable.d.ts:8itemKey: ItemKey<T>;dist/svelte/sortable.d.ts:9onItemsChange(items: readonly T[]): void;dist/svelte/sortable.d.ts:10direction?: SortableDirection;dist/svelte/sortable.d.ts:11disabled?: boolean;dist/svelte/sortable.d.ts:12handle?: string;dist/svelte/sortable.d.ts:13ignore?: string;dist/svelte/sortable.d.ts:14activationDistance?: number;dist/svelte/sortable.d.ts:15emptyInsertThreshold?: number;dist/svelte/sortable.d.ts:16swapThreshold?: number;dist/svelte/sortable.d.ts:17invertSwap?: boolean;dist/svelte/sortable.d.ts:18swap?: boolean;dist/svelte/sortable.d.ts:19multiDrag?: boolean;dist/svelte/sortable.d.ts:20selectedClass?: string;dist/svelte/sortable.d.ts:21autoScroll?: boolean;dist/svelte/sortable.d.ts:22accept?: (context: DragContext) => boolean;dist/svelte/sortable.d.ts:23copyItem?: CopyItem<T>;dist/svelte/sortable.d.ts:24animation?: SortableAnimation;dist/svelte/sortable.d.ts:25placeholder?: SortablePlaceholderOptions;dist/svelte/sortable.d.ts:26parent?: SortableParentLocation;dist/svelte/sortable.d.ts:27item?: string;dist/svelte/sortable.d.ts:28export declare function sortable<T>(node: HTMLElement, initialOptions: SvelteSortableOptions<T>): SvelteActionReturn<T>;dist/svelte/sortable.d.ts:41
export declare function createSortable(element: Element | string, options: VanillaSortableOptions): Sortable;dist/vanilla/create-sortable.d.ts:2
export interface VanillaSortableAreaOptions extends Omit<SortableAreaOptions, 'getItemId' | 'prepareCopy'> {
getItemId?: (element: Element) => SortableId;
copyElement?: (source: Element, context: CopyItemContext) => Element;
}dist/vanilla/types.d.ts:2
getItemId?: (element: Element) => SortableId;dist/vanilla/types.d.ts:3copyElement?: (source: Element, context: CopyItemContext) => Element;dist/vanilla/types.d.ts:4export type VanillaSortableAreaPatch = Partial<Omit<VanillaSortableAreaOptions, 'areaId'>>;dist/vanilla/types.d.ts:6
export interface VanillaSortableOptions extends VanillaSortableAreaOptions, SortableScopeOptions {
}dist/vanilla/types.d.ts:7
export interface Sortable {
registerArea(element: Element | string, options: VanillaSortableAreaOptions): () => void;
updateArea(areaId: string, patch: VanillaSortableAreaPatch): void;
refreshArea(areaId: string): void;
cancel(): void;
destroy(): void;
}dist/vanilla/types.d.ts:9
registerArea(element: Element | string, options: VanillaSortableAreaOptions): () => void;dist/vanilla/types.d.ts:10updateArea(areaId: string, patch: VanillaSortableAreaPatch): void;dist/vanilla/types.d.ts:11refreshArea(areaId: string): void;dist/vanilla/types.d.ts:12cancel(): void;dist/vanilla/types.d.ts:13destroy(): void;dist/vanilla/types.d.ts:14export interface VueSortableRootOptions<T> extends Omit<SortableScopeOptions, 'onChange'> {
onChange?: (change: FrameworkSortableChange<T>) => void;
}dist/vue/context.d.ts:5
onChange?: (change: FrameworkSortableChange<T>) => void;dist/vue/context.d.ts:6export type VueSortableAreaComponent = Omit<typeof SortableAreaComponent, never> & {
new <T>(props: VueSortableAreaProps<T> & VNodeProps & AllowedComponentProps & ComponentCustomProps): Omit<InstanceType<typeof SortableAreaComponent>, '$props' | '$slots' | '$emit'> & {
$props: VueSortableAreaProps<T> & VNodeProps & AllowedComponentProps & ComponentCustomProps & {
'onUpdate:modelValue'?: (items: T[]) => void;
};
$slots: VueSortableAreaSlots<T>;
$emit(event: 'update:modelValue', items: T[]): void;
};
};dist/vue/SortableArea.d.ts:144
SortableArea: VueSortableAreaComponentdist/vue/SortableArea.d.ts:153
export interface VueSortableAreaSlots<T> {
item(props: {
item: T;
index: number;
}): VNodeChild;
header?(): VNodeChild;
footer?(): VNodeChild;
}dist/vue/SortableArea.d.ts:28
item(props: {
item: T;
index: number;
}): VNodeChild;dist/vue/SortableArea.d.ts:29header?(): VNodeChild;dist/vue/SortableArea.d.ts:33footer?(): VNodeChild;dist/vue/SortableArea.d.ts:34export interface VueSortableAreaProps<T> {
modelValue: readonly T[];
areaId: string;
group?: SortableGroup;
itemKey: ItemKey<T>;
direction?: SortableDirection;
disabled?: boolean;
handle?: string;
ignore?: string;
activationDistance?: number;
emptyInsertThreshold?: number;
swapThreshold?: number;
invertSwap?: boolean;
swap?: boolean;
multiDrag?: boolean;
selectedClass?: string;
autoScroll?: boolean;
accept?: (context: DragContext) => boolean;
copyItem?: CopyItem<T>;
animation?: SortableAnimation;
placeholder?: SortablePlaceholderOptions;
parent?: SortableParentLocation;
tag?: string | Component;
componentProps?: Readonly<Record<string, unknown>>;
}dist/vue/SortableArea.d.ts:3
modelValue: readonly T[];dist/vue/SortableArea.d.ts:4areaId: string;dist/vue/SortableArea.d.ts:5group?: SortableGroup;dist/vue/SortableArea.d.ts:6itemKey: ItemKey<T>;dist/vue/SortableArea.d.ts:7direction?: SortableDirection;dist/vue/SortableArea.d.ts:8disabled?: boolean;dist/vue/SortableArea.d.ts:9handle?: string;dist/vue/SortableArea.d.ts:10ignore?: string;dist/vue/SortableArea.d.ts:11activationDistance?: number;dist/vue/SortableArea.d.ts:12emptyInsertThreshold?: number;dist/vue/SortableArea.d.ts:13swapThreshold?: number;dist/vue/SortableArea.d.ts:14invertSwap?: boolean;dist/vue/SortableArea.d.ts:15swap?: boolean;dist/vue/SortableArea.d.ts:16multiDrag?: boolean;dist/vue/SortableArea.d.ts:17selectedClass?: string;dist/vue/SortableArea.d.ts:18autoScroll?: boolean;dist/vue/SortableArea.d.ts:19accept?: (context: DragContext) => boolean;dist/vue/SortableArea.d.ts:20copyItem?: CopyItem<T>;dist/vue/SortableArea.d.ts:21animation?: SortableAnimation;dist/vue/SortableArea.d.ts:22placeholder?: SortablePlaceholderOptions;dist/vue/SortableArea.d.ts:23parent?: SortableParentLocation;dist/vue/SortableArea.d.ts:24tag?: string | Component;dist/vue/SortableArea.d.ts:25componentProps?: Readonly<Record<string, unknown>>;dist/vue/SortableArea.d.ts:26SortableAreaComponent: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
modelValue: {
type: PropType<readonly unknown[]>;
required: true;
};
areaId: {
type: StringConstructor;
required: true;
};
group: PropType<SortableGroup>;
itemKey: {
type: PropType<ItemKey<unknown>>;
required: true;
};
direction: PropType<SortableDirection>;
disabled: BooleanConstructor;
handle: StringConstructor;
ignore: StringConstructor;
activationDistance: NumberConstructor;
emptyInsertThreshold: NumberConstructor;
swapThreshold: NumberConstructor;
invertSwap: {
type: BooleanConstructor;
default: undefined;
};
swap: {
type: BooleanConstructor;
default: undefined;
};
multiDrag: {
type: BooleanConstructor;
default: undefined;
};
selectedClass: StringConstructor;
autoScroll: {
type: BooleanConstructor;
default: undefined;
};
accept: PropType<(context: DragContext) => boolean>;
copyItem: PropType<(item: unknown, context: CopyItemContext) => unknown>;
animation: PropType<SortableAnimation>;
placeholder: PropType<SortablePlaceholderOptions>;
parent: PropType<SortableParentLocation>;
tag: {
type: PropType<string | Component>;
default: string;
};
componentProps: PropType<Readonly<Record<string, unknown>>>;
}>, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
[key: string]: any;
}>, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, "update:modelValue"[], "update:modelValue", import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
modelValue: {
type: PropType<readonly unknown[]>;
required: true;
};
areaId: {
type: StringConstructor;
required: true;
};
group: PropType<SortableGroup>;
itemKey: {
type: PropType<ItemKey<unknown>>;
required: true;
};
direction: PropType<SortableDirection>;
disabled: BooleanConstructor;
handle: StringConstructor;
ignore: StringConstructor;
activationDistance: NumberConstructor;
emptyInsertThreshold: NumberConstructor;
swapThreshold: NumberConstructor;
invertSwap: {
type: BooleanConstructor;
default: undefined;
};
swap: {
type: BooleanConstructor;
default: undefined;
};
multiDrag: {
type: BooleanConstructor;
default: undefined;
};
selectedClass: StringConstructor;
autoScroll: {
type: BooleanConstructor;
default: undefined;
};
accept: PropType<(context: DragContext) => boolean>;
copyItem: PropType<(item: unknown, context: CopyItemContext) => unknown>;
animation: PropType<SortableAnimation>;
placeholder: PropType<SortablePlaceholderOptions>;
parent: PropType<SortableParentLocation>;
tag: {
type: PropType<string | Component>;
default: string;
};
componentProps: PropType<Readonly<Record<string, unknown>>>;
}>> & Readonly<{
"onUpdate:modelValue"?: ((...args: any[]) => any) | undefined;
}>, {
disabled: boolean;
invertSwap: boolean;
swap: boolean;
multiDrag: boolean;
autoScroll: boolean;
tag: string | Component;
}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>dist/vue/SortableArea.d.ts:36
export type VueSortableRootComponent = typeof SortableRootComponent & {
new <T>(): {
$props: VueSortableRootProps<T>;
$slots: VueSortableRootSlots;
$emit(event: 'change', change: FrameworkSortableChange<T>): void;
};
};dist/vue/SortableRoot.d.ts:28
export interface VueSortableRootProps<T> extends Omit<SortableScopeOptions, 'onChange'> {
onChange?: (change: FrameworkSortableChange<T>) => void;
}dist/vue/SortableRoot.d.ts:3
onChange?: (change: FrameworkSortableChange<T>) => void;dist/vue/SortableRoot.d.ts:4SortableRoot: VueSortableRootComponentdist/vue/SortableRoot.d.ts:35
export interface VueSortableRootSlots {
default?(): VNodeChild;
}dist/vue/SortableRoot.d.ts:6
default?(): VNodeChild;dist/vue/SortableRoot.d.ts:7SortableRootComponent: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
onBeforeDragStart: PropType<(context: DragContext) => boolean | void>;
onDragStart: PropType<(context: DragContext) => void>;
onDrag: PropType<(context: DragContext) => void>;
onInsertDragArea: PropType<(event: InsertDragAreaEvent) => void>;
onAfterDrag: PropType<SortableScopeOptions['onAfterDrag']>;
onError: PropType<(error: unknown) => void>;
}>, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
[key: string]: any;
}>[] | undefined, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, "change"[], "change", import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
onBeforeDragStart: PropType<(context: DragContext) => boolean | void>;
onDragStart: PropType<(context: DragContext) => void>;
onDrag: PropType<(context: DragContext) => void>;
onInsertDragArea: PropType<(event: InsertDragAreaEvent) => void>;
onAfterDrag: PropType<SortableScopeOptions['onAfterDrag']>;
onError: PropType<(error: unknown) => void>;
}>> & Readonly<{
onChange?: ((...args: any[]) => any) | undefined;
}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>dist/vue/SortableRoot.d.ts:9
CSS custom properties from the package’s public stylesheet.
comins-sortable/styles.csscomins-sortable/styles.csscomins-sortable/styles.csscomins-sortable/styles.csscomins-sortable/styles.csscomins-sortable/styles.csscomins-sortable/styles.csscomins-sortable/styles.csscomins-sortable/styles.csscomins-sortable/styles.csscomins-sortable/styles.csscomins-sortable/styles.csscomins-sortable/styles.cssNo matching entries.