Skip to content
This repository has been archived by the owner on Oct 19, 2021. It is now read-only.

Commit

Permalink
docs(migration): misc updates (#2105)
Browse files Browse the repository at this point in the history 
* docs(migration): misc updates

Refs #2100.

* docs(components): migration guides to more components
  • Loading branch information
@asudoh @alisonjoseph
asudoh authored and alisonjoseph committed Mar 28, 2019
1 parent bd50e18 commit b2fa89f
Show file tree
Hide file tree
Showing 10 changed files with 48 additions and 17 deletions.
8 changes: 4 additions & 4 deletions docs/migration/migrate-to-7.x.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ Anything in this document is subject to change up until v10 is released._
| `CopyButton` | No breaking changes |
| `DangerButton` | No breaking changes |
| `DataTable` | [Migrate](../../src/components/DataTable/migrate-to-7.x.md) |
| `DatePicker` | No breaking changes |
| `DatePicker` | [Migrate](../../src/components/DatePicker/migrate-to-7.x.md) |
| `DatePickerInput` | No breaking changes |
| `Dropdown` | Existing import remapped to `DropdownV2` |
| `DropdownItem` | No breaking changes |
Expand All @@ -64,7 +64,7 @@ Anything in this document is subject to change up until v10 is released._
| `Notification` | Deprecated, use `InlineNotification` or `ToastNotification` instead |
| `NumberInput` | [Migrate](../../src/components/NumberInput/migrate-to-7.x.md) |
| `OverflowMenu` | [Migrate](../../src/components/OverflowMenu/migrate-to-7.x.md) |
| `OverflowMenuItem` | No breaking changes |
| `OverflowMenuItem` | [Migrate](../../src/components/OverflowMenuItem/migrate-to-7.x.md) |
| `Pagination` | Export now points to `PaginationV2` |
| `PaginationV2` | Renamed to `Pagination` |
| `PrimaryButton` | No breaking changes |
Expand All @@ -81,7 +81,7 @@ Anything in this document is subject to change up until v10 is released._
| `SelectItemGroup` | No breaking changes |
| `SkeletonPlaceholder` | No breaking changes |
| `SkeletonText` | No breaking changes |
| `Slider` | No breaking changes |
| `Slider` | [Migrate](../../src/components/Slider/migrate-to-7.x.md) |
| `StructuredList` | No breaking changes |
| `Switch` | No breaking changes |
| `Tab` | No breaking changes |
Expand All @@ -94,7 +94,7 @@ Anything in this document is subject to change up until v10 is released._
| `TableRow` | Export now points to `DataTable.TableRow` |
| `TableRowExpanded` | Removed |
| `Tabs` | No breaking changes |
| `Tag` | No breaking changes |
| `Tag` | [Migrate](../../src/components/Tag/migrate-to-7.x.md) |
| `TextArea` | No breaking changes |
| `TextInput` | No breaking changes |
| `Tile` | No breaking changes |
Expand Down
2 changes: 1 addition & 1 deletion src/components/DatePicker/DatePicker.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -257,7 +257,7 @@ export default class DatePicker extends Component {
if (typeof appendTo === 'string' && !breakingChangesX) {
warning(
false,
`The DatePicker appendTo prop will be deprecated in Carbon X.
`CSS selector (string) for the DatePicker appendTo prop will be deprecated in Carbon X.
- If you were using appendTo for styling, consider using a className.
- If you were using appendTo for attaching to a specific DOM node, consider a React portal.`
);
Expand Down
7 changes: 7 additions & 0 deletions src/components/DatePicker/migrate-to-7.x.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Props

`<DatePicker>`

| Prop | v9 | v10 |
| ---------- | ------------------------------------ | ----------------------- |
| `appendTo` | Accepts a CSS selector or a DOM node | Accepts a DOM node only |
11 changes: 6 additions & 5 deletions src/components/OverflowMenu/migrate-to-7.x.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,12 @@

`<OverflowMenu>`

| v9 | v10 |
| ----------------------------------------- | -------------------------------------------------------------------------------- |
| `floatingMenu` | Removed - `<OverflowMenu>` always works as a floating menu |
| `icon`, icon name from `carbon-icons` | `renderIcon`, which takes a React component, e.g. one from `@carbon/icons-react` |
| `iconName`, icon data from `carbon-icons` | `renderIcon`, which takes a React component, e.g. one from `@carbon/icons-react` |
| v9 | v10 |
| ---------------------------------------------- | -------------------------------------------------------------------------------- |
| `floatingMenu` | Removed - `<OverflowMenu>` always works as a floating menu |
| `icon`, icon name from `carbon-icons` | `renderIcon`, which takes a React component, e.g. one from `@carbon/icons-react` |
| `iconName`, icon data from `carbon-icons` | `renderIcon`, which takes a React component, e.g. one from `@carbon/icons-react` |
| `ref` grabs the React class instance reference | `ref` grabs the trigger button |

## `v10` example

Expand Down
3 changes: 0 additions & 3 deletions src/components/OverflowMenuItem/migrate-to-10.x.md
View file

This file was deleted.

3 changes: 3 additions & 0 deletions src/components/OverflowMenuItem/migrate-to-7.x.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Props

`floatingMenu` prop that is set from `<OverflowMenu>` has been gone, and overflow menu always works as a floating menu.
6 changes: 6 additions & 0 deletions src/components/RadioButton/migrate-to-7.x.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,9 @@
| ------------------------------------------- | ---------------------------------------- | ------------------- |
| `ref` | Grabs the React class instance reference | Grabs the `<input>` |
| `top`/`bottom` for `labelPosition` property | | Removed |

# CSS

`<RadioButtonSkeleton>`

No longer adds `radioButtonWrapper` class to the top-level element. Please use `bx--radio-button-wrapper` for style overrides.
7 changes: 7 additions & 0 deletions src/components/Slider/migrate-to-7.x.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Props

`<Slider>`

| Prop | v9 | v10 |
| ---------- | -------------------------------------------------------- | -------------------------- |
| `onChange` | Fires on `value` prop change in addition to user gesture | Fires only on user gesture |
9 changes: 9 additions & 0 deletions src/components/Tag/migrate-to-7.x.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Props

`<Tag>`

See [our website](https://www.carbondesignsystem.com/components/tag/code) for details.

| Prop | v9 | v10 |
| ------ | --------------------------------- | ------------------------------ |
| `type` | Accepts `beta`, `community`, etc. | Accepts `red`, `magenta`, etc. |
9 changes: 5 additions & 4 deletions src/components/Tooltip/migrate-to-7.x.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,11 @@

`<Tooltip>`

| v9 | v10 |
| ----------------------------------------- | -------------------------------------------------------------------------------- |
| `icon`, icon name from `carbon-icons` | `renderIcon`, which takes a React component, e.g. one from `@carbon/icons-react` |
| `iconName`, icon data from `carbon-icons` | `renderIcon`, which takes a React component, e.g. one from `@carbon/icons-react` |
| v9 | v10 |
| ---------------------------------------------- | -------------------------------------------------------------------------------- |
| `icon`, icon name from `carbon-icons` | `renderIcon`, which takes a React component, e.g. one from `@carbon/icons-react` |
| `iconName`, icon data from `carbon-icons` | `renderIcon`, which takes a React component, e.g. one from `@carbon/icons-react` |
| `ref` grabs the React class instance reference | `ref` grabs the trigger button |

## `v10` example

Expand Down

0 comments on commit b2fa89f

Please sign in to comment.