Skip to content

Commit 18c7418

Browse files
tw15eganbsonefeld
authored andcommitted
fix(readme): update migration guides to differentiate between old / new (#37)
* fix(readme): update migration guides to differentiate between old / new * docs(migration): update paths
1 parent 7561488 commit 18c7418

File tree

33 files changed

+237
-36
lines changed

33 files changed

+237
-36
lines changed

src/components/accordion/migrate-to-7.x.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,14 @@ For more details on installing and using bluemix-icons, see install and usage gu
1414

1515
### SCSS
1616

17-
The `_accordion.scss` file is now located at __src/components/accordion/_accordion.scss__. You'll need to update any `@import` statements for this file to reflect this change.
17+
The `_accordion.scss` file is now located at `src/components/accordion/_accordion.scss`. You'll need to update any `@import` statements for this file to reflect this change.
1818

19+
**New**:
20+
```scss
21+
@import 'path_to_node_modules/carbon-components/src/components/accordion/accordion';
22+
```
23+
24+
**Old**:
1925
```scss
2026
@import 'path_to_node_modules/@console/bluemix-components/src/components/accordion/accordion';
2127
```

src/components/breadcrumb/migrate-to-7.x.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,14 @@ The `bx--breadcrumb--lg` modifier class has been removed in `7.x` and is no long
44

55
### SCSS
66

7-
The `_breadcrumb.scss` file is now located at __src/components/breadcrumb/_breadcrumb.scss__. You will need to update any `@import` statements for this file to reflect this change.
7+
The `_breadcrumb.scss` file is now located at `src/components/breadcrumb/_breadcrumb.scss`. You will need to update any `@import` statements for this file to reflect this change.
88

9+
**New**:
910
```scss
10-
@import 'path_to_node_modules/@console/bluemix-components/src/components/breadcrumb/breadcrumb';
11+
@import 'path_to_node_modules/carbon-components/src/components/breadcrumb/breadcrumb';
1112
```
1213

13-
14+
**Old**:
15+
```scss
16+
@import 'path_to_node_modules/@console/bluemix-components/src/components/breadcrumb/breadcrumb';
17+
```

src/components/button/migrate-to-7.x.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,13 @@
11
### SCSS
22

3-
The `_button.scss` file is now located at __src/components/button/_button.scss__. You will need to update any `@import` statements for this file to reflect this change.
3+
The `_button.scss` file is now located at `src/components/button/_button.scss`. You will need to update any `@import` statements for this file to reflect this change.
44

5+
**New**:
6+
```scss
7+
@import 'path_to_node_modules/carbon-components/src/components/button/button';
8+
```
9+
10+
**Old**:
511
```scss
612
@import 'path_to_node_modules/@console/bluemix-components/src/components/button/button';
713
```

src/components/card/migrate-to-7.x.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,14 @@ The various card HTML variations of previous versions are now replaced by two si
44

55
### SCSS
66

7-
The `_card.scss` file is now located at __src/components/card/card.scss__. You will need to update any `@import` statements for this file to reflect this change.
7+
The `_card.scss` file is now located at `src/components/card/_card.scss`. You will need to update any `@import` statements for this file to reflect this change.
88

9+
**New**:
10+
```scss
11+
@import 'path_to_node_modules/carbon-components/src/components/card/card';
12+
```
13+
14+
**Old**:
915
```scss
1016
@import 'path_to_node_modules/@console/bluemix-components/src/components/card/card';
1117
```

src/components/checkbox/migrate-to-7.x.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,14 @@ All checkboxes must use SVG icons to ensure browser compatibility.
55

66
### SCSS
77

8-
The `_checkbox.scss` file is now located in __src/components/checkbox__. You'll need to update any `@import` statements for this file to reflect this change.
8+
The `_checkbox.scss` file is now located in `src/components/checkbox/_checkbox.scss`. You'll need to update any `@import` statements for this file to reflect this change.
99

10+
**New**:
11+
```scss
12+
@import 'path_to_node_modules/carbon-components/src/components/checkbox/checkbox';
13+
```
14+
15+
**Old**:
1016
```scss
1117
@import 'path_to_node_modules/@console/bluemix-components/src/components/checkbox/checkbox';
1218
```

src/components/code-snippet/migrate-to-7.x.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,14 @@ No changes.
44

55
### SCSS
66

7-
The `_code-snippet.scss` file is now located at __src/components/code-snippet/_code-snippet.scss__. You will need to update any `@import` statements for this file to reflect this change.
7+
The `_code-snippet.scss` file is now located at `src/components/code-snippet/_code-snippet.scss`. You will need to update any `@import` statements for this file to reflect this change.
88

9+
**New**:
10+
```scss
11+
@import 'path_to_node_modules/carbon-components/src/components/code-snippet/code-snippet';
12+
```
13+
14+
**Old**:
915
```scss
1016
@import 'path_to_node_modules/@console/bluemix-components/src/components/code-snippet/code-snippet';
1117
```

src/components/content-switcher/migrate-to-7.x.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,14 @@ Use the smaller, simpler HTML for content-switcher from now on:
1313

1414
### SCSS
1515

16-
The `_content-switcher.scss` file is now located at __src/components/content-switcher/_content-switcher.scss__. You will need to update any `@import` statements for this file to reflect this change.
16+
The `_content-switcher.scss` file is now located at `src/components/content-switcher/_content-switcher.scss`. You will need to update any `@import` statements for this file to reflect this change.
1717

18+
**New**:
19+
```scss
20+
@import 'path_to_node_modules/carbon-components/src/components/content-switcher/content-switcher';
21+
```
22+
23+
**Old**:
1824
```scss
1925
@import 'path_to_node_modules/@console/bluemix-components/src/components/content-switcher/content-switcher';
2026
```

src/components/data-table/migrate-to-7.x.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,14 @@ Main changes to HTML are for changes to Overflow Menu, Checkbox and icons that a
44

55
### SCSS
66

7-
The `_data-table.scss` file is now located at __src/components/data-table/_data-table.scss__. You will need to update any `@import` statements for this file to reflect this change.
7+
The `_data-table.scss` file is now located at `src/components/data-table/_data-table.scss`. You will need to update any `@import` statements for this file to reflect this change.
88

9+
**New**:
10+
```scss
11+
@import 'path_to_node_modules/carbon-components/src/components/data-table/data-table';
12+
```
13+
14+
**Old**:
915
```scss
1016
@import 'path_to_node_modules/@console/bluemix-components/src/components/data-table/data-table';
1117
```

src/components/detail-page-header/migrate-to-7.x.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,14 @@ A lot of classes have been removed, see SCSS for more details.
55

66
### SCSS
77

8-
The `_detail-page-header.scss` file is now located at __src/components/detail-page-header/_detail-page-header.scss__. You will need to update any `@import` statements for this file to reflect this change.
8+
The `_detail-page-header.scss` file is now located at `src/components/detail-page-header/_detail-page-header.scss`. You will need to update any `@import` statements for this file to reflect this change.
99

10+
**New**:
11+
```scss
12+
@import 'path_to_node_modules/carbon-components/src/components/detail-page-header/detail-page-header';
13+
```
14+
15+
**Old**:
1016
```scss
1117
@import 'path_to_node_modules/@console/bluemix-components/src/components/detail-page-header/detail-page-header';
1218
```

src/components/dropdown/migrate-to-7.x.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,18 @@ No structural changes. However, class names have been changed.
44

55
### SCSS
66

7-
The `_dropdown.scss` file is now located at __src/components/.dropdown/dropdown.scss__. You will need to update any `@import` statements for this file to reflect this change.
7+
The `_dropdown.scss` file is now located at `src/components/dropdown/_dropdown.scss`. You will need to update any `@import` statements for this file to reflect this change.
88

9+
**New**:
10+
```scss
11+
@import 'path_to_node_modules/carbon-components/src/components/dropdown/dropdown';
12+
```
13+
14+
**Old**:
915
```scss
1016
@import 'path_to_node_modules/@console/bluemix-components/src/components/dropdown/dropdown';
1117
```
18+
1219
Quite a few class names have changed. See table below.
1320

1421
| Old Class | New Class |

src/components/file-uploader/migrate-to-7.x.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,14 @@ There's also a new `.bx--file-container` element that is used to display filenam
88

99
### SCSS
1010

11-
The `_file-uploader.scss` file is now located at __src/components/file-uploader/_file-uploader.scss__. You will need to update any `@import` statements for this file to reflect this change.
11+
The `_file-uploader.scss` file is now located at `src/components/file-uploader/_file-uploader.scss`. You will need to update any `@import` statements for this file to reflect this change.
1212

13+
**New**:
14+
```scss
15+
@import 'path_to_node_modules/carbon-components/src/components/file-uploader/file-uploader';
16+
```
17+
18+
**Old**:
1319
```scss
1420
@import 'path_to_node_modules/@console/bluemix-components/src/components/file-uploader/file-uploader';
1521
```

src/components/footer/migrate-to-7.x.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,14 @@ Now there's only one variant of HTML for Footer that more closely resembles what
55

66
### SCSS
77

8-
The `_footer.scss` file is now located at __src/components/footer/_footer.scss__. You will need to update any `@import` statements for this file to reflect this change.
8+
The `_footer.scss` file is now located at `src/components/footer/_footer.scss`. You will need to update any `@import` statements for this file to reflect this change.
99

10+
**New**:
11+
```scss
12+
@import 'path_to_node_modules/carbon-components/src/components/footer/footer';
13+
```
14+
15+
**Old**:
1016
```scss
1117
@import 'path_to_node_modules/@console/bluemix-components/src/components/footer/footer';
1218
```

src/components/form/migrate-to-7.x.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,18 @@ For full usage guidelines of the new HTML see the component README file.
1414

1515
### SCSS
1616

17-
The `_form.scss` file is now located at __src/components/form/form.scss__. You will need to update any `@import` statements for this file to reflect this change.
17+
The `_form.scss` file is now located at `src/components/form/_form.scss`. You will need to update any `@import` statements for this file to reflect this change.
1818

19+
**New**:
20+
```scss
21+
@import 'path_to_node_modules/carbon-components/src/components/form/form';
22+
```
23+
24+
**Old**:
1925
```scss
2026
@import 'path_to_node_modules/@console/bluemix-components/src/components/form/form';
2127
```
28+
2229
Quite a few class names have changed. See table below.
2330

2431
| Old Class | New Class | Note |

src/components/interior-left-nav/migrate-to-7.x.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,14 @@ All data-attributes containing the words `inline-left-nav` have been changed to
1515

1616
### SCSS
1717

18-
The `_interior-left-nav.scss` file is now located at __src/components/interior-left-nav/_interior-left-nav.scss__. You will need to update any `@import` statements for this file to reflect this change.
18+
The `_interior-left-nav.scss` file is now located at `src/components/interior-left-nav/_interior-left-nav.scss`. You will need to update any `@import` statements for this file to reflect this change.
1919

20+
**New**:
21+
```scss
22+
@import 'path_to_node_modules/carbon-components/src/components/interior-left-nav/interior-left-nav';
23+
```
24+
25+
**Old**:
2026
```scss
2127
@import 'path_to_node_modules/@console/bluemix-components/src/components/interior-left-nav/interior-left-nav';
2228
```

src/components/link/migrate-to-7.x.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,14 @@ No changes.
44

55
### SCSS
66

7-
The `_link.scss` file is now located at __src/components/link/link.scss__. You will need to update any `@import` statements for this file to reflect this change.
7+
The `_link.scss` file is now located at `src/components/link/_link.scss`. You will need to update any `@import` statements for this file to reflect this change.
88

9+
**New**:
10+
```scss
11+
@import 'path_to_node_modules/carbon-components/src/components/link/link';
12+
```
13+
14+
**Old**:
915
```scss
1016
@import 'path_to_node_modules/@console/bluemix-components/src/components/link/link';
1117
```

src/components/list/migrate-to-7.x.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,14 @@ No changes.
44

55
### SCSS
66

7-
The `_list.scss` file is now located at __src/components/list/list.scss__. You will need to update any `@import` statements for this file to reflect this change.
7+
The `_list.scss` file is now located at `src/components/list/_list.scss`. You will need to update any `@import` statements for this file to reflect this change.
88

9+
**New**:
10+
```scss
11+
@import 'path_to_node_modules/carbon-components/src/components/list/list';
12+
```
13+
14+
**Old**:
915
```scss
1016
@import 'path_to_node_modules/@console/bluemix-components/src/components/list/list';
1117
```

src/components/loading/migrate-to-7.x.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,14 @@ No class names have changed.
55

66
### SCSS
77

8-
The `_loading.scss` file is now located at __src/components/loading/loading.scss__. You will need to update any `@import` statements for this file to reflect this change.
8+
The `_loading.scss` file is now located at `src/components/loading/_loading.scss`. You will need to update any `@import` statements for this file to reflect this change.
99

10+
**New**:
11+
```scss
12+
@import 'path_to_node_modules/carbon-components/src/components/loading/loading';
13+
```
14+
15+
**Old**:
1016
```scss
1117
@import 'path_to_node_modules/@console/bluemix-components/src/components/loading/loading';
1218
```

src/components/modal/migrate-to-7.x.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,14 @@ With that said, it will be best to copy and paste the new HTML for Modal to capt
1717

1818
### SCSS
1919

20-
The `_modal.scss` file is now located at __src/components/modal/_modal.scss__. You will need to update any `@import` statements for this file to reflect this change.
20+
The `_modal.scss` file is now located at `src/components/modal/_modal.scss`. You will need to update any `@import` statements for this file to reflect this change.
2121

22+
**New**:
23+
```scss
24+
@import 'path_to_node_modules/carbon-components/src/components/modal/modal';
25+
```
26+
27+
**Old**:
2228
```scss
2329
@import 'path_to_node_modules/@console/bluemix-components/src/components/modal/modal';
2430
```

src/components/module/migrate-to-7.x.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,14 @@ For more examples see the `module.html` file.
2222

2323
### SCSS
2424

25-
The `_module.scss` file is now located at __src/components/modules/module.scss__. You'll need to update any `@import` statements for this file to reflect this change.
25+
The `_module.scss` file is now located at `src/components/modules/_module.scss`. You'll need to update any `@import` statements for this file to reflect this change.
2626

27+
**New**:
28+
```scss
29+
@import 'path_to_node_modules/carbon-components/src/components/module/module';
30+
```
31+
32+
**Old**:
2733
```scss
2834
@import 'path_to_node_modules/@console/bluemix-components/src/components/module/module';
2935
```

src/components/notification/migrate-to-7.x.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,19 @@ The majority of the class names have changed along with some structural changes.
88

99
### SCSS
1010

11-
The `_notification.scss` file is now located at __src/components/notification/notification.scss__. You will need to update any `@import` statements for this file to reflect this change.
11+
The `_notification.scss` is now split in to two files. They are located at `src/components/notification/_inline-notification.scss` and `src/components/notification/_toast-notification.scss`. You will need to update any `@import` statements for this file to reflect this change.
1212

13+
**New**:
14+
```scss
15+
@import 'path_to_node_modules/carbon-components/src/components/notification/_toast-notification.scss';
16+
@import 'path_to_node_modules/carbon-components/src/components/notification/_inline-notification.scss';
17+
```
18+
19+
**Old**:
1320
```scss
1421
@import 'path_to_node_modules/@console/bluemix-components/src/components/notification/notification';
1522
```
23+
1624
Quite a few class names have changed. See table below.
1725

1826
| Old Class | New Class: Inline | New Class: Toast |

src/components/number-input/migrate-to-7.x.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,14 @@ In general, it will be easiest to simply copy and paste the new HTML to replace
77

88
### SCSS
99

10-
The `_number-input.scss` file is now located at __src/components/number-input/_number-input.scss__. You will need to update any `@import` statements for this file to reflect this change.
10+
The `_number-input.scss` file is now located at `src/components/number-input/_number-input.scss`. You will need to update any `@import` statements for this file to reflect this change.
1111

12+
**New**:
13+
```scss
14+
@import 'path_to_node_modules/carbon-components/src/components/number-input/number-input';
15+
```
16+
17+
**Old**:
1218
```scss
1319
@import 'path_to_node_modules/@console/bluemix-components/src/components/number-input/number-input';
1420
```

src/components/overflow-menu/migrate-to-7.x.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,16 @@ Structure stays the same but some class names have been changed. See below.
44

55
### SCSS
66

7-
The `_overflow-menu.scss` file is now located at `__src/components/overflow-menu/_overflow-menu.scss.` You will need to update any `@import` statements for this file to reflect this change.
7+
The `_overflow-menu.scss` file is now located at `src/components/overflow-menu/_overflow-menu.scss`. You will need to update any `@import` statements for this file to reflect this change.
88

9+
**New**:
910
```scss
10-
@import 'path_to_node_modules/@console/bluemix-components/src/components/tooltip/tooltip;
11+
@import 'path_to_node_modules/carbon-components/src/components/overflow-menu/overflow-menu';
12+
```
13+
14+
**Old**:
15+
```scss
16+
@import 'path_to_node_modules/@console/bluemix-components/src/components/overflow-menu/overflow-menu;
1117
```
1218
1319
`.bx--overflow-menu__options` is now `.bx--overflow-menu-options`

src/components/pagination/migrate-to-7.x.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,14 @@ No changes.
44

55
### SCSS
66

7-
The `_pagination.scss` file is now located at __src/components/pagination/_pagination.scss__. You will need to update any `@import` statements for this file to reflect this change.
7+
The `_pagination.scss` file is now located at `src/components/pagination/_pagination.scss`. You will need to update any `@import` statements for this file to reflect this change.
88

9+
**New**:
10+
```scss
11+
@import 'path_to_node_modules/carbon-components/src/components/pagination/pagination';
12+
```
13+
14+
**Old**:
915
```scss
1016
@import 'path_to_node_modules/@console/bluemix-components/src/components/pagination/pagination';
1117
```

0 commit comments

Comments
 (0)