Skip to content
This repository has been archived by the owner on May 24, 2024. It is now read-only.

Commit

Permalink
updated changelogs and upgrade guide
Browse files Browse the repository at this point in the history
  • Loading branch information
supreethmr committed Oct 25, 2019
1 parent 5d5682b commit 128dd37
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 4 deletions.
6 changes: 4 additions & 2 deletions packages/terra-avatar/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,10 @@ ChangeLog
Unreleased
----------
### Breaking Changes
* `generic` subcomponent replaces the `sharedUser` subcomponent
* `generic` subcomponent contains a `variant` prop that toggles between `single-user`, `shared-user`, and `provider`.
* To Make all User avatars available in same variant `generic` subcomponent has been added.
* `generic` subcomponent replaces the `sharedUser` subcomponent.
* `generic` subcomponent contains a `variant` prop that toggles between `single-user`, `shared-user`, and `provider` user avatar.
* User icon has been moved from default varaint to `single-user` variant.

2.29.0 - (October 3, 2019)
------------------
Expand Down
8 changes: 6 additions & 2 deletions packages/terra-avatar/docs/upgrade-guide.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,16 @@
# terra-avatar Upgrade Guide
## Changes from version 2 to version 3

### Reason for Upgrade
* To group all user avatars in single variant `shared-user` has been replaced with `generic` sub-component
* To keep adding new user avatars like `provider` easier new `generic` sub-component has been added with all user avatars as variants.

### Removed
* `Shared User` subcomponent From Avatar

### Added
* the `generic` subcomponent that replaces the `sharedUser` subcomponent with a new `variant` prop that can be `single-user`, `shared-user`, or `provider`.
* `variant` prop this will take values for sub-variants `single-user`, `shared-user` and `provider`.
* The `generic` subcomponent that replaces the `sharedUser` subcomponent with a new `variant` prop that can be `single-user`, `shared-user`, or `provider`.
* `variant` prop will take values for sub-variants `single-user`, `shared-user` and `provider`..

### Steps to uplift to V3
1. Use a named export for Generic variant.
Expand Down

0 comments on commit 128dd37

Please sign in to comment.