# All files / src/draggable useControlledDraggable.ts

99.7% Statements 682/684
95.65% Branches 66/69
100% Functions 4/4
99.7% Lines 682/684

Press n or j to go to the next uncovered block, b, p or k for the previous block.

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    49
    50
    51
    52
    53
    54
    55
    56
    57
    58
    59
    60
    61
    62
    63
    64
    65
    66
    67
    68
    69
    70
    71
    72
    73
    74
    75
    76
    77
    78
    79
    80
    81
    82
    83
    84
    85
    86
    87
    88
    89
    90
    91
    92
    93
    94
    95
    96
    97
    98
    99
    100
    101
    102
    103
    104
    105
    106
    107
    108
    109
    110
    111
    112
    113
    114
    115
    116
    117
    118
    119
    120
    121
    122
    123
    124
    125
    126
    127
    128
    129
    130
    131
    132
    133
    134
    135
    136
    137
    138
    139
    140
    141
    142
    143
    144
    145
    146
    147
    148
    149
    150
    151
    152
    153
    154
    155
    156
    157
    158
    159
    160
    161
    162
    163
    164
    165
    166
    167
    168
    169
    170
    171
    172
    173
    174
    175
    176
    177
    178
    179
    180
    181
    182
    183
    184
    185
    186
    187
    188
    189
    190
    191
    192
    193
    194
    195
    196
    197
    198
    199
    200
    201
    202
    203
    204
    205
    206
    207
    208
    209
    210
    211
    212
    213
    214
    215
    216
    217
    218
    219
    220
    221
    222
    223
    224
    225
    226
    227
    228
    229
    230
    231
    232
    233
    234
    235
    236
    237
    238
    239
    240
    241
    242
    243
    244
    245
    246
    247
    248
    249
    250
    251
    252
    253
    254
    255
    256
    257
    258
    259
    260
    261
    262
    263
    264
    265
    266
    267
    268
    269
    270
    271
    272
    273
    274
    275
    276
    277
    278
    279
    280
    281
    282
    283
    284
    285
    286
    287
    288
    289
    290
    291
    292
    293
    294
    295
    296
    297
    298
    299
    300
    301
    302
    303
    304
    305
    306
    307
    308
    309
    310
    311
    312
    313
    314
    315
    316
    317
    318
    319
    320
    321
    322
    323
    324
    325
    326
    327
    328
    329
    330
    331
    332
    333
    334
    335
    336
    337
    338
    339
    340
    341
    342
    343
    344
    345
    346
    347
    348
    349
    350
    351
    352
    353
    354
    355
    356
    357
    358
    359
    360
    361
    362
    363
    364
    365
    366
    367
    368
    369
    370
    371
    372
    373
    374
    375
    376
    377
    378
    379
    380
    381
    382
    383
    384
    385
    386
    387
    388
    389
    390
    391
    392
    393
    394
    395
    396
    397
    398
    399
    400
    401
    402
    403
    404
    405
    406
    407
    408
    409
    410
    411
    412
    413
    414
    415
    416
    417
    418
    419
    420
    421
    422
    423
    424
    425
    426
    427
    428
    429
    430
    431
    432
    433
    434
    435
    436
    437
    438
    439
    440
    441
    442
    443
    444
    445
    446
    447
    448
    449
    450
    451
    452
    453
    454
    455
    456
    457
    458
    459
    460
    461
    462
    463
    464
    465
    466
    467
    468
    469
    470
    471
    472
    473
    474
    475
    476
    477
    478
    479
    480
    481
    482
    483
    484
    485
    486
    487
    488
    489
    490
    491
    492
    493
    494
    495
    496
    497
    498
    499
    500
    501
    502
    503
    504
    505
    506
    507
    508
    509
    510
    511
    512
    513
    514
    515
    516
    517
    518
    519
    520
    521
    522
    523
    524
    525
    526
    527
    528
    529
    530
    531
    532
    533
    534
    535
    536
    537
    538
    539
    540
    541
    542
    543
    544
    545
    546
    547
    548
    549
    550
    551
    552
    553
    554
    555
    556
    557
    558
    559
    560
    561
    562
    563
    564
    565
    566
    567
    568
    569
    570
    571
    572
    573
    574
    575
    576
    577
    578
    579
    580
    581
    582
    583
    584
    585
    586
    587
    588
    589
    590
    591
    592
    593
    594
    595
    596
    597
    598
    599
    600
    601
    602
    603
    604
    605
    606
    607
    608
    609
    610
    611
    612
    613
    614
    615
    616
    617
    618
    619
    620
    621
    622
    623
    624
    625
    626
    627
    628
    629
    630
    631
    632
    633
    634
    635
    636
    637
    638
    639
    640
    641
    642
    643
    644
    645
    646
    647
    648
    649
    650
    651
    652
    653
    654
    655
    656
    657
    658
    659
    660
    661
    662
    663
    664
    665
    666
    667
    668
    669
    670
    671
    672
    673
    674
    675
    676
    677
    678
    679
    680
    681
    682
    683
    684
    6851x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    71x
    71x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    102x
    102x
    102x
    102x
    102x
    102x
    102x
    102x
    102x
    102x
    102x
    102x
    102x
    102x
    102x
    102x
    102x
    102x
    102x
    102x
    102x
    102x
    102x
    102x
    102x
    102x
    102x
    102x
    102x
    102x
    102x
    102x
    102x
    2x
    102x
    102x
    2x
    102x
    102x
    4x
    102x
    102x
    3x
    102x
    102x
    102x
    102x
    102x
    102x
    102x
    98x
    51x
    102x
    102x
    102x
    102x
    102x
    35x
    26x
    26x
    9x
    9x
    9x
    55x
    1x
    1x
    54x
    54x
    54x
    54x
    54x
    54x
    54x
    54x
    54x
    54x
    54x
    54x
    54x
    54x
    54x
    54x
    54x
    54x
    54x
    54x
    54x
    54x
    9x
    9x
    5x
    5x
    5x
    5x
    9x
    35x
    35x
    35x
    35x
    35x
    35x
    35x
    9x
    9x
    9x
    102x
    102x
    102x
    102x
    102x
    102x
    102x
    102x
    102x
    102x
    102x
    102x
    102x
    102x
    102x
    102x
    102x
    102x
    102x
    19x
    19x
    17x
    17x
    19x
    17x
    17x
    2x
    2x
    2x
    2x
    2x
    2x
    2x
    2x
    2x
    2x
    2x
    2x
    2x
    102x
    102x
    102x
    102x
    102x
    15x
    15x
    6x
    6x
    9x
    9x
    9x
    9x
    9x
    9x
    9x
    9x
    9x
    9x
    9x
    9x
    9x
    9x
    9x
    9x
    9x
    9x
    9x
    9x
    9x
    9x
    9x
    9x
    102x
    102x
    102x
    102x
    102x
    102x
    102x
    102x
    102x
    102x
    102x
    102x
    102x
    102x
    102x
    102x
    102x
    102x
    102x
    102x
    54x
    54x
    46x
    46x
    8x
    8x
    8x
    8x
    8x
    8x
    8x
    8x
    8x
    8x
    8x
    8x
    8x
    8x
    8x
    8x
    8x
    8x
    8x
    8x
    102x
    102x
    102x
    102x
    102x
    102x
    102x
    102x
    102x
    102x
    102x
    102x
    102x
    102x
    102x
    102x
    102x
    102x
    102x
    102x
    102x
    3x
    3x

    3x
    3x
    3x
    102x
    102x
    102x
    102x
    102x
    102x
    8x
    8x
    1x
    1x
    7x
    8x
    8x
    8x
    8x
    8x
    2x
    2x
    2x
    8x
    3x
    3x
    3x
    8x
    1x
    1x
    1x
    8x
    1x
    1x
    1x
    8x
    8x
    102x
    102x
    102x
    102x
    102x
    102x
    102x
    102x
    102x
    102x
    102x
    102x
    102x
    102x
    102x
    102x
    102x
    3x
    3x
    2x
    2x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    102x
    102x
    102x
    102x
    102x
    102x
    102x
    102x
    102x
    102x
    102x
    102x
    102x
    102x
    102x
    102x
    102x
    102x
    102x
    3x
    3x
    2x
    2x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    102x
    102x
    102x
    102x
    102x
    102x
    102x
    102x
    102x
    102x
    102x
    102x
    102x
    102x
    102x
    102x
    102x
    102x
    102x
    102x
    102x
    102x
    102x
    102x
    102x
    102x
    102x
    102x
    102x
    102x
    102x
    102x
    102x
    102x
    102x
     "use client";
    import { cnb } from "cnbuilder";
    import type { HTMLAttributes, Ref, RefCallback } from "react";
    import { useCallback, useEffect, useRef, useState } from "react";
    import { useUserInteractionMode } from "../interaction/UserInteractionModeProvider.js";
    import { useScrollLock } from "../scroll/useScrollLock.js";
    import type { NonNullRef, UseStateSetter } from "../types.js";
    import { useDir } from "../typography/WritingDirectionProvider.js";
    import { useEnsuredRef } from "../useEnsuredRef.js";
    import { useHtmlClassName } from "../useHtmlClassName.js";
    import { getRangeSteps } from "../utils/getRangeSteps.js";
    import { nearest } from "../utils/nearest.js";
    import { withinRange } from "../utils/withinRange.js";
    import {
      isMouseDragStartEvent,
      isTouchDragStartEvent,
      updateDragPosition,
    } from "./utils.js";

    const noop = (): void => {
      // do nothing
    };

    /**
     * @remarks \@since 6.0.0
     */
    export type DraggableTouchEventHandlers<E extends HTMLElement> = Pick<
      HTMLAttributes<E>,
      "onTouchStart" | "onTouchMove"
    >;

    /**
     * @remarks \@since 6.0.0
     */
    export type DraggableMouseEventHandlers<E extends HTMLElement> = Pick<
      HTMLAttributes<E>,
      "onMouseDown" | "onMouseUp" | "onMouseMove"
    >;

    /**
     * @remarks \@since 6.0.0
     */
    export type DraggableKeyboardEventHandlers<E extends HTMLElement> = Pick<
      HTMLAttributes<E>,
      "onKeyDown"
    >;

    /**
     * @remarks \@since 6.0.0
     */
    export type DraggableEventHandlers<E extends HTMLElement> =
      DraggableTouchEventHandlers<E> &
        DraggableMouseEventHandlers<E> &
        DraggableKeyboardEventHandlers<E>;

    /**
     * @remarks \@since 6.0.0
     */
    export interface BaseDraggableOptions<E extends HTMLElement>
      extends DraggableEventHandlers<E> {
      /**
       * An optional ref to merge with the returned
       * {@link ControlledDraggableImplementation.draggableRef}.
       */
      ref?: Ref<E>;

      /**
       * The minimum number of pixels allowed for the draggable element. This must
       * be a number greater than or equal to 0.
       *
       * When {@link withinOffsetParent} is set to `true`, this is the minimum value
       * allowed instead of pixels.
       */
      min: number;

      /**
       * The maximum number of pixels allowed for the draggable element. This must
       * be a number greater than the {@link min} and usually a number less than the
       * viewport size.
       *
       * When {@link withinOffsetParent} is set to `true`, this is the maximum value
       * allowed instead of pixels.
       */
      max: number;

      /**
       * The amount to increment or decrement the value with arrow keys.
       *
       * @defaultValue `1`
       */
      step?: number;

      /**
       * This was added to support range sliders where there are two (or more)
       * draggable elements within the same container element and their values
       * cannot pass each other. Without these overrides, the range would keep
       * changing as the other values change, so the drag percentage would be
       * incorrect.
       *
       * @example
       * Range Slider
       * ```ts
       * const min = 0;
       * const max = 100;
       * const minValue = 3;
       * const maxValue = 80;
       *
       * const minValueDraggable = useDraggable({
       *   min,
       *   max,
       *   rangeMax: maxValue,
       * });
       * const maxValueDraggable = useDraggable({
       *   min,
       *   max,
       *   rangeMin: minValue,
       * });
       * ```
       *
       * @defaultValue `min`
       */
      rangeMin?: number;

      /**
       * @see {@link rangeMin} for an explanation of this option.
       * @defaultValue `max`
       */
      rangeMax?: number;

      /**
       * Set this to `true` to enable dragging vertically instead of horizontally.
       *
       * @defaultValue `false`
       */
      vertical?: boolean;

      /**
       * The default drag behavior is to increase the value when:
       *
       * - dragging `"right"` and the writing direction is `"ltr"`
       * - dragging `"left"` and the writing direction is `"rtl"`
       * - dragging `"upwards"`
       *
       * When this is set to `true`, the value when increase when:
       *
       * - dragging `"left"` and the writing direction is `"ltr"`
       * - dragging `"right"` and the writing direction is `"rtl"`
       * - dragging `"downwards"`
       *
       * @defaultValue `false`
       */
      reversed?: boolean;

      /**
       * Set this to `true` to disable all drag behavior. This will still call any
       * of the provided {@link DraggableEventHandlers}.
       *
       * @defaultValue `false`
       */
      disabled?: boolean;

      /**
       * Set this to `true` if the dragging calculations should be to the
       * `draggableRef.current.offsetParent` instead of the entire window. The main
       * use case for this is sliders.
       *
       * @defaultValue `false`
       */
      withinOffsetParent?: boolean;

      /**
       * Set this to `true` to prevent the `document.documentElement` from gaining
       * the `.rmd-dragging` class names while dragging.
       *
       * This should normally remain as `false` to improve performance and prevent
       * other mouse events from firing while dragging.
       *
       * @defaultValue `false`
       */
      disableDraggingClassName?: boolean;

      /**
       * Set this to `true` to prevent the vertical or horizontal cursor from
       * appearing while dragging.
       *
       * @defaultValue `false`
       */
      disableDraggingCursorClassName?: boolean;
    }

    /**
     * @remarks \@since 6.0.0
     */
    export interface ControlledDraggableOptions<E extends HTMLElement>
      extends BaseDraggableOptions<E> {
      setValue: UseStateSetter<number>;
      dragging: boolean;
      setDragging: UseStateSetter<boolean>;
    }

    /**
     * @remarks \@since 6.0.0
     */
    export interface ControlledDraggableImplementation<E extends HTMLElement>
      extends Required<DraggableEventHandlers<E>> {
      mouseEventHandlers: Required<DraggableMouseEventHandlers<E>>;
      touchEventHandlers: Required<DraggableTouchEventHandlers<E>>;
      keyboardEventHandlers: Required<DraggableKeyboardEventHandlers<E>>;

      /**
       * Set the {@link value} to {@link DraggableOptions.min}.
       */
      minimum(): void;

      /**
       * Set the {@link value} to {@link DraggableOptions.max}.
       */
      maximum(): void;

      /**
       * Increment the {@link value} by {@link DraggableOptions.step}.
       */
      increment(): void;

      /**
       * Decrement the {@link value} by {@link DraggableOptions.step}.
       */
      decrement(): void;

      /**
       * A ref that **Must** be passed to the element that should be draggable.
       */
      draggableRef: RefCallback<E>;

      /**
       * This value will only update while dragging with a mouse or touch and should
       * be used for the positioning styles while dragging.
       *
       * @example
       * Inline Styles
       * ```ts
       * import { getPercentage, useDraggable } from "@react-md/core";
       *
       * const min = 120;
       * const max = 256;
       * const { value, dragging, dragPercentage } = useDraggable({
       *   min,
       *   max,
       *   defaultValue: min,
       * });
       *
       * const percentage = dragging
       *   ? dragPercentage
       *   : getPercentage({ min, max, value });
       *
       * const style: CSSProperties = {
       *   left: `${percentage * 100}%`<>
       * };
       *
       * // do stuff
       * ```
       */
      dragPercentage: number;

      /**
       * Flag to determine if the user has dragged at least once. Used internally
       * for manually persisting the value into local storage once the user has
       * stopped dragging.
       */
      draggedOnce: NonNullRef<boolean>;
    }

    /**
     * This is most likely an internal only hook that provides the functionality for
     * dragging an element through mouse, touch, and keyboard events. The main use
     * cases so far for this hook are:
     * - window splitters
     * - sliders
     *
     * @remarks \@since 6.0.0
     */
    export function useControlledDraggable<E extends HTMLElement>(
      options: ControlledDraggableOptions<E>
    ): ControlledDraggableImplementation<E> {
      const {
        ref: propRef,
        min,
        max,
        rangeMin = min,
        rangeMax = max,
        step = 1,
        reversed = false,
        vertical = false,
        onKeyDown = noop,
        onMouseUp = noop,
        onMouseDown = noop,
        onMouseMove = noop,
        onTouchStart = noop,
        onTouchMove = noop,
        dragging,
        setDragging,
        setValue,
        withinOffsetParent = false,
        disabled = false,
        disableDraggingClassName = false,
        disableDraggingCursorClassName = disableDraggingClassName,
      } = options;

      const [nodeRef, ref] = useEnsuredRef(propRef);
      const isTouch = useUserInteractionMode() === "touch";
      const draggingRef = useRef(false);
      const [dragPercentage, setDragPercentage] = useState(min);

      const isRTL = useDir().dir === "rtl";
      const maximum = useCallback(() => {
        setValue(max);
      }, [max, setValue]);
      const minimum = useCallback(() => {
        setValue(min);
      }, [min, setValue]);
      const increment = useCallback(() => {
        setValue((prevValue) => withinRange({ min, max, value: prevValue + step }));
      }, [max, min, setValue, step]);
      const decrement = useCallback(() => {
        setValue((prevValue) => withinRange({ min, max, value: prevValue - step }));
      }, [max, min, setValue, step]);

      const draggingClassName = dragging && !disableDraggingClassName;
      useHtmlClassName(cnb(draggingClassName && "rmd-dragging"));
      useHtmlClassName(
        cnb(
          !disableDraggingCursorClassName &&
            draggingClassName &&
            `rmd-dragging--${vertical ? "v" : "h"}`
        )
      );

      const draggedOnce = useRef(false);
      useEffect(() => {
        if (!dragging) {
          return;
        }

        draggedOnce.current = true;
        const updatePosition = (event: MouseEvent | TouchEvent): void => {
          if (!event.cancelable) {
            return;
          }

          event.preventDefault();
          event.stopPropagation();

          updateDragPosition({
            event,
            nodeRef,
            min,
            max,
            step,
            rangeMin,
            rangeMax,
            isRTL,
            isDragStart: false,
            reversed,
            vertical,
            setValue,
            setDragging,
            setDragPercentage,
            withinOffsetParent,
          });
        };

        const stopDragging = (event: MouseEvent | TouchEvent): void => {
          updatePosition(event);
          draggingRef.current = false;
          setDragging(false);
        };

        const updateKey = isTouch ? "touchmove" : "mousemove";
        const stopKey = isTouch ? "touchend" : "mouseup";
        const passive = isTouch ? { passive: false } : undefined;

        window.addEventListener(updateKey, updatePosition, passive);
        window.addEventListener(stopKey, stopDragging);
        return () => {
          window.removeEventListener(updateKey, updatePosition);
          window.removeEventListener(stopKey, stopDragging);
        };
      }, [
        dragging,
        isRTL,
        isTouch,
        max,
        min,
        nodeRef,
        rangeMax,
        rangeMin,
        reversed,
        setDragging,
        setValue,
        step,
        vertical,
        withinOffsetParent,
      ]);

      const prevRange = useRef({ min, max, step });
      useEffect(() => {
        if (
          prevRange.current.min === min &&
          prevRange.current.max === max &&
          prevRange.current.step === step
        ) {
          return;
        }

        // ensure that if the `min`, `max`, or `step` value changes that the value
        // is updated as well. Without this, there will be a runtime error if the
        // value is not within the new range.
        prevRange.current = { min, max, step };
        setValue((prevValue) =>
          nearest({
            min,
            max,
            steps: getRangeSteps({ min, max, step }),
            value: prevValue,
          })
        );
      }, [max, min, setValue, step]);

      const mouseEventHandlers: Required<DraggableMouseEventHandlers<E>> = {
        onMouseDown: useCallback(
          (event) => {
            onMouseDown(event);
            if (disabled || isTouch || !isMouseDragStartEvent(event)) {
              return;
            }

            // dont' allow text to be selected
            event.preventDefault();
            updateDragPosition({
              isDragStart: true,
              event,
              nodeRef,
              min,
              max,
              step,
              rangeMin,
              rangeMax,
              isRTL,
              reversed,
              vertical,
              setValue,
              setDragging,
              setDragPercentage,
              withinOffsetParent,
            });

            // don't set dragging immediately so that click events can still happen
            draggingRef.current = true;
          },
          [
            disabled,
            isRTL,
            isTouch,
            max,
            min,
            nodeRef,
            onMouseDown,
            rangeMax,
            rangeMin,
            reversed,
            setDragging,
            setValue,
            step,
            vertical,
            withinOffsetParent,
          ]
        ),
        onMouseMove: useCallback(
          (event) => {
            onMouseMove(event);
            if (disabled || isTouch || !draggingRef.current || dragging) {
              return;
            }

            updateDragPosition({
              isDragStart: true,
              event,
              nodeRef,
              min,
              max,
              step,
              rangeMin,
              rangeMax,
              isRTL,
              reversed,
              vertical,
              setValue,
              setDragging,
              setDragPercentage,
              withinOffsetParent,
            });
            setDragging(true);
          },
          [
            disabled,
            dragging,
            isRTL,
            isTouch,
            max,
            min,
            nodeRef,
            onMouseMove,
            rangeMax,
            rangeMin,
            reversed,
            setDragging,
            setValue,
            step,
            vertical,
            withinOffsetParent,
          ]
        ),
        onMouseUp: useCallback(
          (event) => {
            onMouseUp(event);
            if (disabled || isTouch) {
              return;
            }

            draggingRef.current = false;
          },
          [disabled, isTouch, onMouseUp]
        ),
      };
      const keyboardEventHandlers: Required<DraggableKeyboardEventHandlers<E>> = {
        onKeyDown: useCallback(
          (event) => {
            onKeyDown(event);
            if (disabled) {
              return;
            }

            const decrementKey = vertical ? "ArrowUp" : "ArrowLeft";
            const incrementKey = vertical ? "ArrowDown" : "ArrowRight";

            switch (event.key) {
              case decrementKey:
                event.preventDefault();
                decrement();
                break;
              case incrementKey:
                event.preventDefault();
                increment();
                break;
              case "Home":
                event.preventDefault();
                minimum();
                break;
              case "End":
                event.preventDefault();
                maximum();
                break;
            }
          },
          [decrement, disabled, increment, maximum, minimum, onKeyDown, vertical]
        ),
      };

      // touch devices are a bit weird and cause issues since the "start" event is
      // also used for scrolling. If the user quickly grabs the draggable element
      // and drags vertically, most of the time it will try to scroll instead of
      // dragging the element. The workaround is to being the drag events
      // immediately on touchstart and disable scroll behavior for the page.
      //
      // There are also some issues with calling `event.preventDefault()` within
      // touch events even while `{ passive: false } is manually set, so need to
      // also attach a touchmove event.
      useScrollLock(isTouch && dragging);
      const touchEventHandlers: Required<DraggableTouchEventHandlers<E>> = {
        onTouchStart: useCallback(
          (event) => {
            onTouchStart(event);
            if (disabled || !isTouchDragStartEvent(event)) {
              return;
            }

            draggingRef.current = true;
            updateDragPosition({
              isDragStart: true,
              event,
              nodeRef,
              min,
              max,
              step,
              rangeMin,
              rangeMax,
              isRTL,
              reversed,
              vertical,
              setValue,
              setDragging,
              setDragPercentage,
              withinOffsetParent,
            });
          },
          [
            disabled,
            isRTL,
            max,
            min,
            nodeRef,
            onTouchStart,
            rangeMax,
            rangeMin,
            reversed,
            setDragging,
            setValue,
            step,
            vertical,
            withinOffsetParent,
          ]
        ),
        onTouchMove: useCallback(
          (event) => {
            onTouchMove(event);
            if (disabled || !draggingRef.current || !event.cancelable) {
              return;
            }

            // prevent the document's touchmove event from also firing
            event.stopPropagation();
            updateDragPosition({
              isDragStart: true,
              event,
              nodeRef,
              min,
              max,
              step,
              rangeMin,
              rangeMax,
              isRTL,
              reversed,
              vertical,
              setValue,
              setDragging,
              setDragPercentage,
              withinOffsetParent,
            });
          },
          [
            disabled,
            isRTL,
            max,
            min,
            nodeRef,
            onTouchMove,
            rangeMax,
            rangeMin,
            reversed,
            setDragging,
            setValue,
            step,
            vertical,
            withinOffsetParent,
          ]
        ),
      };

      return {
        ...touchEventHandlers,
        ...mouseEventHandlers,
        ...keyboardEventHandlers,
        maximum,
        minimum,
        increment,
        decrement,
        draggedOnce,
        draggableRef: ref,
        dragPercentage,
        touchEventHandlers,
        mouseEventHandlers,
        keyboardEventHandlers,
      };
    }