@mui/x-internal-gestures/testing/gestures/PressUserGesture.types.d.ts

The core engine of GestureEvents, a modern and robust multi-pointer gesture detection library for JavaScript.

import { MousePointer, Pointers, PointerType } from "../types/Pointers.js";
export type PressUserGestureOptions<P extends PointerType> = {
  /**
   * The target element to press on.
   */
  target: Element;
  /**
   * The duration of the press in milliseconds.
   *
   * @default 500
   */
  duration?: number;
} & (P extends 'mouse' ? {
  /**
   * The pointer configuration to be used.
   */
  pointer?: MousePointer;
} : {
  /**
   * The pointers configuration to be used.
   *
   * It can be an object with the amount and distance properties, or an array of pointers.
   *
   * @default
   * { amount: 1, distance: 50 }
   */
  pointers?: Pointers;
});
export type PressUserGestureRoot<P extends PointerType> = {
  /**
   * Press on the target element.
   *
   * @param {PressUserGestureOptions<P>} options - Configuration for the press gesture
   * @returns {Promise<void>} A promise that resolves when the press gesture is completed
   */
  press: (options: PressUserGestureOptions<P>) => Promise<void>;
};