Skip to content

HDS Docs - Breakpoints #2855

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

Merged
merged 24 commits into from
May 14, 2025
Merged

HDS Docs - Breakpoints #2855

merged 24 commits into from
May 14, 2025

Conversation

majedelass
Copy link
Contributor

@majedelass majedelass commented May 6, 2025

📌 Summary

If merged, this PR will add a new section within the Foundations section for Breakpoints.

Preview: https://hds-website-git-breakpoints-hashicorp.vercel.app/foundations/breakpoints

🛠️ Detailed description

Following the work done for the memo describing what path we are taking and what comes next, this PR is to create the new section describing the different breakpoints, their application and how to design uses these standards.

🔗 External links

Memo: Standardizing Breakpoints
Jira ticket: HDS-4831
Figma file: Breakpoints project


💬 Please consider using conventional comments when reviewing this PR.

@majedelass majedelass requested review from a team as code owners May 6, 2025 12:28
@majedelass majedelass added the docs-website Content updates to the documentation website label May 6, 2025
Copy link

vercel bot commented May 6, 2025

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

Name Status Preview Updated (UTC)
hds-showcase ✅ Ready (Inspect) Visit Preview May 14, 2025 6:41am
hds-website ✅ Ready (Inspect) Visit Preview May 14, 2025 6:41am

@majedelass majedelass marked this pull request as draft May 6, 2025 14:52
@majedelass majedelass changed the title HDS Docs - Breakpoints HDS Docs - Breakpoints May 6, 2025
Copy link
Contributor

@jorytindall jorytindall left a comment

Choose a reason for hiding this comment

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

Nice first pass! There is some inconsistent language usage that I tried to catch, and I added some suggestions for expressing some of that content in more plain language. Whether these accurately express what you're trying to say, TBD! But take what you feel is relevant from them.

@didoo
Copy link
Contributor

didoo commented May 13, 2025

@jorytindall @shleewhite @KristinLBradley @dchyun I had to push a couple of extra commit, any of you can re-approve? thanks


### JavaScript

We also provide helpers in case you need to access the breakpoints names/values in JavaScript code.
Copy link
Contributor

Choose a reason for hiding this comment

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

(Question, non-blocker) How often do we expect this to happen? Should the language reflect whether or not this is a good idea? In other places we've said things like, "should you need to" which is more of an indicator that it's there but use with caution.

Copy link
Contributor

Choose a reason for hiding this comment

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

There's nothing "dangerous" in them using the breakpoints in JS, it depends on the context where they need it (meet them where they are). There are use cases where controlling responsive behaviour in JS is inevitable (and in fact, that's what we do ourselves in the AppHeader and AppSideNav/SideNav components).

MelSumner
MelSumner previously approved these changes May 13, 2025
Copy link
Contributor

@MelSumner MelSumner left a comment

Choose a reason for hiding this comment

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

Left a suggestion to make something less wordy but no blockers.

MelSumner
MelSumner previously approved these changes May 13, 2025
jorytindall
jorytindall previously approved these changes May 13, 2025
MelSumner
MelSumner previously approved these changes May 14, 2025
@dchyun
Copy link
Contributor

dchyun commented May 14, 2025

@didoo please update the base of this to the new release/website-4-20 branch. We will be merging all docs updates into this branch, and then merging it into main post-release.

@didoo didoo changed the base branch from main to release/website-4-20 May 14, 2025 16:30
@didoo didoo dismissed stale reviews from KristinLBradley and MelSumner May 14, 2025 16:30

The base branch was changed.

@didoo
Copy link
Contributor

didoo commented May 14, 2025

@dchyun done. I need re-approval now.

@didoo didoo merged commit 12d8833 into release/website-4-20 May 14, 2025
11 checks passed
@didoo didoo deleted the breakpoints branch May 14, 2025 17:04
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

9 participants