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

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

import { PointerManager } from "../PointerManager.js";
export type UserGesturePlugin<Options extends Record<string, any> = any> = {
  /**
   * The name of the gesture.
   * It will be used to call the gesture provided by the plugin.
   *
   * For example, if the name is `'twistAndShout'`, the call will be `mouseGesture.twistAndShout()`.
   */
  name: string;
  /**
   * The function that implements the new gesture.
   * This function will be called with the provided options.
   *
   * The function should return a promise that resolves when the gesture is done.
   * @param {PointerManager} pointerManager - Manager for handling pointer events
   * @param {Options} options - Configuration options for the gesture
   * @param {(ms: number) => Promise<void>} advanceTimers - Function to advance timers in testing environment
   * @returns {Promise<void>} A promise that resolves when the gesture is complete
   */
  gesture: (pointerManager: PointerManager, options: Options, advanceTimers?: (ms: number) => Promise<void>) => Promise<void>;
};