Skip to content

docs(react-persona): Adding migration guide #25022

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sopranopillow merged 9 commits into from
Oct 2, 2022
Merged

docs(react-persona): Adding migration guide #25022

Changes from 3 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
45ad08c
adding migration guide
sopranopillow Sep 29, 2022
667a963
reordering
sopranopillow Sep 29, 2022
c2fc851
removing NOT SUPPORTED from mapping table
sopranopillow Sep 29, 2022
31a9035
Update packages/react-components/react-persona/MIGRATION.md
sopranopillow Sep 30, 2022
0d89548
Update packages/react-components/react-persona/MIGRATION.md
sopranopillow Sep 30, 2022
0f141e4
Update packages/react-components/react-persona/MIGRATION.md
sopranopillow Sep 30, 2022
79ad3bd
Update packages/react-components/react-persona/MIGRATION.md
sopranopillow Sep 30, 2022
3c63f2c
Merge branch 'master' of https://www.github.com/microsoft/fluentui in…
sopranopillow Oct 1, 2022
80922fa
change file
sopranopillow Oct 1, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 41 additions & 0 deletions packages/react-components/react-persona/MIGRATION.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# Badge Migration

## Migration from v8

v8 offers a component equivalent to v9's `Persona`. However, the API is slightly different. The main difference is that v9's `Persona` does not handle the functionality of the `presence` and `avatar`. Instead, the `presence` and `avatar` are separate components that can be used in conjunction with `Persona`.

Here's how the API of v8's `Persona` compares to the one from v9's `Persona` component:

- `className` => `className`
- `coinProps` => Use `avatar`'s or `presence`'s slot props
- `componentRef` => NOT SUPPORTED - use `ref` instead
- `hidePersonaDetails` => NOT SUPPORTED
- `imageShouldFadeIn` => NOT SUPPORTED
- `isOutOfOffice` => Use `status` in `presence` slot props
- `presence` => `presence`
- `presenceTitle` => NOT SUPPORTED
- `showOverflowTooltip` => NOT SUPPORTED
- `showUnknownPersonaCoin` => NOT SUPPORTED
- `styles` => Use style customization through `className` instead

## Property Mapping

| v8 `Persona` | v9 `Persona` |
| ------------------------ | -------------------------------------- |
| `coinProps` | `avatar` or `badge` slot props |
| `coinSize` | `size` in the `badge` or `avatar` slot |
| `className` | `className` |
| `componentRef` | `ref` |
| `hidePersonaDetails` | - |
| `imageShouldFadeIn` | - |
| `isOutOfOffice` | `status` in `presence` slot props |
| `optionalText` | `quaternaryText` |
| `presence` | `presence` |
| `presenceTitle` | |
| `primaryText` | `primaryText` |
| `secondaryText` | `secondaryText` |
| `showOverflowTooltip` | - |
| `showUnknownPersonaCoin` | - |
| `styles` | `className` |
| `tertiaryText` | `tertiaryText` |
| `text` | `name` |