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

SideNav - Deprecate SideNav::Header::IconButton (HDS-3770 ) #2354

Merged
merged 17 commits into from
Sep 3, 2024

Conversation

KristinLBradley
Copy link
Contributor

@KristinLBradley KristinLBradley commented Aug 21, 2024

📌 Summary

If merged, this PR will deprecate the Hds::SideNav::Header::IconButton component.

Previews:

🛠️ Detailed description

👉 Related reference on deprecating an HDS component or feature

Included changes:

  • Deprecated IconButton Ember component in code:
    • Added deprecate() call in JS/TS with notice
    • Added comment in component HBS file stating that it's deprecated
  • SideNav Showcase:
    • Updated examples to replace Hds::SideNav::Header::IconButton with Hds::Button.
    • Added examples of child interactive (Button & Dropdown) components to SideNav Showcase (similar to AppHeader Showcase).
  • Web docs:
    • Updated references & example code to remove deprecated component
    • Added deprecation warning notice in API docs for the IconButton

🔗 External links

Jira ticket: HDS-3770


👀 Component checklist

💬 Please consider using conventional comments when reviewing this PR.

Copy link

vercel bot commented Aug 21, 2024

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

Name Status Preview Updated (UTC)
hds-showcase ✅ Ready (Inspect) Visit Preview Sep 3, 2024 8:34pm
hds-website ✅ Ready (Inspect) Visit Preview Sep 3, 2024 8:34pm

url: 'https://helios.hashicorp.design/components/side-nav?tab=version%20history#480', // TODO: Confirm URL
for: '@hashicorp/design-system-components',
since: {
enabled: '4.9.0', // TODO: Confirm version
Copy link
Contributor Author

Choose a reason for hiding this comment

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

What should I do for the above version numbers and url? Would I edit later shortly before release? (Since I'm not sure what they should be?)

Copy link
Contributor

@Dhaulagiri Dhaulagiri Aug 27, 2024

Choose a reason for hiding this comment

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

Seems safe to assume this will land in 4.10 as part of #2330

Copy link
Contributor

Choose a reason for hiding this comment

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

But we can always change it directly in the release branch if we need to. Same with the URL, but you could assume it would be https://helios.hashicorp.design/components/side-nav?tab=version%20history#4100 for now

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ok, thank you!

@KristinLBradley KristinLBradley changed the title [DRAFT] SideNav - Deprecate SideNav::Header::IconButton (HDS-3770 ) SideNav - Deprecate SideNav::Header::IconButton (HDS-3770 ) Aug 27, 2024
@KristinLBradley KristinLBradley marked this pull request as ready for review August 27, 2024 21:11
@KristinLBradley KristinLBradley requested a review from a team August 27, 2024 21:12
@KristinLBradley
Copy link
Contributor Author

KristinLBradley commented Aug 27, 2024

Let me know if there's anything I missed in marking this as "deprecated".

@MelSumner

This comment was marked as resolved.

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.

👍

showcase/app/styles/showcase-pages/side-nav.scss Outdated Show resolved Hide resolved
….0.md

Co-authored-by: Brian Runnells <1672302+Dhaulagiri@users.noreply.github.com>
Co-authored-by: Cristiano Rastelli <cristiano.rastelli@hashicorp.com>
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 showcase
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants