From 150b9761df53bf561428df58983f0bbaf7aae131 Mon Sep 17 00:00:00 2001 From: GGGGGGGGGGGGGGG_J <115770858+NaturalSoda4552@users.noreply.github.com> Date: Tue, 20 Oct 2026 11:37:35 +0900 Subject: [PATCH] docs(useOutsideClickEffect): document nullable container arrays --- .changeset/nullable-outside-click-containers.md | 5 +++++ .../react-simplikit/references/useOutsideClickEffect.md | 6 +++--- .../hooks/useOutsideClickEffect/es/useOutsideClickEffect.md | 6 +++--- .../hooks/useOutsideClickEffect/ja/useOutsideClickEffect.md | 6 +++--- .../hooks/useOutsideClickEffect/ko/useOutsideClickEffect.md | 6 +++--- .../hooks/useOutsideClickEffect/useOutsideClickEffect.md | 6 +++--- .../hooks/useOutsideClickEffect/useOutsideClickEffect.ts | 4 ++-- .../useOutsideClickEffect/zh-Hans/useOutsideClickEffect.md | 6 +++--- 8 files changed, 25 insertions(+), 20 deletions(-) create mode 100644 .changeset/nullable-outside-click-containers.md diff --git a/.changeset/nullable-outside-click-containers.md b/.changeset/nullable-outside-click-containers.md new file mode 100644 index 00000000..ecbbd4d5 --- /dev/null +++ b/.changeset/nullable-outside-click-containers.md @@ -0,0 +1,5 @@ +--- +'react-simplikit': patch +--- + +Document that `useOutsideClickEffect` accepts `null` entries in container arrays, matching its existing type and behavior. diff --git a/packages/plugin/skills/react-simplikit/references/useOutsideClickEffect.md b/packages/plugin/skills/react-simplikit/references/useOutsideClickEffect.md index 36d526de..66da3362 100644 --- a/packages/plugin/skills/react-simplikit/references/useOutsideClickEffect.md +++ b/packages/plugin/skills/react-simplikit/references/useOutsideClickEffect.md @@ -7,7 +7,7 @@ It is useful for closing modals, dropdowns, tooltips, and other UI components wh ```ts function useOutsideClickEffect( - container: HTMLElement | HTMLElement[] | null, + container: HTMLElement | (HTMLElement | null)[] | null, callback: () => void ): void; ``` @@ -17,8 +17,8 @@ function useOutsideClickEffect( void ): void; ``` @@ -17,8 +17,8 @@ function useOutsideClickEffect( void ): void; ``` @@ -17,8 +17,8 @@ function useOutsideClickEffect( void ): void; ``` @@ -16,8 +16,8 @@ function useOutsideClickEffect( void ): void; ``` @@ -17,8 +17,8 @@ function useOutsideClickEffect( = T | T[]; * `useOutsideClickEffect` is a React hook that triggers a callback when a click event occurs outside the specified container(s). * It is useful for closing modals, dropdowns, tooltips, and other UI components when clicking outside. * - * @param {HTMLElement | HTMLElement[] | null} container - A single HTML element, an array of HTML elements, or `null`. - * If `null`, the callback is not executed. + * @param {HTMLElement | (HTMLElement | null)[] | null} container - A single HTML element, an array of HTML elements or `null` values, or `null`. + * `null` entries are ignored. If no HTML elements remain, the callback is not executed. * @param {() => void} callback - A function that is executed when clicking outside the specified container(s). * * @example diff --git a/packages/react-simplikit/src/hooks/useOutsideClickEffect/zh-Hans/useOutsideClickEffect.md b/packages/react-simplikit/src/hooks/useOutsideClickEffect/zh-Hans/useOutsideClickEffect.md index 88f96759..f41f9855 100644 --- a/packages/react-simplikit/src/hooks/useOutsideClickEffect/zh-Hans/useOutsideClickEffect.md +++ b/packages/react-simplikit/src/hooks/useOutsideClickEffect/zh-Hans/useOutsideClickEffect.md @@ -6,7 +6,7 @@ ```ts function useOutsideClickEffect( - container: HTMLElement | HTMLElement[] | null, + container: HTMLElement | (HTMLElement | null)[] | null, callback: () => void ): void; ``` @@ -16,8 +16,8 @@ function useOutsideClickEffect(