carbon-icons icon indicating copy to clipboard operation
carbon-icons copied to clipboard

Create migration docs and deprecate package

Open joshblack opened this issue 5 years ago • 2 comments

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?

joshblack avatar Jan 16 '19 16:01 joshblack

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

tay1orjones avatar May 28 '20 16:05 tay1orjones

@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!

joshblack avatar May 29 '20 20:05 joshblack