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

Rename namespaced contextual components #1884

Merged
merged 11 commits into from
Feb 5, 2024

Conversation

alex-ju
Copy link
Member

@alex-ju alex-ju commented Jan 4, 2024

📌 Summary

Rename namespaced contextual components as follows:

  • Alert::Link::Standalone to Alert::LinkStandalone
  • ApplicationState::Footer::Link::Standalone to ApplicationState::Footer::LinkStandalone
  • Form::Checkbox::Group::Checkbox::Field to Checkbox::Group::CheckboxField
  • Form::Radio::Group::Radio::Field to Form::Radio::Group::RadioField
  • Form::Toggle::Group::Toggle::Field to Form::Toggle::Group::ToggleField
  • Toast::Link::Standalone to Toast::LinkStandalone

The new names are more idiomatic, will align these instances with other subcomponents, and provide a smooth path when imported to gts.

Note: As this is a major change, we'll try to add codemods in this PR to help with migrating to the new format.

🔗 External links

Jira ticket: HDS-2972


👀 Component checklist

  • Percy was checked for any visual regression
  • A11y tests have been run locally (yarn test:a11y --filter="COMPONENT-NAME")
  • If documenting a new component, an acceptance test that includes the a11yAudit has been added
  • A changelog entry was added via Changesets if needed (see templates here)

💬 Please consider using conventional comments when reviewing this PR.

Copy link

vercel bot commented Jan 4, 2024

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

Name Status Preview Updated (UTC)
hds-showcase ✅ Ready (Inspect) Visit Preview Feb 5, 2024 6:42pm
hds-website ✅ Ready (Inspect) Visit Preview Feb 5, 2024 6:42pm

@hashibot-hds hashibot-hds added packages/components docs-website Content updates to the documentation website labels Jan 4, 2024
@alex-ju alex-ju changed the title Renamed namespaced contextual components Rename namespaced contextual components Jan 4, 2024
Copy link
Contributor

@didoo didoo left a comment

Choose a reason for hiding this comment

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

All good for me 👍

Question: should we provide also a codemod for the consumers?
Saw your message in Slack. Let me know when the codemod is added so I can review it as well

@alex-ju alex-ju force-pushed the alex-ju/rename-contextual-components branch from 2e3fb49 to 4ebf4e9 Compare February 5, 2024 18:34
@alex-ju alex-ju merged commit 973c08e into main Feb 5, 2024
15 checks passed
@alex-ju alex-ju deleted the alex-ju/rename-contextual-components branch February 5, 2024 18:48
@hashibot-hds hashibot-hds mentioned this pull request Feb 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs-website Content updates to the documentation website packages/components
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants