Skip to content

feat(contextualhelp): add mod to allow max-width#3523

Merged
castastrophe merged 5 commits into
mainfrom
ttomar/swc-509
Feb 13, 2025
Merged

feat(contextualhelp): add mod to allow max-width#3523
castastrophe merged 5 commits into
mainfrom
ttomar/swc-509

Conversation

@TarunAdobe
Copy link
Copy Markdown
Contributor

@TarunAdobe TarunAdobe commented Jan 28, 2025

Description

Added a --mod property to allow consumers to set a max-width on the contextual help component.

How and where has this been tested?

Please tag yourself on the tests you've marked complete to confirm the tests have been run by someone other than the author.

Validation steps

Regression testing

Validate:

  1. The documentation pages for at least two other components are still loading, including:
  • The pages render correctly, are accessible, and are responsive.
  1. If components have been modified, VRTs have been run on this branch:
  • VRTs have been run and looked at.
  • Any VRT changes have been accepted (by reviewer and/or PR author), or there are no changes.

Screenshots

To-do list

  • I have read the contribution guidelines.
  • I have updated relevant storybook stories and templates.
  • I have tested these changes in Windows High Contrast mode.
  • If my change impacts other components, I have tested to make sure they don't break.
  • If my change impacts documentation, I have updated the documentation accordingly.
  • ✨ This pull request is ready to merge. ✨

@changeset-bot
Copy link
Copy Markdown

changeset-bot Bot commented Jan 28, 2025

🦋 Changeset detected

Latest commit: b7e1c04

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

This PR includes changesets to release 1 package
Name Type
@spectrum-css/contextualhelp Patch

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
Copy link
Copy Markdown
Contributor

github-actions Bot commented Jan 28, 2025

🚀 Deployed on https://pr-3523--spectrum-css.netlify.app

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Jan 28, 2025

File metrics

Summary

Total size: 2.25 MB*

Package Size Minified Gzipped
contextualhelp 2.20 KB 2.11 KB 0.73 KB

contextualhelp

Filename Head Minified Gzipped Compared to base
index.css 2.20 KB 2.11 KB 0.73 KB 🔴 ⬆ 0.08 KB
metadata.json 1.30 KB - - 🔴 ⬆ 0.06 KB
* Size is the sum of all main files for packages in the library.
* An ASCII character in UTF-8 is 8 bits or 1 byte.

@TarunAdobe TarunAdobe marked this pull request as ready for review January 28, 2025 11:41
@TarunAdobe TarunAdobe requested review from castastrophe and mdt2 and removed request for mdt2 January 28, 2025 11:41
@TarunAdobe TarunAdobe self-assigned this Jan 28, 2025
Comment thread .changeset/spicy-boats-repair.md Outdated
Comment thread components/contextualhelp/index.css Outdated
Comment thread components/contextualhelp/stories/contextualhelp.stories.js
Comment thread components/contextualhelp/stories/contextualhelp.stories.js Outdated
Comment thread components/contextualhelp/index.css
Comment thread components/contextualhelp/stories/contextualhelp.stories.js
Copy link
Copy Markdown
Collaborator

@marissahuysentruyt marissahuysentruyt left a comment

Choose a reason for hiding this comment

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

@TarunAdobe Nice work on this! I requested a few minor changes, but overall this is looking really good.

How would you feel about adding some documentation for these new stories? Even something pretty simple, like what you have in the changeset, would be nice.

Example docs: (feel free to expand on this- you can probably do a better job than me!)
"In order to further customize the contextual help popover, implementations can set --mod-spectrum-contextual-help-popover-maximum-width to their desired max width."

It might give users a little head start of figuring out how to customize this component.

Comment thread components/contextualhelp/stories/contextualhelp.stories.js
Comment thread components/contextualhelp/stories/contextualhelp.stories.js Outdated
Comment thread components/contextualhelp/stories/contextualhelp.stories.js
Comment thread components/contextualhelp/stories/contextualhelp.stories.js Outdated
@marissahuysentruyt
Copy link
Copy Markdown
Collaborator

@castastrophe @TarunAdobe oh I was just thinking- do we need to run VRTs on this branch before it merges? Since we updated the body content of the stories, I think Chromatic would flag it, right?

@castastrophe castastrophe changed the title chore(contextual-help): add mod to allow max-width feat(contextualhelp): add mod to allow max-width Feb 13, 2025
@castastrophe castastrophe added run_vrt For use on PRs looking to kick off VRT ready-for-review labels Feb 13, 2025
@castastrophe castastrophe enabled auto-merge (squash) February 13, 2025 19:13
@marissahuysentruyt marissahuysentruyt dismissed their stale review February 13, 2025 19:17

Don't want to hold up merging this! Quickly glancing, it's looking good!

@castastrophe castastrophe merged commit 71f7d4f into main Feb 13, 2025
@castastrophe castastrophe deleted the ttomar/swc-509 branch February 13, 2025 19:19
@github-actions github-actions Bot mentioned this pull request Feb 13, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ready-for-review run_vrt For use on PRs looking to kick off VRT

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants