Resortable - v3.1.0
    Preparing search index...

    Interface MarqueeSelectOptions

    interface MarqueeSelectOptions {
        marqueeClass?: string;
        threshold?: number;
        altDragOnItems?: boolean;
        marqueeArea?: string | HTMLElement;
        marqueeFilter?: MarqueeFilterConfig;
        deselectOnClickAway?: boolean;
        deselectFilter?: MarqueeFilterConfig;
        touchHoldDelay?: number;
        touchHoldThreshold?: number;
        scope?: MarqueeScopeEntry[];
        scrollContainer?: string | HTMLElement;
        autoScrollDistance?: number;
        autoScrollSpeed?: number;
    }
    Index
    marqueeClass? threshold? altDragOnItems? marqueeArea? marqueeFilter? deselectOnClickAway? deselectFilter? touchHoldDelay? touchHoldThreshold? scope? scrollContainer? autoScrollDistance? autoScrollSpeed?
    marqueeClass?: string

    CSS class applied to the marquee rectangle element

    threshold?: number

    Minimum pixels of movement before marquee activates

    altDragOnItems?: boolean

    Allow Alt+drag on items to start marquee instead of item drag

    marqueeArea?: string | HTMLElement

    Root element for the pointerdown listener. HTMLElement or CSS selector. Default: 'html'

    marqueeFilter?: MarqueeFilterConfig

    Filter where marquee can start. Draggable items are always implicitly excluded.

    deselectOnClickAway?: boolean

    Clear selection on click-away (sub-threshold click on non-item space). Default: true

    deselectFilter?: MarqueeFilterConfig

    Filter where click-away deselection is suppressed.

    touchHoldDelay?: number

    Hold delay in ms before marquee starts on touch devices. Default: 300

    touchHoldThreshold?: number

    Pixels of movement allowed during touch hold before cancelling. Default: 10

    scope?: MarqueeScopeEntry[]

    Multi-list scope. When set, the marquee hit-tests every element matching each entry's itemSelector inside the marquee area, resolves each item's owning Sortable instance, and applies selection through that instance (so per-instance select events fire normally). When omitted, only the installing instance's own items participate.

    Also enables zero-config per-list edge auto-scroll: each participating instance's own nearest scrollable ancestor is resolved automatically and auto-scrolls independently as the pointer nears its top/bottom edge — no extra option needed, and it composes with scrollContainer (which continues to anchor the marquee to one specific container). Use autoScrollDistance / autoScrollSpeed to tune it.

    scrollContainer?: string | HTMLElement

    Scrollable container to anchor the marquee to. The marquee element is appended inside it (content coordinates, so it stretches while the container scrolls) and pointer positions near the container's top or bottom edge auto-scroll it. HTMLElement or CSS selector.

    This is independent of the per-list auto-scroll scope enables: only this one container gets the content-coordinate anchoring (needed so the marquee rectangle stretches correctly while it scrolls); scoped instances' own containers auto-scroll without being anchored to.

    autoScrollDistance?: number

    Distance (px) from a container's edge that triggers auto-scroll — applies to scrollContainer and to every container auto-resolved via scope. Default: 30

    autoScrollSpeed?: number

    Auto-scroll speed in px per millisecond — applies to scrollContainer and to every container auto-resolved via scope. Default: 0.3

    Settings
    Member Visibility

    On This Page
    Properties