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

Update vf-focus mixin to properly support theming #5307

Merged
merged 7 commits into from
Sep 3, 2024

Conversation

pastelcyborg
Copy link
Contributor

@pastelcyborg pastelcyborg commented Aug 16, 2024

Please note that this PR involves changing the params to vf-focus, so it could be considered a breaking change. However, I did a search for all uses of vf-focus across our Org and there are only a few sites using this mixin, all of them with the default params, so there should be no breakages there. I can't say the same for anyone using this mixin externally, of course.

Done

  • Updated vf-focus mixin to support light and dark color params for proper theme usage
  • Removed unused Sass focus color variables
  • Drive-by: Fixed minor typos on examples

Fixes WD-13363

QA

Check if PR is ready for release

If this PR contains Vanilla SCSS code changes, it should contain the following changes to make sure it's ready for the release:

  • PR should have one of the following labels to automatically categorise it in release notes:
    • Feature 🎁, Breaking Change 💣, Bug 🐛, Documentation 📝, Maintenance 🔨.
  • Vanilla version in package.json should be updated relative to the most recent release, following semver convention:
    • if CSS class names are not changed it can be bugfix release (x.x.X)
    • if CSS class names are changed/added/removed it should be minor version (x.X.0)
    • see the wiki for more details
  • Any changes to component class names (new patterns, variants, removed or added features) should be listed on the what's new page.

@webteam-app
Copy link

@pastelcyborg pastelcyborg added Review: QA needed Review: Code needed Feature 🎁 New feature or request Breaking change 💣 Review: Percy needed This PR needs a review of Percy for visual regressions labels Aug 16, 2024
@pastelcyborg pastelcyborg marked this pull request as ready for review August 16, 2024 20:26
@jmuzina
Copy link
Member

jmuzina commented Aug 16, 2024

All visual differences are just a typo fix for contextual menu examples

@jmuzina jmuzina added Review: Percy +1 and removed Review: Percy needed This PR needs a review of Percy for visual regressions labels Aug 16, 2024
Copy link
Member

@jmuzina jmuzina left a comment

Choose a reason for hiding this comment

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

This looks good, and I'm glad there's no usages of this that would be breaking in our org.

I'm still hesitant to release a breaking change in a minor version. Maybe we should put this one on hold until v5 unless there is something immediately requiring this to be merged?

@pastelcyborg
Copy link
Contributor Author

This looks good, and I'm glad there's no usages of this that would be breaking in our org.

I'm still hesitant to release a breaking change in a minor version. Maybe we should put this one on hold until v5 unless there is something immediately requiring this to be merged?

I feel similarly. I'll leave this open until we can discuss with @bartaz but generally I concur.

scss/_global_functions.scss Outdated Show resolved Hide resolved
@pastelcyborg pastelcyborg added Review: QA needed Review: Code needed Review: Percy needed This PR needs a review of Percy for visual regressions and removed Review: Percy +1 labels Sep 2, 2024
@pastelcyborg pastelcyborg removed Question ❓ Further information is requested Breaking change 💣 labels Sep 3, 2024
@pastelcyborg
Copy link
Contributor Author

Removed the "Breaking Change" label, as I've altered my approach following the advice of @bartaz to preserve and deprecate the existing vf_focus mixin.

@pastelcyborg pastelcyborg merged commit f96fdbd into canonical:main Sep 3, 2024
10 checks passed
@pastelcyborg pastelcyborg deleted the vf-focus-rewrite branch September 3, 2024 18:57
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.

4 participants