Skip to content

Commit

Permalink
docs: add installation section in migration guide
Browse files Browse the repository at this point in the history
  • Loading branch information
lukewalczak committed Aug 2, 2022
1 parent da53fdc commit 6afa4fb
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion docs/pages/10.migration-guide-to-5.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,23 @@ React Native Paper v5 is all about adopting the new Material Design 3 <i>aka</i>

Paper now supports both Material Design 2 and 3 through the configuration described in [Versioning](#versioning) and is compatible with a handful of API changes.

# Migration guide to Material You (5.0)
# Migration guide to Material You (5.0 RC)

Version 5.0 brings support for the next Material Design iteration branded as Material You <i>(in fact being Material Design v3 or in short MD3)</i> into the `react-native-paper` library. All the components were refined according to the official [design kit on figma](https://www.figma.com/community/file/1035203688168086460) and adjusted in terms of visuals by changes in colors, typography and animations.

Below you can find the most important information about the components whose API may have changed API has been changed due to supporting new props, renaming existing ones or some deprecations. Hopefully, based on the presented required changes, migration to the latest version should be smooth. Enjoy!

### Installation

Currently v5 is a release candidate, which means it won't be installed by default from the `npm`. In order to do that, there is a need to explicitly pass package version during installation:

```sh
yarn add [email protected]
```
or
```sh
npm install [email protected]
```
## Theming

### Versioning
Expand Down

0 comments on commit 6afa4fb

Please sign in to comment.