jquery-event-holdrepeat

On Mouse HoldRepeat event handling component for JQuery

This plugin extends jQuery to support "holdrepeat" events, which are triggered when an element is pressed and held at least for a specified duration, to distinguish it from a click. During the hold, the event is triggered repeatedly at a configurable interval, with optional acceleration to decrease the interval over time (and increase the trigger rate).

Features:

• Customizable initial delay before the first holdrepeat event.
• Configurable repeat interval between holdrepeat events.
• Optional acceleration to dynamically adjust the interval.
• Support for both mouse and touch events.
• Works with direct event binding and event delegation.
• Prevents accidental clicks during holdrepeat interactions (ghost clicks).

Usage Example:

// Basic usage
$('#element').on('holdrepeat', function(e) {
    console.log(`holdrepeat iteration ${e.iteration} at ${e.currentInterval}ms`);
});

Usage with custom options:

$('#element').on('holdrepeat', {
    initialDelay: 300,        // Delay before first holdrepeat event (ms)
    repeatInterval: 100,      // Base interval between holdrepeat events (ms)
    acceleration: 0.8,        // Acceleration factor (0-1)
    accelerateAfter: 5,       // Start acceleration after N iterations
    minRepeatInterval: 30,    // Minimum interval (ms)
    maxIterationsPerHold: 50, // Maximum iterations per holdrepeat, to prevent infinite
                              // loops. Can be set to Infinity
}, function(e) {
    console.log(`holdrepeat iteration ${e.iteration + 1} at ${e.currentInterval}ms`);
});

Example with event delegation

$(document).on('holdrepeat', '.dynamic-element', function(e) {
    console.log(`holdrepeat on dynamically added element`);
});

Triggered events:

• holdstart: Triggered when the initial delay expires.
• holdrepeat: Triggered repeatedly during the hold.
• holdstop: Triggered when the hold ends.
• holdrepeathalt: Triggered when max repetitions or time imit is reached

Event Object Properties:

• originalEvent: The native mouse/touch event.
• iteration: The current holdrepeat iteration (starts at 0).
• startTime: Timestamp when the hold started.
• currentInterval: The current interval between events (ms).
• duration: (holdstop only) Total duration of the hold (ms).
• accelerating: true, if acceleration is on
• haltReason: reason why repetitions halted (string, holdrepeathalt only)
• haltTime: time when repetitions halted (timestamp, holdrepeathalt only)

Dependencies:

• jQuery 1.7+

Browser Support:

• Chrome, Firefox, Safari, and other modern browsers.
• Touch devices (with optional scroll prevention).
• Does NOT support Internet Explorer (any version).