Skip to content

chore(Box): Mark Box and its props as deprecated #5763

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 6 commits into from
Mar 13, 2025
Merged

chore(Box): Mark Box and its props as deprecated #5763

merged 6 commits into from
Mar 13, 2025

Conversation

@hussam-i-am
Copy link
Contributor

@hussam-i-am hussam-i-am commented Mar 11, 2025 •
edited
Loading

Closes https://github.com/github/primer/issues/4791
Closes https://github.com/github/primer/issues/4868

Changelog

New

Changed

  • Adds @deprecated annotation to Box and BoxProps
  • Moves Box under Deprecated section of Storybook
  • Adds doc

Removed

Rollout strategy

  • Patch release
  • Minor release
  • Major release; if selected, include a written rollout or migration plan
  • None; if selected, include a brief description as to why

Testing & Reviewing

Merge checklist

@hussam-i-am hussam-i-am self-assigned this Mar 11, 2025
@changeset-bot
Copy link

changeset-bot bot commented Mar 11, 2025 •
edited
Loading

🦋 Changeset detected

Latest commit: 84bf91d

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

This PR includes changesets to release 1 package
Name Type
@primer/react 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

@github-actions github-actions bot added the integration-tests: recommended This change needs to be tested for breaking changes. See https://arc.net/l/quote/tdmpakpm label Mar 11, 2025
@github-actions
Copy link
Contributor

github-actions bot commented Mar 11, 2025

👋 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!

@github-actions
Copy link
Contributor

github-actions bot commented Mar 11, 2025 •
edited
Loading

size-limit report 📦

Path Size
packages/react/dist/browser.esm.js 106.05 KB (0%)
packages/react/dist/browser.umd.js 106.33 KB (0%)

@hussam-i-am hussam-i-am marked this pull request as ready for review March 11, 2025 18:25
@hussam-i-am hussam-i-am requested a review from a team as a code owner March 11, 2025 18:25
@hussam-i-am hussam-i-am requested a review from jonrohan March 11, 2025 18:25
@github-actions github-actions bot temporarily deployed to storybook-preview-5763 March 11, 2025 18:35 Inactive
jonrohan
jonrohan reviewed Mar 12, 2025
View reviewed changes
Copy link
Member

@jonrohan jonrohan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we still need to update some docs for the Box component https://github.com/primer/react/blob/main/contributor-docs/deprecating-components.md#deprecating-a-component

packages/react/src/Box/Box.tsx
/**
* @deprecated The Box component is deprecated. Replace with a `div` or
* appropriate HTML element instead, with CSS modules for styling.
*/
Copy link
Member

@jonrohan jonrohan Mar 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤔 I'm not sure what the best docs to point to are here.

Copy link
Contributor Author

@hussam-i-am hussam-i-am Mar 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Created a doc to link to: https://github.com/primer/react/blob/hussam-i-am/deprecate-box/contributor-docs/migration-from-box.md

@github-actions github-actions bot requested a deployment to storybook-preview-5763 March 12, 2025 19:27 Abandoned
@github-actions github-actions bot temporarily deployed to storybook-preview-5763 March 12, 2025 19:41 Inactive
@github-actions github-actions bot temporarily deployed to storybook-preview-5763 March 12, 2025 20:56 Inactive
@hussam-i-am hussam-i-am added this pull request to the merge queue Mar 13, 2025
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Mar 13, 2025
@hussam-i-am hussam-i-am enabled auto-merge March 13, 2025 18:54
@hussam-i-am hussam-i-am added this pull request to the merge queue Mar 13, 2025
Merged via the queue into main with commit d3926d1 Mar 13, 2025
44 checks passed
@hussam-i-am hussam-i-am deleted the hussam-i-am/deprecate-box branch March 13, 2025 19:15
@primer primer bot mentioned this pull request Mar 13, 2025
Merged
hectahertz pushed a commit that referenced this pull request Mar 20, 2025
@hussam-i-am @hectahertz
chore(Box): Mark Box and its props as deprecated (#5763)
73cdaf5
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jonrohan jonrohan jonrohan approved these changes

Assignees

@hussam-i-am hussam-i-am

Labels

integration-tests: recommended This change needs to be tested for breaking changes. See https://arc.net/l/quote/tdmpakpm

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@hussam-i-am @jonrohan