From 82c445db9edc472ac8c2e5582cc5654b31e917d2 Mon Sep 17 00:00:00 2001 From: David Pickart Date: Mon, 28 Sep 2020 17:25:38 -0500 Subject: [PATCH] Add migration guide --- README.md | 1 + migration-guides/v5.0.0.md | 17 +++++++++++++++++ 2 files changed, 18 insertions(+) create mode 100644 migration-guides/v5.0.0.md diff --git a/README.md b/README.md index f8c0491b..2903e24b 100644 --- a/README.md +++ b/README.md @@ -24,6 +24,7 @@ Documentation and usage info can be found in [docs.md](docs.md). - [v2.0.0](migration-guides/v2.0.0.md) - [v3.0.0](migration-guides/v3.0.0.md) - [v4.0.0](migration-guides/v4.0.0.md) +- [v5.0.0](migration-guides/v5.0.0.md) ## Contribution diff --git a/migration-guides/v5.0.0.md b/migration-guides/v5.0.0.md new file mode 100644 index 00000000..eda4d59e --- /dev/null +++ b/migration-guides/v5.0.0.md @@ -0,0 +1,17 @@ +# v5.0.0 Migration Guide + +The only breaking change in this version is that `FlashMessage` now expects separate `children` and `isError` props, rather than a single `message` prop. This allows the component to be used without needing to use `redux-flash`. + +You should update any instances of `FlashMessage` like so: + +(Note: this change is not necessary if you are using `FlashMessageContainer` instead of `FlashMessage` directly.) + +```jsx + +// Before, where "message" was a redux-flash message object: + + +// After: +{message.message} + +```