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

Create migration docs and deprecate package #95

Open
joshblack opened this issue Jan 16, 2019 · 2 comments
Open

Create migration docs and deprecate package #95

joshblack opened this issue Jan 16, 2019 · 2 comments

Comments

@joshblack
Copy link
Contributor

joshblack commented Jan 16, 2019

For our v10 release, we'll need to create a migration guide for @carbon/icons and officially deprecate this package.

Should we also include an FAQ for handling common questions for teams using this package?

@tay1orjones
Copy link
Member

Is the intent to follow a similar deprecation strategy that security has implemented by modifying <Icon/> to accept icons from @carbon/icons-react instead of this library?

https://github.com/carbon-design-system/ibm-security/blob/dev/src/components/Icon/migrate-to-2.x.md

@joshblack
Copy link
Contributor Author

@tay1orjones I think the hope will be to remove the usage of <Icon /> in preference of using the dedicated icons from the library.

I think there may be a use-case for us exporting the underlying <Icon /> component from the icons package itself, perhaps renamed to SVG, but the existing component will be removed.

Reference for the underlying Icon component from the new work: https://github.com/carbon-design-system/carbon/blob/master/packages/icon-build-helpers/src/builders/react/components/Icon.js

Let me know if you have any questions!

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

No branches or pull requests

2 participants