DefinitelyTyped/types/react-dnd-touch-backend/index.d.ts

// Type definitions for react-dnd-touch-backend 0.4
// Project: https://github.com/yahoo/react-dnd-touch-backend#readme
// Definitions by: Daniel Król <https://github.com/mleko>,
//                 Janeene Beeforth <https://github.com/dawnmist>
//                 Adam Haglund <https://github.com/beeequeue>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
// TypeScript Version: 2.8

import { BackendFactory } from 'dnd-core';

export default function createTouchBackend(option?: TouchBackendOptions): BackendFactory;

export interface TouchBackendOptions {
    /**
     * Support mouse events as well as touch events.
     */
    enableMouseEvents?: boolean;
    /**
     * Can cancel drag by hitting Escape if enableKeyboardEvents option is set to true
     */
    enableKeyboardEvents?: boolean;
    /**
     * Number of milliseconds that the item needs to be touched before the touch is considered the start of a drag.
     * This is used to allow both flick-to-scroll and drag-n-drop on objects in a list.
     */
    delayTouchStart?: number;
    /**
     * Number of milliseconds that the item needs to be clicked on before the click is considered the start of a drag.
     */
    delayMouseStart?: number;
    /**
     * Number of milliseconds delay before the touch/click is considered a drag.
     * @deprecated replaced by delayTouchStart and delayMouseStart, but is still supported at present.
     */
    delay?: number;
    /**
     * Specifies the pixel distance moved before a drag is signaled. Default 0.
     */
    touchSlop?: number;
    /**
     * If true, prevents the contextmenu event from canceling a drag. Default false.
     */
    ignoreContextMenu?: boolean;
    /**
     * Specifies ranges of angles in degrees that drag events should be ignored. This is useful when you want to allow
     * the user to scroll in a particular direction instead of dragging. Degrees move clockwise, 0/360 pointing to the
     * left. Default: undefined
     */
    scrollAngleRanges?: ReadonlyArray<{ start?: number, end?: number }>;
}