@wordpress/components/build-module/utils/hooks/use-jump-step.js

UI components for WordPress.

/**
 * WordPress dependencies
 */
import { useEffect, useState } from '@wordpress/element';
/**
 * A custom hook that calculates a step value (used by elements like input
 * [type="number"]). This value can be modified based on whether the Shift
 * key is being held down.
 *
 * For example, a shiftStep of 10, and a step of 1...
 * Starting from 10, the next incremented value will be 11.
 *
 * Holding down shift...
 * Starting from 10, the next incremented value will be 20.
 *
 * @param {Object} props Properties for the hook.
 * @param {boolean} [props.isShiftStepEnabled=true] Determines if jumping values with shift is enabled
 * @param {number} [props.shiftStep=10] Multiplier to jump by, when holding shift key.
 * @param {number} [props.step=1] Multiplier to jump by, when not-holding shift key.
 *
 * @return {number} The jump step value.
 */

function useJumpStep({
  isShiftStepEnabled = true,
  shiftStep = 10,
  step = 1
}) {
  const [isShiftKey, setIsShiftKey] = useState(false);
  useEffect(() => {
    /** @type {(event: KeyboardEvent)=>void} */
    const handleShiftKeyToggle = event => {
      setIsShiftKey(event.shiftKey);
    };

    window.addEventListener('keydown', handleShiftKeyToggle);
    window.addEventListener('keyup', handleShiftKeyToggle);
    return () => {
      window.removeEventListener('keydown', handleShiftKeyToggle);
      window.removeEventListener('keyup', handleShiftKeyToggle);
    };
  }, []);
  const isEnabled = isShiftStepEnabled && isShiftKey;
  return isEnabled ? shiftStep * step : step;
}

export default useJumpStep;
//# sourceMappingURL=use-jump-step.js.map