docs: clarify OverlayProvider placement for context access - #229
Open
JetProc wants to merge 1 commit into
Open
Conversation
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 is attempting to deploy a commit to the Toss Team on Vercel. A member of the Team first needs to authorize it. |
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Closes #213.
This adds guidance to the introduction docs for placing
OverlayProviderinside other application-level providers when overlays need access to those contexts.Changes
OverlayProvider.Motivation and Context
Overlays are rendered under
OverlayProvider, so overlay components can only access context provided aboveOverlayProvider. This note helps users placeOverlayProvidercorrectly when their overlays depend on providers such as query, router, theme, or i18n providers.How Has This Been Tested?
corepack yarn lintcorepack yarn workspace overlay-kit run buildcorepack yarn workspace overlay-kit run testcorepack yarn workspace overlay-kit run test:publintcorepack yarn workspace overlay-kit run test:attwcorepack yarn workspace @overlay-kit/framer-motion-react-16 run buildcorepack yarn workspace @overlay-kit/framer-motion-react-17 run buildcorepack yarn workspace @overlay-kit/framer-motion-react-18 run buildcorepack yarn workspace @overlay-kit/framer-motion-react-19 run buildScreenshots (if appropriate):
N/A
Types of changes
Checklist
Further Comments
Documentation-only change.