Skip to content
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

Deprecate use of sx prop by deprecating the SxProp type definition #5443

Merged
merged 6 commits into from
Dec 18, 2024

Conversation

jonrohan
Copy link
Member

@jonrohan jonrohan commented Dec 13, 2024

Closes https://github.com/github/primer/issues/4571

This pull deprecates the SxProp type definition. This will inform anyone using the sx prop on these components that it is deprecated and should be CSS modules instead. The result is non-blocking but looks like this in the editor:

CleanShot 2024-12-13 at 13 46 43@2x

Changelog

New

Depreacte use of sx prop by switching to a deprecated type definition

Changed

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

@jonrohan jonrohan requested a review from a team as a code owner December 13, 2024 21:49
@jonrohan jonrohan requested a review from joshblack December 13, 2024 21:49
Copy link

changeset-bot bot commented Dec 13, 2024

🦋 Changeset detected

Latest commit: ca0f8d1

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

Copy link
Contributor

Uh oh! @jonrohan, the image you shared is missing helpful alt text. Check your pull request body.

Alt text is an invisible description that helps screen readers describe images to blind or low-vision users. If you are using markdown to display images, add your alt text inside the brackets of the markdown image.

Learn more about alt text at Basic writing and formatting syntax: images on GitHub Docs.

🤖 Beep boop! This comment was added automatically by github/accessibility-alt-text-bot.

@github-actions github-actions bot added the staff Author is a staff member label Dec 13, 2024
@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 Dec 13, 2024
Copy link
Contributor

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

@jonrohan jonrohan changed the title Depreacte use of sx prop by switching to a deprecated type definition Deprecate use of sx prop by switching to a deprecated type definition Dec 13, 2024
Copy link
Contributor

Uh oh! @jonrohan, the image you shared is missing helpful alt text. Check your pull request body.

Alt text is an invisible description that helps screen readers describe images to blind or low-vision users. If you are using markdown to display images, add your alt text inside the brackets of the markdown image.

Learn more about alt text at Basic writing and formatting syntax: images on GitHub Docs.

🤖 Beep boop! This comment was added automatically by github/accessibility-alt-text-bot.

Copy link
Contributor

github-actions bot commented Dec 13, 2024

size-limit report 📦

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

@github-actions github-actions bot temporarily deployed to storybook-preview-5443 December 13, 2024 21:53 Inactive
@jonrohan
Copy link
Member Author

Thinking on this more, I think only the converted components are using SxProp so might be better to just deprecate that type rather than creating a new one

Copy link
Contributor

Uh oh! @jonrohan, the image you shared is missing helpful alt text. Check your pull request body.

Alt text is an invisible description that helps screen readers describe images to blind or low-vision users. If you are using markdown to display images, add your alt text inside the brackets of the markdown image.

Learn more about alt text at Basic writing and formatting syntax: images on GitHub Docs.

🤖 Beep boop! This comment was added automatically by github/accessibility-alt-text-bot.

@jonrohan jonrohan changed the title Deprecate use of sx prop by switching to a deprecated type definition Deprecate use of sx prop by deprecating the SxProp type definition Dec 18, 2024
Copy link
Contributor

Uh oh! @jonrohan, the image you shared is missing helpful alt text. Check your pull request body.

Alt text is an invisible description that helps screen readers describe images to blind or low-vision users. If you are using markdown to display images, add your alt text inside the brackets of the markdown image.

Learn more about alt text at Basic writing and formatting syntax: images on GitHub Docs.

🤖 Beep boop! This comment was added automatically by github/accessibility-alt-text-bot.

@primer-integration
Copy link

👋 Hi from github/github! Your integration PR is ready: https://github.com/github/github/pull/355834

@primer-integration
Copy link

🟢 golden-jobs completed with status success.

@github-actions github-actions bot added integration-tests: passing Changes in this PR do NOT cause breaking changes in gh/gh and removed integration-tests: recommended This change needs to be tested for breaking changes. See https://arc.net/l/quote/tdmpakpm labels Dec 18, 2024
@jonrohan jonrohan added this pull request to the merge queue Dec 18, 2024
Copy link
Contributor

Uh oh! @jonrohan, the image you shared is missing helpful alt text. Check your pull request body.

Alt text is an invisible description that helps screen readers describe images to blind or low-vision users. If you are using markdown to display images, add your alt text inside the brackets of the markdown image.

Learn more about alt text at Basic writing and formatting syntax: images on GitHub Docs.

🤖 Beep boop! This comment was added automatically by github/accessibility-alt-text-bot.

Merged via the queue into main with commit f03ae58 Dec 18, 2024
44 checks passed
@jonrohan jonrohan deleted the deprecate_sx_prop branch December 18, 2024 21:09
@primer primer bot mentioned this pull request Dec 18, 2024
@jonrohan jonrohan mentioned this pull request Dec 18, 2024
13 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
integration-tests: passing Changes in this PR do NOT cause breaking changes in gh/gh staff Author is a staff member
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants