Skip to content

fix: add the correct type to events #248

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 45 additions & 1 deletion src/useDraggable.ts
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,51 @@ export interface UseDraggableReturn extends Pick<Sortable, SortableMethod> {
export interface UseDraggableOptions<T> extends Options {
clone?: (element: T) => T
immediate?: boolean
customUpdate?: (event: SortableEvent) => void
customUpdate?: (event: DraggableEvent<T>) => void
/**
* Element dragging started
*/
onStart?: ((event: DraggableEvent<T>) => void) | undefined
/**
* Element dragging ended
*/
onEnd?: ((event: DraggableEvent<T>) => void) | undefined
/**
* Element is dropped into the list from another list
*/
onAdd?: ((event: DraggableEvent<T>) => void) | undefined
/**
* Created a clone of an element
*/
onClone?: ((event: DraggableEvent<T>) => void) | undefined
/**
* Element is chosen
*/
onChoose?: ((event: DraggableEvent<T>) => void) | undefined
/**
* Element is unchosen
*/
onUnchoose?: ((event: DraggableEvent<T>) => void) | undefined
/**
* Changed sorting within list
*/
onUpdate?: ((event: DraggableEvent<T>) => void) | undefined
/**
* Called by any change to the list (add / update / remove)
*/
onSort?: ((event: DraggableEvent<T>) => void) | undefined
/**
* Element is removed from the list into another list
*/
onRemove?: ((event: DraggableEvent<T>) => void) | undefined
/**
* Attempt to drag a filtered element
*/
onFilter?: ((event: DraggableEvent<T>) => void) | undefined
/**
* Called when dragging element changes position
*/
onChange?: ((evt: DraggableEvent<T>) => void) | undefined
}

/**
Expand Down