Skip to content

A reactive notebook for Python — run reproducible experiments, query with SQL, execute as a script, deploy as an app, and version with git. Stored as pure Python. All in a modern, AI-native editor.

1.4 KB
Raw Blame
/* Copyright 2026 Marimo. All rights reserved. */

import { useState } from "react";
import { useEventListener } from "@/hooks/useEventListener";

/**
 * Hook to manage the visibility of island controls based on keyboard state.
 *
 * Controls are shown when:
 * - alwaysShowRun is true, OR
 * - User holds Cmd/Ctrl key
 *
 * @param alwaysShowRun - If true, controls are always visible
 * @returns Whether controls should be shown
 */
export function useIslandControls(alwaysShowRun: boolean): boolean {
  const [pressed, setPressed] = useState<boolean>(alwaysShowRun);

  // No need to register if display is always on
  const maybeNoop = <T>(fn: (e: T) => void) =>
    // oxlint-disable-next-line typescript/no-empty-function
    alwaysShowRun ? () => {} : fn;

  useEventListener(
    document,
    "keydown",
    maybeNoop((e: KeyboardEvent) => {
      if (!alwaysShowRun && (e.metaKey || e.ctrlKey)) {
        setPressed(true);
      }
    }),
  );

  useEventListener(
    document,
    "keyup",
    maybeNoop((e: KeyboardEvent) => {
      if (
        !alwaysShowRun &&
        (e.metaKey || e.ctrlKey || e.key === "Meta" || e.key === "Control")
      ) {
        setPressed(false);
      }
    }),
  );

  // Set pressed to false if the window loses focus
  useEventListener(
    window,
    "blur",
    maybeNoop(() => setPressed(false)),
  );
  useEventListener(
    window,
    "mouseleave",
    maybeNoop(() => setPressed(false)),
  );

  return pressed;
}