useClickOutside

监听元素外部的点击。 对于模式或下拉菜单很有用。

useClickOutside 检测发生在引用 DOM 元素外部的点击（鼠标和触摸事件），并在发生时调用回调。传入目标元素的 ref、处理函数和可选的 enabled 布尔值来有条件地切换监听器。处理器接收原始的 MouseEvent 或 TouchEvent。

使用场景

  • 当用户点击外部时关闭下拉菜单、弹出框或模态框
  • 当焦点移走时取消选择或停用内联编辑组件
  • 在外部交互时关闭通知提示或上下文菜单

注意事项

  • 事件类型：监听 mousedown 和 touchstart 事件，覆盖桌面和移动交互。
  • 清理：当组件卸载或 enabled 设为 false 时，事件监听器会自动移除。
  • 也可使用 useClickAway，它是具有相同 API 和实现的别名。

Usage

Live Editor

function Demo() {
  const [visible, setVisible] = useState(false);

  const modalRef = useRef<HTMLDivElement>(null);

  useClickOutside(modalRef, () => {
    setVisible(false);
  });

  return (
    <div>
      <button onClick={() => setVisible(true)}>打开模态框</button>
      {visible && (
        <div
          ref={modalRef}
          style={{
            position: "fixed",
            left: "50%",
            top: "50%",
            transform: "translate(-50%,-50%)",
            width: 420,
            maxWidth: "100%",
            zIndex: 10,
            border: "1px solid var(--c-input-border)",
            background: "var(--c-bg)",
          }}
        >
          <div
            style={{
              padding: "0.4em 2em",
              boxShadow: "2px 2px 10px var(--c-box-shadow)",
            }}
          >
            <p
              style={{
                fontWeight: 700,
                fontSize: "1.4rem",
                marginBottom: "2rem",
              }}
            >
              Demo Modal
            </p>
            <p>点击模态框外部来关闭它。</p>
          </div>
        </div>
      )}
    </div>
  );
}
Result

API

useClickOutside

Returns

void

Arguments

参数名描述类型默认值
targetdom对象BasicTarget<Element> (必填)-
handler监听函数(evt: EventType) => void (必填)-
enabled监听函数是否生效boolean | undefined-

BasicTarget

export type BasicTarget<T extends TargetType = Element> = (() => TargetValue<T>) | TargetValue<T> | MutableRefObject<TargetValue<T>>;

TargetValue

type TargetValue<T> = T | undefined | null;

TargetType

type TargetType = HTMLElement | Element | Window | Document | EventTarget;

EventType

export type EventType = MouseEvent | TouchEvent;