feat: locally overlay-kit

[jungpaeng]

Description

Related Issue: Fixes # (issue_number)

This PR modifies the overlay-kit, which was previously available only globally, to be usable in local environments.

To achieve this, components like OverlayProvider have been adapted into a createOverlayProvider format, making them reusable locally.

Users can now utilize the new function experimental_createOverlayContext, which enables this local usage. However, since this function is experimental, caution is advised when using it.

Changes

• Transformed OverlayProvider and similar components into createOverlayProvider for local use.
• Introduced a new function, experimental_createOverlayContext, allowing local context creation for overlays.

Motivation and Context

Previously, the overlay-kit could only be used globally, limiting flexibility in development.

This change enables developers to utilize overlay functionality in localized contexts, enhancing modularity and reusability.

How Has This Been Tested?

• Manually tested the experimental_createOverlayContext function in local environments to verify its functionality.

Screenshots (if appropriate):

example code

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

Since experimental_createOverlayContext is experimental, users should proceed with caution and monitor its behavior in various use cases.

[changeset-bot]

🦋 Changeset detected

Latest commit: b64faa5

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

This PR includes changesets to release 1 package

Name	Type
overlay-kit	Minor

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

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
overlay-kit	❌ Failed (Inspect)			Jan 13, 2025 6:14am

Copilot reviewed 5 out of 9 changed files in this pull request and generated no comments.

Files not reviewed (4)

• packages/src/context/provider.tsx: Evaluated as low risk
• packages/src/context/use-sync-overlay-store.ts: Evaluated as low risk
• packages/src/utils/index.ts: Evaluated as low risk
• packages/src/event.ts: Evaluated as low risk

[codecov-commenter]

Codecov Report

Attention: Patch coverage is 92.02454% with 13 lines in your changes missing coverage. Please review.

Project coverage is 84.24%. Comparing base (59f2917) to head (b64faa5).

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #102      +/-   ##
==========================================
+ Coverage   81.48%   84.24%   +2.76%     
==========================================
  Files          11       13       +2     
  Lines         243      273      +30     
  Branches       49       55       +6     
==========================================
+ Hits          198      230      +32     
+ Misses         43       40       -3     
- Partials        2        3       +1     

Components	Coverage Δ
overlay-kit	84.24% <92.02%> (+2.76%)	⬆️

[XionWCFM]

I really needed this feature. I want to try it 🔥

[jungpaeng]

I really needed this feature. I want to try it 🔥

You can try the package by installing it with the following command:

npm install overlay-kit@canary

The official release will be published along with updated documentation. Your feedback is highly valued and greatly appreciated!