export type UseDraggableOptions = {
/**
* 是否只有当指针精确地在目标元素上时才能拖动元素。
*
* @defaultValue false
*/
exact?: boolean
/**
* 是否阻止指针事件的默认行为。
*
* @defaultValue false
*/
preventDefault?: boolean
/**
* 是否停止指针事件的传播。
*
* @defaultValue false
*/
stopPropagation?: boolean
/**
* 是否捕获指针事件。
*
* @defaultValue true
*/
capture?: boolean
/**
* 应被拖动的元素。
*
* @defaultValue target
*/
handle?: ElementTarget
/**
* 应被拖动的元素。
*
* @defaultValue window
*/
draggingElement?: ElementTarget | GlobalTarget
/**
* 应包含可拖动元素的容器元素。
*
* @defaultValue undefined
*/
containerElement?: ElementTarget
/**
* 应处理的指针事件类型。
*
* @defaultValue ['mouse', 'touch', 'pen']
*/
pointerTypes?: PointerType[]
/**
* 可拖动元素的初始位置。
*
* @defaultValue { x: 0; y: 0 }
*/
initialValue?: Position
/**
* 开始拖动时调用的回调函数。
*/
onStart?: (position: Position, event: PointerEvent) => void | false
/**
* 拖动移动时调用的回调函数。
*/
onMove?: (position: Position, event: PointerEvent) => void
/**
* 拖动结束时调用的回调函数。
*/
onEnd?: (position: Position, event: PointerEvent) => void
/**
* 可拖动元素可沿其移动的轴。
*
* @defaultValue 'both'
*/
axis?: 'x' | 'y' | 'both'
/**
* 是否禁用可拖动元素。
*
* @defaultValue false
*/
disabled?: boolean
}
