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

[ARGG-812]: Remove svg imports and icon functions #3048

Merged
merged 2 commits into from
Oct 26, 2023

Conversation

olliecurtis
Copy link
Member

As part of improving build times and moving away from importing svgs via Sass, we update mixins to the following:

  • Remove imports from bpk-svgs
  • Remove the bpk-icon mixin as we no longer support this and recommend people use svgs via the bpk-component-icon in JS

To be used in the release notes:

Migration guide

If previously you were using the following for selecting icons.

.selector {
   @include bpk-icon(flight, $bpk-color-sky-gray-tint-02, large);
}

You will now need to do the following in JS: https://github.com/Skyscanner/backpack/tree/main/packages/bpk-component-icon#basic-usage

Remember to include the following changes:

  • README.md (If you have created a new component)
  • Component README.md
  • Tests
  • Storybook examples created/updated
  • For breaking changes or deprecating components/properties, migration guides added to the description of the PR. If the guide has large changes, consider creating a new Markdown page inside the component's docs folder and link it here

@olliecurtis olliecurtis added DON'T MERGE major Breaking change labels Oct 25, 2023
@github-actions
Copy link

Visit https://backpack.github.io/storybook-prs/3048 to see this build running in a browser.

Copy link
Contributor

@xalechez xalechez left a comment

Choose a reason for hiding this comment

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

LGTM
Let's wait a while if anyone else wants to review this one and merge/release it

@github-actions
Copy link

Visit https://backpack.github.io/storybook-prs/3048 to see this build running in a browser.

@olliecurtis olliecurtis force-pushed the ARGG-812-remove-svg-imports-from-sass branch from 7fadf36 to 5dadf11 Compare October 26, 2023 13:15
@github-actions
Copy link

Visit https://backpack.github.io/storybook-prs/3048 to see this build running in a browser.

@olliecurtis olliecurtis merged commit 0f6aeb2 into main Oct 26, 2023
7 checks passed
@olliecurtis olliecurtis deleted the ARGG-812-remove-svg-imports-from-sass branch October 26, 2023 13:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
major Breaking change
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants