-
Notifications
You must be signed in to change notification settings - Fork 626
v38: Deprecate PointerBox component #6704
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
base: main
Are you sure you want to change the base?
Conversation
🦋 Changeset detectedLatest commit: cbbcfb0 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 deprecates the PointerBox component as part of v38, moving it from the main component exports to the deprecated bundle. The component is being phased out in favor of more modern alternatives like Overlay or Position + Box with caret.
- Moves PointerBox exports from main index to deprecated bundle
- Adds deprecation JSDoc comments to component and type definitions
- Updates Storybook configuration to categorize under "Deprecated/Components"
- Changes component status from "alpha" to "deprecated" in documentation metadata
Reviewed Changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.
Show a summary per file
File | Description |
---|---|
packages/react/src/index.ts | Removes PointerBox exports from main bundle |
packages/react/src/deprecated/index.ts | Adds PointerBox exports to deprecated bundle |
packages/react/src/PointerBox/PointerBox.tsx | Adds JSDoc deprecation warnings to component and types |
packages/react/src/PointerBox/PointerBox.stories.tsx | Updates Storybook category and adds deprecation notice |
packages/react/src/PointerBox/PointerBox.docs.json | Changes status from "alpha" to "deprecated" |
parameters: { | ||
docs: { | ||
description: { | ||
component: 'PointerBox is deprecated and will be removed in a future major release. Consider using Overlay.', |
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.
The deprecation message is inconsistent with the JSDoc comments in the component file. The JSDoc suggests 'Overlay or Position + Box with a caret' while this only mentions 'Overlay'. Consider aligning the messaging to match the more detailed alternative provided in the JSDoc comments.
component: 'PointerBox is deprecated and will be removed in a future major release. Consider using Overlay.', | |
component: 'PointerBox is deprecated and will be removed in a future major release. Consider using Overlay or Position + Box with a caret.', |
Copilot uses AI. Check for mistakes.
Updated versioning for @primer/react from patch to major due to deprecation of PointerBox component.
👋 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 📦
|
Part of # https://github.com/github/primer/issues/5536
Changelog
New
Changed
Removed
Rollout strategy
Testing & Reviewing
Merge checklist