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

feat(coachmark): S2 migration #3412

Open
wants to merge 3 commits into
base: spectrum-two
Choose a base branch
from

Conversation

cdransf
Copy link
Member

@cdransf cdransf commented Nov 21, 2024

Description

CSS-1024

S2 coachmark migration

This migrates the coachmark component to S2. Custom properties have been remapped per the design spec.

Before After
--spectrum-heading-sans-serif-font-weight --spectrum-title-sans-serif-font-weight
--spectrum-coach-mark-title-size --spectrum-coach-mark-title-font-size
--spectrum-heading-line-height --spectrum-title-line-height
--spectrum-coach-mark-body-size --spectrum-coach-mark-body-font-size
--spectrum-body-sans-serif-font-style --spectrum-body-serif-font-style
--spectrum-coach-mark-pagination-body-size --spectrum-coach-mark-pagination-body-font-size

Validation steps

  1. Open the URL for the PR.
  2. Navigate to the coachmark component and verify no regressions have occurred.

Note: the new font-family tokens set the font to Adobe Clean but Adobe Clean is not loading on the branch created from the spectrum-two base branch.

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.

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. ✨

@cdransf cdransf added size-2 S ~6-18hrs; not hard or time consuming, one or two work days to complete. skip_vrt Add to a PR to skip running VRT (but still pass the action) ready-for-review labels Nov 21, 2024
@cdransf cdransf self-assigned this Nov 21, 2024
Copy link

changeset-bot bot commented Nov 21, 2024

🦋 Changeset detected

Latest commit: c7098c0

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/coachmark Major

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

github-actions bot commented Nov 21, 2024

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

Copy link
Contributor

github-actions bot commented Nov 21, 2024

File metrics

Summary

Total size: 4.29 MB*
Total change (Δ): ⬆ 0.09 KB (0.00%)

Table reports on changes to a package's main file. Other changes can be found in the collapsed Details section below.

Package Size Δ
coachmark 7.82 KB ⬆ < 0.01 KB

Details

coachmark

File Head Base Δ
index-base.css 7.82 KB 7.82 KB ⬆ < 0.01 KB (0.04%)
index-vars.css 7.82 KB 7.82 KB ⬆ < 0.01 KB (0.04%)
index.css 7.82 KB 7.82 KB ⬆ < 0.01 KB (0.04%)
metadata.json 4.41 KB 4.33 KB ⬆ 0.08 KB (1.87%)
* Size determined by adding together the size of the main file for all packages in the library.
* Results are not gzipped or minified.
* An ASCII character in UTF-8 is 8 bits or 1 byte.

Copy link
Collaborator

@jawinn jawinn left a comment

Choose a reason for hiding this comment

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

I'm seeing a few things on the design not represented yet.

Line-height changes
I see body and pagination in the S2 specs marked as using line-height-200. I don't see the CSS using this token.
Screenshot 2024-11-22 at 10 55 57 AM

Keyboard shortcut
I don't see this new feature represented yet in our Docs examples or styles or controls. Does design need to define tokens for these keyboard shortcut elements on the specs?
Screenshot 2024-11-22 at 11 22 12 AM
Screenshot 2024-11-22 at 11 20 35 AM
Screenshot 2024-11-22 at 11 20 18 AM

4:3 and 16:19 image
The design shows an example of images at both of these aspect ratios, that we should demonstrate in our docs and maybe have a control for. I'm not exactly sure how this ties in with the sizing of the image and tokens.

Wait on popover to finalize?
This component is heavily reliant on popover, which has its S2 migration in progress and has been discussing and updating some items related to coachmark (#3365). So it may be worth waiting on that to merge before final review of its design.

components/coachmark/index.css Outdated Show resolved Hide resolved
components/coachmark/index.css Outdated Show resolved Hide resolved
@cdransf cdransf added the blocks Anything where Spectrum-CSS is blocking someone else label Nov 22, 2024
@cdransf
Copy link
Member Author

cdransf commented Nov 22, 2024

I'm seeing a few things on the design not represented yet.

Line-height changes I see body and pagination in the S2 specs marked as using line-height-200. I don't see the CSS using this token. Screenshot 2024-11-22 at 10 55 57 AM

Keyboard shortcut I don't see this new feature represented yet in our Docs examples or styles or controls. Does design need to define tokens for these keyboard shortcut elements on the specs? Screenshot 2024-11-22 at 11 22 12 AM Screenshot 2024-11-22 at 11 20 35 AM Screenshot 2024-11-22 at 11 20 18 AM

4:3 and 16:19 image The design shows an example of images at both of these aspect ratios, that we should demonstrate in our docs and maybe have a control for. I'm not exactly sure how this ties in with the sizing of the image and tokens.

Wait on popover to finalize? This component is heavily reliant on popover, which has its S2 migration in progress and has been discussing and updating some items related to coachmark (#3365). So it may be worth waiting on that to merge before final review of its design.

Awesome catches! I updated the line-height and font tokens. I marked this blocked pending the popover work and started a thread about the image implementation (one token includes -minimum- which seems odd semantically.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
blocks Anything where Spectrum-CSS is blocking someone else ready-for-review size-2 S ~6-18hrs; not hard or time consuming, one or two work days to complete. skip_vrt Add to a PR to skip running VRT (but still pass the action)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants