Skip to content

Update design-system to wcag version #3131

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 2 commits into from
Aug 22, 2023

Conversation

ilee-salesforce
Copy link
Contributor

Salesforce teams are getting TDs to update all UI in MANAGED PACKAGE to have 3:1 color contrast for functional UI elements and 4.5:1 color contrast for text. Example TD (https://gus.lightning.force.com/lightning/r/ADM_Team_Dependency__c/a0nEE000000HnxBYAS/view)

For those apps that use @salesforce-ux/design-system, the newly updated version with wcag compliance is available with 2.21.3-wcag (https://www.npmjs.com/package/@salesforce-ux/design-system/v/2.21.3-wcag)

I am simply updating the version to the wcag compliant one.

@welcome
Copy link

welcome bot commented Aug 18, 2023

Thanks for opening this pull request! 💯

This is a community-driven project, and we can't do it without your participation. Please check out our contributing guidelines and review the Contributor Checklist if you haven't already, to make sure everything is squared away. CircleCI will take about 10 minutes to run through the same items that are on the Contributor checklist with a pass/fail check below. Please fix any issues that cause CircleCI to fail or ask for clarification--we try, but sometimes the errors can be unclear.
A maintainer will try to respond within 7 days. If you haven’t heard anything by then, please bump this thread. To ensure codebase quality, large code line changes may take more than 2 weeks to review, but may take longer depending on the number of pull requests in the queue. Feel free to ask for a status update at any time--you won't be bothering anyone.
Once feedback has been given, please reply to the feedback giver once the feedback on been addressed, so that they can continue the review.
If you need a release while you are waiting for a code review, you can publish a built tag to your own fork. See directions in the release README.

@salesforce-cla
Copy link

Thanks for the contribution! It looks like @ilee-salesforce is an internal user so signing the CLA is not required. However, we need to confirm this.

@ilee-salesforce
Copy link
Contributor Author

@interactivellama
Hi Stephen
Can you take a look at this PR and let me know if this makes sense?

@interactivellama
Copy link
Contributor

interactivellama commented Aug 21, 2023

Thank you for the PR.

My understanding from the SLDS maintainers is that this is a temporary suffix until color contrast goes GA. Are you able to use the suffix version until the color changes go GA?

@ilee-salesforce
Copy link
Contributor Author

@interactivellama
https://salesforce-internal.slack.com/archives/C04A056KE82/p1690224533494079

I got the information from this thread. Looks like it was suggested to use the -wcag version.

@@ -1,6 +1,6 @@
{
"name": "design-system-react",
"version": "0.10.57",
Copy link
Contributor

Choose a reason for hiding this comment

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

Please remove this suffix. Please just increment the bugfix version.

@@ -130,7 +130,7 @@
"@babel/polyfill": "^7.12.1",
"@babel/preset-env": "^7.14.2",
"@babel/preset-react": "^7.12.7",
"@salesforce-ux/design-system": "^2.20.1",
Copy link
Contributor

Choose a reason for hiding this comment

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

Have you check to see if anything is broken with the color contrast update by running the storybook?

@interactivellama
Copy link
Contributor

@ilee-salesforce It looks like we don't have a near term date for the color contrast to move into the non-suffixed version, so we can move forward with this. Please pull down storybook and give a general review of components.

@interactivellama
Copy link
Contributor

Oh, also, please sign the contributor CLA

@ilee-salesforce
Copy link
Contributor Author

@interactivellama I signed that CLA thing about three times already and it doesn't seem to work for some reason

@interactivellama
Copy link
Contributor

@interactivellama
Copy link
Contributor

Nevermind, it's the CI service that failed.

@ilee-salesforce
Copy link
Contributor Author

@interactivellama Looks like all the checks are good. I am going over the storybook one last time to make sure nothing is broken.

@ilee-salesforce
Copy link
Contributor Author

@interactivellama I went over all of the components in the storybook with the new SLDS version and all of them seem to work without any error.

@interactivellama interactivellama merged commit af19308 into salesforce:master Aug 22, 2023
@welcome
Copy link

welcome bot commented Aug 22, 2023

Congrats on merging your first pull request to Design System React! 🎉
If you have a moment, please fill out this five question survey, we would appreciate it.
On behalf of Salesforce's customers, partners, product specialists and employees, we would like offer sincere thanks and appreciation for helping make our user experience better. We look forward to working with you more in the future.
This definitely calls for a high five! Alt High Five

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants