-
Notifications
You must be signed in to change notification settings - Fork 137
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Boilerplate of a migration guide added. WIP
- Loading branch information
1 parent
d6e306f
commit 1ab430b
Showing
1 changed file
with
348 additions
and
0 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,348 @@ | ||
| # Carbon for IBM Products: v2 migration guide for Security components | ||
|
|
||
| This document will review in detail the changes in Carbon for IBM Products v1 to | ||
| v2. Because Carbon for IBM Products v2 uses Carbon v11, which utilizes Sass | ||
| modules, there is a requirement for teams to use the | ||
| [Dart Sass package](https://sass-lang.com/dart-sass) (`sass`), as opposed to | ||
| `node-sass`. This introduces some new sass concepts such as | ||
| [`@use`](https://sass-lang.com/documentation/at-rules/use) vs | ||
| [`@import`](https://sass-lang.com/documentation/at-rules/import) and | ||
| [namespaces](https://sass-lang.com/documentation/at-rules/use#choosing-a-namespace). | ||
| For Carbon v11 migration guidance, see their | ||
| [migration guide](https://github.com/carbon-design-system/carbon/blob/main/docs/migration/v11.md). | ||
|
|
||
| v2 will receive weekly releases occurring every Tuesday morning. | ||
|
|
||
| ## Table of Contents | ||
|
|
||
| - [Migrated components](#migrated-component-changes) | ||
| - [Deprecated components](#deprecated-components-and-their-replacement-mappings) | ||
|
|
||
| ## Migrated component changes | ||
|
|
||
| | Component | Changes | | ||
| | ---------------------------- | ------------------------------------- | | ||
| | BigNumbers (ICA) | View changes [here](#bignumbers) | | ||
| | Decorator | View changes [here](#decorator) | | ||
| | DelimitedList | View changes [here](#delimitedlist) | | ||
| | DescriptionList (TypeLayout) | View changes [here](#descriptionlist) | | ||
| | FilterPanel | View changes [here](#filterpanel) | | ||
| | IconButtonBar | View changes [here](#iconbuttonbar) | | ||
| | Nav | View changes [here](#nav) | | ||
| | ScrollGradient | View changes [here](#scrollgradient) | | ||
| | SearchBar | View changes [here](#searchbar) | | ||
| | StatusIndicator | View changes [here](#statusindicator) | | ||
| | StringFormatter | View changes [here](#stringformatter) | | ||
| | TruncatedList | View changes [here](#truncatedlist) | | ||
|
|
||
| ### BigNumbers | ||
|
|
||
| _Info here_ | ||
|
|
||
| | Old prop | New prop | Change | | ||
| | -------- | -------- | ------ | | ||
| | — | — | — | | ||
|
|
||
| --- | ||
|
|
||
| ### Decorator | ||
|
|
||
| _Info here_ | ||
|
|
||
| | Old prop | New prop | Change | | ||
| | -------- | -------- | ------ | | ||
| | — | — | — | | ||
|
|
||
| --- | ||
|
|
||
| ### DelimitedList | ||
|
|
||
| _Info here_ | ||
|
|
||
| | Old prop | New prop | Change | | ||
| | -------- | -------- | ------ | | ||
| | — | — | — | | ||
|
|
||
| --- | ||
|
|
||
| ### DescriptionList | ||
|
|
||
| _Info here_ | ||
|
|
||
| | Old prop | New prop | Change | | ||
| | -------- | -------- | ------ | | ||
| | — | — | — | | ||
|
|
||
| --- | ||
|
|
||
| ### FilterPanel | ||
|
|
||
| _Info here_ | ||
|
|
||
| | Old prop | New prop | Change | | ||
| | -------- | -------- | ------ | | ||
| | — | — | — | | ||
|
|
||
| --- | ||
|
|
||
| ### IconButtonBar | ||
|
|
||
| _Info here_ | ||
|
|
||
| | Old prop | New prop | Change | | ||
| | -------- | -------- | ------ | | ||
| | — | — | — | | ||
|
|
||
| --- | ||
|
|
||
| ### Nav | ||
|
|
||
| _Info here_ | ||
|
|
||
| | Old prop | New prop | Change | | ||
| | -------- | -------- | ------ | | ||
| | — | — | — | | ||
|
|
||
| --- | ||
|
|
||
| ### ScrollGradient | ||
|
|
||
| _Info here_ | ||
|
|
||
| | Old prop | New prop | Change | | ||
| | -------- | -------- | ------ | | ||
| | — | — | — | | ||
|
|
||
| --- | ||
|
|
||
| ### SearchBar | ||
|
|
||
| _Info here_ | ||
|
|
||
| | Old prop | New prop | Change | | ||
| | -------- | -------- | ------ | | ||
| | — | — | — | | ||
|
|
||
| --- | ||
|
|
||
| ### StatusIndicator | ||
|
|
||
| _Info here_ | ||
|
|
||
| | Old prop | New prop | Change | | ||
| | -------- | -------- | ------ | | ||
| | — | — | — | | ||
|
|
||
| --- | ||
|
|
||
| ### StringFormatter | ||
|
|
||
| _Info here_ | ||
|
|
||
| | Old prop | New prop | Change | | ||
| | -------- | -------- | ------ | | ||
| | — | — | — | | ||
|
|
||
| --- | ||
|
|
||
| ### TruncatedList | ||
|
|
||
| _Info here_ | ||
|
|
||
| | Old prop | New prop | Change | | ||
| | -------- | -------- | ------ | | ||
| | — | — | — | | ||
|
|
||
| --- | ||
|
|
||
| ## Deprecated components and their replacement mappings | ||
|
|
||
| | Component | Replacement | | ||
| | ------------------- | --------------------------------------------- | | ||
| | Card | View replacement [here](#card) | | ||
| | DataDecorator | View replacement [here](#xxx) | | ||
| | DataTablePagination | View replacement [here](#datatablepagination) | | ||
| | ErrorPage | View replacement [here](#xxx) | | ||
| | Header | View replacement [here](#xxx) | | ||
| | Icon | View replacement [here](#icon) | | ||
| | IconButton | View replacement [here](#iconbutton) | | ||
| | Panel | View replacement [here](#panel) | | ||
| | PanelV2 | View replacement [here](#panelv2) | | ||
| | ProfileImage | View replacement [here](#profileimage) | | ||
| | Shell | View replacement [here](#shell) | | ||
| | SummaryCard | View replacement [here](#summarycard) | | ||
| | Tearsheet | View replacement [here](#tearsheet) | | ||
| | TearsheetSmall | View replacement [here](#tearsheetsmall) | | ||
| | Toolbar | View replacement [here](#toolbar) | | ||
| | TrendingCard | View replacement [here](#trendingcard) | | ||
| | Wizard | View replacement [here](#wizard) | | ||
|
|
||
| ### Card | ||
|
|
||
| _Info here_ | ||
|
|
||
| | Old prop | New prop | Change | | ||
| | -------- | -------- | ------ | | ||
| | — | — | — | | ||
|
|
||
| --- | ||
|
|
||
| ### DataDecorator | ||
|
|
||
| _Info here_ | ||
|
|
||
| | Old prop | New prop | Change | | ||
| | -------- | -------- | ------ | | ||
| | — | — | — | | ||
|
|
||
| --- | ||
|
|
||
| ### DataTablePagination | ||
|
|
||
| _Info here_ | ||
|
|
||
| | Old prop | New prop | Change | | ||
| | -------- | -------- | ------ | | ||
| | — | — | — | | ||
|
|
||
| --- | ||
|
|
||
| ### ErrorPage | ||
|
|
||
| _Info here_ | ||
|
|
||
| | Old prop | New prop | Change | | ||
| | -------- | -------- | ------ | | ||
| | — | — | — | | ||
|
|
||
| --- | ||
|
|
||
| ### Header | ||
|
|
||
| _Info here_ | ||
|
|
||
| | Old prop | New prop | Change | | ||
| | -------- | -------- | ------ | | ||
| | — | — | — | | ||
|
|
||
| --- | ||
|
|
||
| ### Icon | ||
|
|
||
| _Info here_ | ||
|
|
||
| | Old prop | New prop | Change | | ||
| | -------- | -------- | ------ | | ||
| | — | — | — | | ||
|
|
||
| --- | ||
|
|
||
| ### IconButton | ||
|
|
||
| _Info here_ | ||
|
|
||
| | Old prop | New prop | Change | | ||
| | -------- | -------- | ------ | | ||
| | — | — | — | | ||
|
|
||
| --- | ||
|
|
||
| ### Panel | ||
|
|
||
| _Info here_ | ||
|
|
||
| | Old prop | New prop | Change | | ||
| | -------- | -------- | ------ | | ||
| | — | — | — | | ||
|
|
||
| --- | ||
|
|
||
| ### PanelV2 | ||
|
|
||
| _Info here_ | ||
|
|
||
| | Old prop | New prop | Change | | ||
| | -------- | -------- | ------ | | ||
| | — | — | — | | ||
|
|
||
| --- | ||
|
|
||
| ### ProfileImage | ||
|
|
||
| _Info here_ | ||
|
|
||
| | Old prop | New prop | Change | | ||
| | -------- | -------- | ------ | | ||
| | — | — | — | | ||
|
|
||
| --- | ||
|
|
||
| ### Shell | ||
|
|
||
| _Info here_ | ||
|
|
||
| | Old prop | New prop | Change | | ||
| | -------- | -------- | ------ | | ||
| | — | — | — | | ||
|
|
||
| --- | ||
|
|
||
| ### SummaryCard | ||
|
|
||
| _Info here_ | ||
|
|
||
| | Old prop | New prop | Change | | ||
| | -------- | -------- | ------ | | ||
| | — | — | — | | ||
|
|
||
| --- | ||
|
|
||
| ### Tearsheet | ||
|
|
||
| _Info here_ | ||
|
|
||
| | Old prop | New prop | Change | | ||
| | -------- | -------- | ------ | | ||
| | — | — | — | | ||
|
|
||
| --- | ||
|
|
||
| ### TearsheetSmall | ||
|
|
||
| _Info here_ | ||
|
|
||
| | Old prop | New prop | Change | | ||
| | -------- | -------- | ------ | | ||
| | — | — | — | | ||
|
|
||
| --- | ||
|
|
||
| ### Toolbar | ||
|
|
||
| _Info here_ | ||
|
|
||
| | Old prop | New prop | Change | | ||
| | -------- | -------- | ------ | | ||
| | — | — | — | | ||
|
|
||
| --- | ||
|
|
||
| ### TrendingCard | ||
|
|
||
| _Info here_ | ||
|
|
||
| | Old prop | New prop | Change | | ||
| | -------- | -------- | ------ | | ||
| | — | — | — | | ||
|
|
||
| --- | ||
|
|
||
| ### Wizard | ||
|
|
||
| _Info here_ | ||
|
|
||
| | Old prop | New prop | Change | | ||
| | -------- | -------- | ------ | | ||
| | — | — | — | | ||
|
|
||
| --- |