-
Notifications
You must be signed in to change notification settings - Fork 794
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(deprecations): add new page including upcoming deprecation detai…
…ls (#4301) * docs(deprecations): add new page including upcoming deprecation details * chore: update references to v10 and deprecated packages * docs(deprecation): add v10 elements packages and carbon-icons
- Loading branch information
1 parent
ddda03e
commit ecabbf9
Showing
18 changed files
with
155 additions
and
45 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,128 @@ | ||
--- | ||
title: Deprecations | ||
description: | ||
Stay informed on deprecated packages and assets in the Carbon Design System | ||
with updates, migration guides, and resources for seamless transitions to the | ||
latest supported versions. | ||
--- | ||
|
||
<PageDescription> | ||
|
||
Stay informed on deprecated packages and assets in the Carbon Design System with | ||
updates, migration guides, and resources for seamless transitions to the latest | ||
supported versions. | ||
|
||
</PageDescription> | ||
|
||
<AnchorLinks> | ||
|
||
<AnchorLink>carbon-components</AnchorLink> | ||
<AnchorLink>carbon-components-react</AnchorLink> | ||
<AnchorLink>v10 Elements packages</AnchorLink> | ||
<AnchorLink>carbon-icons</AnchorLink> | ||
|
||
</AnchorLinks> | ||
|
||
## `carbon-components` | ||
|
||
`carbon-components` reached it's end of support on September 30, 2024. This | ||
package will no longer receive updates. | ||
|
||
### What to use instead | ||
|
||
`carbon-components` is replaced by `@carbon/styles`, but most projects don't | ||
need to install `@carbon/styles` directly. | ||
|
||
If you're using `@carbon/react` or `@carbon/web-components`, you do not need to | ||
install `@carbon/styles`. All `@carbon/styles` assets are already available to | ||
you through those framework-specific packages. | ||
|
||
Library authors should use `@carbon/styles` if they do not already rely on a | ||
framework-variant package such as `@carbon/react`. | ||
|
||
### Migration | ||
|
||
For those using `[email protected]`, the | ||
[v11 migration guide](/migrating/guide/develop/) has all the details of how to | ||
update. | ||
|
||
For those using `[email protected]`, these versions are already a direct | ||
re-export of `@carbon/styles`. See the above section on what to use instead. | ||
|
||
For questions regarding this deprecation or how to migrate, | ||
[contact us](/help/contact-us/). | ||
|
||
## `carbon-components-react` | ||
|
||
`carbon-components-react` reached it's end of support on September 30, 2024. | ||
This package will no longer receive updates. | ||
|
||
### What to use instead | ||
|
||
`carbon-components-react` is replaced by `@carbon/react`. | ||
|
||
### Migration | ||
|
||
For those using `[email protected]`, the | ||
[v11 migration guide](/migrating/guide/develop/) has all the details of how to | ||
update. | ||
|
||
For those using `[email protected]`, these versions are already a | ||
direct re-export of `@carbon/react`. After installing `@carbon/react`, you can | ||
replace all imports and usages of `carbon-components-react` with | ||
`@carbon/react`. This should be an in-place update with no other changes | ||
required. | ||
|
||
For questions regarding this deprecation or how to migrate, | ||
[contact us](/help/contact-us/). | ||
|
||
## v10 Elements packages | ||
|
||
All v10 assets reached end of support on September 30, 2024, including v10.x | ||
ranges of elements packages. This includes: | ||
|
||
- '@carbon/colors@10.x' | ||
- '@carbon/elements@10.x' | ||
- '@carbon/grid@10.x' | ||
- '@carbon/layout@10.x' | ||
- '@carbon/motion@10.x' | ||
- '@carbon/themes@10.x' | ||
- '@carbon/type@10.x' | ||
|
||
### What to use instead | ||
|
||
The v11.x ranges of these packages should be used instead. | ||
|
||
### Migration | ||
|
||
The [v11 migration guide](/migrating/guide/develop/) has all the details of how | ||
to update. | ||
|
||
For questions regarding these deprecations or how to migrate, | ||
[contact us](/help/contact-us/). | ||
|
||
## `carbon-icons` | ||
|
||
The `carbon-icons` package reached end of support on March 31, 2022 when v11 was | ||
released. This package will no longer receive updates. | ||
|
||
### What to use instead | ||
|
||
To use icons from the Carbon Design System, you should install the appropriate | ||
library to use with your framework: | ||
|
||
| Package | Framework | Link | | ||
| :---------------------- | :----------------- | :------------------------------------------------------ | | ||
| `@carbon/icons-react` | React | [Link](https://npmjs.com/package/@carbon/icons-react) | | ||
| `@carbon/icons-angular` | Angular | [Link](https://npmjs.com/package/@carbon/icons-angular) | | ||
| `@carbon/icons-vue` | Vue | [Link](https://npmjs.com/package/@carbon/icons-vue) | | ||
| `carbon-icons-svelte` | Svelte | [Link](https://npmjs.com/package/carbon-icons-svelte) | | ||
| `@carbon/icons` | Vanilla JavaScript | [Link](https://npmjs.com/package/@carbon/icons) | | ||
|
||
### Migration | ||
|
||
The [v11 migration guide](/migrating/guide/develop/) has all the details of how | ||
to update. | ||
|
||
For questions regarding these deprecations or how to migrate, | ||
[contact us](/help/contact-us/). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters