Skip to content

docs: clarify OverlayProvider placement for context access - #229

Open
JetProc wants to merge 1 commit into
toss:mainfrom
JetProc:docs/overlay-provider-placement
Open

docs: clarify OverlayProvider placement for context access#229
JetProc wants to merge 1 commit into
toss:mainfrom
JetProc:docs/overlay-provider-placement

Conversation

@JetProc

@JetProc JetProc commented Jun 6, 2026

Copy link
Copy Markdown

Description

Closes #213.

This adds guidance to the introduction docs for placing OverlayProvider inside other application-level providers when overlays need access to those contexts.

Changes

  • Added provider placement guidance to the English introduction guide.
  • Added the same guidance to the Korean introduction guide.
  • Included an example with data fetching, routing, and theme providers wrapping OverlayProvider.

Motivation and Context

Overlays are rendered under OverlayProvider, so overlay components can only access context provided above OverlayProvider. This note helps users place OverlayProvider correctly when their overlays depend on providers such as query, router, theme, or i18n providers.

How Has This Been Tested?

  • corepack yarn lint
  • corepack yarn workspace overlay-kit run build
  • corepack yarn workspace overlay-kit run test
  • corepack yarn workspace overlay-kit run test:publint
  • corepack yarn workspace overlay-kit run test:attw
  • corepack yarn workspace @overlay-kit/framer-motion-react-16 run build
  • corepack yarn workspace @overlay-kit/framer-motion-react-17 run build
  • corepack yarn workspace @overlay-kit/framer-motion-react-18 run build
  • corepack yarn workspace @overlay-kit/framer-motion-react-19 run build

Screenshots (if appropriate):

N/A

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.
  • 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.
  • New and existing unit tests pass locally with my changes.
  • Any dependent changes have been merged and published in downstream modules.

Further Comments

Documentation-only change.

Overlay components are rendered under OverlayProvider, so the introduction now shows placing it inside application-level providers when overlays need access to their contexts.

Related: toss#213

Tested: corepack yarn lint; corepack yarn workspace overlay-kit run build; corepack yarn workspace overlay-kit run test; corepack yarn workspace overlay-kit run test:publint; corepack yarn workspace overlay-kit run test:attw; React 16/17/18/19 example builds
@JetProc
JetProc requested a review from jungpaeng as a code owner June 6, 2026 10:44
@vercel

vercel Bot commented Jun 6, 2026

Copy link
Copy Markdown

@JetProc 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 Jun 6, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 21f7b08

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

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.

Feedback for “overlay-kit 소개”

1 participant