diff --git a/CHANGELOG.md b/CHANGELOG.md index fa0b58a66..1e3b1a080 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,16 @@ # OverReact Changelog +## [3.5.0](https://github.com/Workiva/over_react/compare/3.4.1...3.5.0) +- Introduce new and improved component boilerplate syntax 🎉 + + ![side-by-side comparison of old and new boilerplate for a simple component](doc/new-boilerplate-side-by-side.png) + + See our [migration guide](https://github.com/Workiva/over_react/blob/master/doc/new_boilerplate_migration.md) for more information around these changes, including why we made them and how to convert existing components to use thew new syntax. + + The existing boilerplate syntax will be deprecated in a future release. + +- [#469] Throw helpful error when `connect`, `connectFlux`, and `forwardRef` are passed an invalid component. + ## [3.4.1](https://github.com/Workiva/over_react/compare/3.4.0...3.4.1) - [#468] Allow redux.dart version 4 diff --git a/doc/new-boilerplate-side-by-side.png b/doc/new-boilerplate-side-by-side.png new file mode 100644 index 000000000..72ede020c Binary files /dev/null and b/doc/new-boilerplate-side-by-side.png differ diff --git a/doc/new_boilerplate_migration.md b/doc/new_boilerplate_migration.md index e9cb9fccf..d0936b897 100644 --- a/doc/new_boilerplate_migration.md +++ b/doc/new_boilerplate_migration.md @@ -1,5 +1,8 @@ # New OverReact Boilerplate Migration Guide +_Preview of new boilerplate:_ +![side-by-side comparison of old and new boilerplate](new-boilerplate-side-by-side.png) + * __[Background](#background)__ * [Problems with Previous Boilerplate](#problems-with-previous-boilerplate) * __[New Boilerplate Updates](#new-boilerplate-updates)__ diff --git a/pubspec.yaml b/pubspec.yaml index 960222f20..72695c93a 100644 --- a/pubspec.yaml +++ b/pubspec.yaml @@ -1,5 +1,5 @@ name: over_react -version: 3.4.1 +version: 3.5.0 description: A library for building statically-typed React UI components using Dart. homepage: https://github.com/Workiva/over_react/ authors: