Why Gemfury? Push, build, and install  RubyGems npm packages Python packages Maven artifacts PHP packages Go Modules Debian packages RPM packages NuGet packages

Repository URL to install this package:

Details    
omniagents / omniagents / backends / ink / tui / src / hooks / useMouse.ts
Size: Mime:
/**
 * Hook for listening to mouse events
 */

import { useEffect } from "react";
import type { MouseHandler, MouseEvent } from "../contexts/MouseContext.js";
import { useMouseContext } from "../contexts/MouseContext.js";

export type { MouseEvent };

/**
 * A hook that listens for mouse events from stdin.
 *
 * @param onMouseEvent - The callback function to execute on each mouse event.
 * @param options - Options to control the hook's behavior.
 * @param options.isActive - Whether the hook should be actively listening for input.
 */
export function useMouse(
  onMouseEvent: MouseHandler,
  { isActive }: { isActive: boolean },
) {
  const { subscribe, unsubscribe } = useMouseContext();

  useEffect(() => {
    if (!isActive) {
      return;
    }

    subscribe(onMouseEvent);
    return () => {
      unsubscribe(onMouseEvent);
    };
  }, [isActive, onMouseEvent, subscribe, unsubscribe]);
}