Skip to content

docs: clarify useCurrentOverlay behavior - #232

Open
jureuk7 wants to merge 1 commit into
toss:mainfrom
jureuk7:docs/clarify-use-current-overlay
Open

jureuk7 wants to merge 1 commit into
toss:mainfrom
jureuk7:docs/clarify-use-current-overlay

Conversation

@jureuk7

@jureuk7 jureuk7 commented Sep 3, 2026

Copy link
Copy Markdown

Description

Clarifies the exact behavior of useCurrentOverlay so that “top-most” is not interpreted as visual z-index or simply the most recently called overlay.

Related Issue: N/A — documentation clarification

Changes

  • Explain that opening an overlay makes its ID current.
  • Document that reopening a closed overlay with the same ID preserves its original registration order.
  • Explain close/unmount fallback behavior and the null state.
  • Keep the Korean and English guides, ai.txt, llms.txt, and llms-full.txt synchronized.

Motivation and Context

The previous wording described the “top-most overlay” without defining whether that meant visual stacking, call order, or registration order. The reducer tracks a current ID and falls back through remaining open overlays in registration order, including the same-ID reopen edge case. This change documents those observable semantics directly.

How Has This Been Tested?

  • yarn workspace overlay-kit test — 57 tests passed with no type errors.
  • An isolated reducer scenario verified A/B/C, close A, reopen A while preserving [A, B, C], close C → B, and final unmount → null.
  • YARN_NODE_LINKER=node-modules yarn workspace docs build — 68/68 static pages generated.
  • Production HTTP checks returned 200 for both localized hook pages and all three public AI/LLM text files.
  • Both hook pages were visually checked in Chromium at a 360px viewport with no clipping or horizontal overflow.
  • Both changed MDX files pass Prettier.

Screenshots (if appropriate):

N/A — copy-only documentation update; both localized pages were visually verified.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation update

Checklist

  • I have performed a self-review of my own code.
  • My code is commented, particularly in hard-to-understand areas. (Not applicable: documentation-only change.)
  • I have made corresponding changes to the documentation.
  • My changes generate no new warnings.
  • I have added tests that prove my fix is effective or that my feature works. (Not applicable: no runtime behavior changed.)
  • New and existing unit tests pass locally with my changes.
  • Any dependent changes have been merged and published in downstream modules. (Not applicable: no dependent changes.)

Further Comments

No changeset is included because this is a documentation-only change with no package behavior or version change.

@jureuk7
jureuk7 requested a review from jungpaeng as a code owner September 3, 2026 11:38
@vercel

vercel Bot commented Sep 3, 2026

Copy link
Copy Markdown

@jureuk7 is attempting to deploy a commit to the Toss Team on Vercel.

A member of the Team first needs to authorize it.

@changeset-bot

changeset-bot Bot commented Sep 3, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: d217833

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

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

This branch has not been deployed

No deployments
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.

1 participant