Skip to content

docs(useOutsideClickEffect): document nullable container arrays - #572

Merged
mnxmnz merged 1 commit into
toss:mainfrom
GamjaIsMine02:codex/docs-outside-click-nullable-containers
Oct 20, 2026
Merged

mnxmnz merged 1 commit into
toss:mainfrom
GamjaIsMine02:codex/docs-outside-click-nullable-containers

Conversation

@GamjaIsMine02

@GamjaIsMine02 GamjaIsMine02 commented Oct 20, 2026 •

Copy link
Copy Markdown
Contributor

Overview

The docs show container as HTMLElement | HTMLElement[] | null, but the existing API also accepts arrays containing null. For example, [null, element] is accepted by OneOrMore<HTMLElement | null> and the implementation filters out the null entry.

Correct the JSDoc type to HTMLElement | (HTMLElement | null)[] | null. Clarify that null entries are ignored and the callback is skipped when no HTML elements remain. Regenerate the English API page and agent skill reference, update all four translations, and add a patch changeset for the public JSDoc correction.

Checklist

  • Did you write the test code? (Documentation-only change; existing tests reused.)
  • Have you run yarn run fix to format and lint the code and docs?
  • Have you run yarn run test:coverage to make sure there is no uncovered line?
  • Did you write the JSDoc?

@changeset-bot

changeset-bot Bot commented Oct 20, 2026

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 150b976

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
react-simplikit Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@codecov-commenter

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (8ead31d) to head (150b976).

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff            @@
##              main      #572   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           69        69           
  Lines         2281      2281           
  Branches       737       737           
=========================================
  Hits          2281      2281           
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@mnxmnz mnxmnz left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for working on this! 👍

@mnxmnz
mnxmnz merged commit cf0dd83 into toss:main Oct 20, 2026
20 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants