-
Couldn't load subscription status.
- Fork 639
v38: Move pointerbox to deprecated still maintaining the main export #6751
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
🦋 Changeset detectedLatest commit: 9b1c809 The changes in this PR will be included in the next version bump. This PR includes changesets to release 2 packages
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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR moves the PointerBox component to the deprecated module as part of v38, maintaining backward compatibility by keeping the main export available while preparing for future removal.
- Adds PointerBox to the deprecated exports module with proper deprecation documentation
- Updates test imports to use direct component imports instead of main package exports
- Moves Storybook documentation to the deprecated section with appropriate warnings
Reviewed Changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| packages/react/src/deprecated/index.ts | Adds PointerBox and PointerBoxProps exports to deprecated module |
| packages/react/src/tests/snapshots/exports.test.ts.snap | Updates export snapshots reflecting PointerBox removal from main exports and addition to deprecated |
| packages/react/src/PointerBox/PointerBox.tsx | Adds JSDoc deprecation warnings to component and type definitions |
| packages/react/src/PointerBox/PointerBox.test.tsx | Updates import to use direct component import instead of main package export |
| packages/react/src/PointerBox/PointerBox.stories.tsx | Moves story to deprecated section and adds deprecation notice |
| packages/react/src/PointerBox/PointerBox.docs.json | Updates status to deprecated and changes import path to deprecated module |
|
👋 Hi, this pull request contains changes to the source code that github/github depends on. If you are GitHub staff, we recommend testing these changes with github/github using the integration workflow. Thanks! |
size-limit report 📦
|
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
| "@primer/react": patch | ||
| --- | ||
|
|
||
| v38: Move pointerbox to deprecated still maintaining the main export |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
is there a reason we want to maintain the main export or can we move to deprecated under v38 major?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
So this was basically reverted because we have some main export usages
Part of # https://github.com/github/primer/issues/5536
Changelog
New
Changed
Removed
Rollout strategy
Testing & Reviewing
Merge checklist