Skip to content

Commit

Permalink
Fixes #1757 - Add migration docs
Browse files Browse the repository at this point in the history
  • Loading branch information
bryceosterhaus committed Apr 5, 2019
1 parent a8f969b commit 8ba4d21
Showing 1 changed file with 23 additions and 13 deletions.
36 changes: 23 additions & 13 deletions migrate-the-clay-components-from-v2-to-v3.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ This is a reference for upgrading your components from Clay v2 to Clay v3, this

This documentation page covers how to migrate from v2 to v3. The reason is covered in some blog posts:

- (**_Coming soon_**) Clay v3-beta: Introduction the new React Components
- (**_Coming soon_**) Clay v3-beta: Introduction the new React Components

## General changes

Expand Down Expand Up @@ -49,17 +49,17 @@ ClayLink has become simpler with v3, removing APIs from `icon` and `image`, maki

### API Changes

- `buttonStyle` depreciated
- `data` depreciated
- `defaultEventHandler` depreciated
- `elementClasses` renamed to `className`
- `icon` depreciated
- `iconAlignment` depreciated
- `imageAlt` depreciated
- `imageSrc` depreciated
- `label` depreciated
- `spritemap` depreciated
- `style` renamed to `displayType`
- `buttonStyle` depreciated
- `data` depreciated
- `defaultEventHandler` depreciated
- `elementClasses` renamed to `className`
- `icon` depreciated
- `iconAlignment` depreciated
- `imageAlt` depreciated
- `imageSrc` depreciated
- `label` depreciated
- `spritemap` depreciated
- `style` renamed to `displayType`

### Compositions

Expand Down Expand Up @@ -88,4 +88,14 @@ To get to the behavior of having a ClayLink with image, use the composition with
-/>
+ <ClayImage src="image.jpg" alt="my image" />
+</ClayLink>
```
```

## ClayLabel

### API Changes

- `style` is now `displayType`
- Removed `size` in favor of `large` since there is only default and large options.
- Removed `label` in favor of utilizing `children` prop
- Added `closeButtonProps` which allows you to add attributes to the nested button.
- This is where you would pass a callback for `onClick`.

0 comments on commit 8ba4d21

Please sign in to comment.