@humanspeak/svelte-motion/dist/utils/dragControls.d.ts

Framer Motion for Svelte 5. Declarative motion.<tag> components with AnimatePresence exit animations, gestures (hover, tap, drag, focus, in-view), variants, FLIP layout animations, shared-layout transitions, spring physics, and scroll-linked motion values

import type { DragControls } from '../types';
/**
 * Creates imperative drag controls for programmatically starting and stopping drags.
 *
 * Use this factory to create a controls object that can trigger a drag from external
 * events (e.g., a button press or keyboard shortcut). Pass the controls to a motion
 * element via the `dragControls` prop, then call `controls.start(event)` to initiate
 * the drag as if the user had pressed down on the element.
 *
 * @returns {DragControls} An object with `start`, `cancel`, `stop`, and `subscribe` methods.
 * @see https://motion.dev/docs/react-motion-component#dragging
 *
 * @example
 * ```svelte
 * <script>
 *   import { motion, createDragControls } from '@humanspeak/svelte-motion'
 *
 *   const controls = createDragControls()
 *
 *   function startDrag(event) {
 *     controls.start(event, { snapToCursor: true })
 *   }
 * </script>
 *
 * <button onpointerdown={startDrag}>Drag handle</button>
 * <motion.div drag="x" dragControls={controls}>
 *   Draggable content
 * </motion.div>
 * ```
 */
export declare const createDragControls: () => DragControls;