reduxjs/react-redux
### [`v8.0.7`](https://togithub.com/reduxjs/react-redux/releases/tag/v8.0.7)
[Compare Source](https://togithub.com/reduxjs/react-redux/compare/v8.0.6...v8.0.7)
This release updates the peer dependencies to accept Redux Toolkit, and accept the ongoing RTK and Redux core betas as valid peer deps.
> **Note**: These changes were initially in 8.0.6, but that had a typo in the peer deps that broke installation. Sorry!
##### What's Changed
- Bump Redux peer deps to accept 5.0 betas, and bump RTK dev dep by [@markerikson](https://togithub.com/markerikson) in [https://github.com/reduxjs/react-redux/pull/2017](https://togithub.com/reduxjs/react-redux/pull/2017)
- [`d45204f`](https://togithub.com/reduxjs/react-redux/commit/d45204f) : Fix broken RTK peer dep
**Full Changelog**: https://github.com/reduxjs/react-redux/compare/v8.0.5...v8.0.7
### [`v8.0.6`](https://togithub.com/reduxjs/react-redux/releases/tag/v8.0.6)
[Compare Source](https://togithub.com/reduxjs/react-redux/compare/v8.0.5...v8.0.6)
\~~This release updates the peer dependencies to accept Redux Toolkit, and accept the ongoing RTK and Redux core betas as valid peer deps.~~
**This release has a peer deps typo that breaks installation - please use 8.0.7 instead !**
#### What's Changed
- Bump Redux peer deps to accept 5.0 betas, and bump RTK dev dep by [@markerikson](https://togithub.com/markerikson) in [https://github.com/reduxjs/react-redux/pull/2017](https://togithub.com/reduxjs/react-redux/pull/2017)
**Full Changelog**: https://github.com/reduxjs/react-redux/compare/v8.0.5...v8.0.6
### [`v8.0.5`](https://togithub.com/reduxjs/react-redux/releases/tag/v8.0.5)
[Compare Source](https://togithub.com/reduxjs/react-redux/compare/v8.0.4...v8.0.5)
This release fixes a few minor TS issues.
#### What's Changed
- `Provider`: pass state (`S`) generic through to `ProviderProps` by [@OliverJAsh](https://togithub.com/OliverJAsh) in [https://github.com/reduxjs/react-redux/pull/1960](https://togithub.com/reduxjs/react-redux/pull/1960)
- wrap `equalityFn` type in `NoInfer` by [@phryneas](https://togithub.com/phryneas) in [https://github.com/reduxjs/react-redux/pull/1965](https://togithub.com/reduxjs/react-redux/pull/1965)
- Fix wrapped component prop types when passing nullish mapDispatchToProps by [@marconi1992](https://togithub.com/marconi1992) in [https://github.com/reduxjs/react-redux/pull/1928](https://togithub.com/reduxjs/react-redux/pull/1928)
**Full Changelog**: https://github.com/reduxjs/react-redux/compare/v8.0.4...v8.0.5
### [`v8.0.4`](https://togithub.com/reduxjs/react-redux/releases/tag/v8.0.4)
[Compare Source](https://togithub.com/reduxjs/react-redux/compare/v8.0.3...v8.0.4)
This patch release fixes some minor TS types issues, and updates the rarely-used `areStatesEqual` option for `connect` to now pass through `ownProps` for additional use in determining which pieces of state to compare if desired.
> **Note**: 8.0.3 was accidentally published without one of these fixes. Use 8.0.4 instead.
#### Changelog
##### TS Fixes
We've fixed an import of `React` that caused issues with the `allowSyntheticDefaultImports` TS compiler flag in user projects.
`connect` already accepted a custom context instance as `props.context`, and had runtime checks in case users were passing through a real value with app data as `props.context` instead. However, the TS types did not handle that case, and this would fail to compile. If your own component expects `props.context` with actual data, `connect`'s types now use that type instead.
The `ConnectedProps` type had a mismatch with React's built-in `React.ComponentProps` type, and that should now work correctly.
##### Other Changes
The `areStatesEqual` option to `connect` now receives `ownProps` as well, in case you need to make a more specific comparison with certain sections of state.
The new signature is:
```ts
{
areStatesEqual?: (
nextState: State,
prevState: State,
nextOwnProps: TOwnProps,
prevOwnProps: TOwnProps
) => boolean
}
```
#### What's Changed
- Don't require allowSyntheticDefaultImports: true by [@apepper](https://togithub.com/apepper) in [https://github.com/reduxjs/react-redux/pull/1924](https://togithub.com/reduxjs/react-redux/pull/1924)
- Fixed type issue with `ComponentProps` from older `@types/react` by [@Andarist](https://togithub.com/Andarist) in [https://github.com/reduxjs/react-redux/pull/1956](https://togithub.com/reduxjs/react-redux/pull/1956)
- connect: pass ownProps to areStatesEqual by [@jspurlin](https://togithub.com/jspurlin) in [https://github.com/reduxjs/react-redux/pull/1951](https://togithub.com/reduxjs/react-redux/pull/1951)
- Omit built-in context prop if user component props include context by [@markerikson](https://togithub.com/markerikson) in [https://github.com/reduxjs/react-redux/pull/1958](https://togithub.com/reduxjs/react-redux/pull/1958)
**Full Changelog**: https://github.com/reduxjs/react-redux/compare/v8.0.2...v8.0.4
### [`v8.0.3`](https://togithub.com/reduxjs/react-redux/releases/tag/v8.0.3)
[Compare Source](https://togithub.com/reduxjs/react-redux/compare/v8.0.2...v8.0.3)
**This release was accidentally published without an intended fix - please use [v8.0.4](https://togithub.com/reduxjs/react-redux/releases/tag/v8.0.4) instead**
### [`v8.0.2`](https://togithub.com/reduxjs/react-redux/releases/tag/v8.0.2)
[Compare Source](https://togithub.com/reduxjs/react-redux/compare/v8.0.1...v8.0.2)
This patch release tweaks the behavior of `connect` to print a one-time warning when the obsolete `pure` option is passed in, rather than throwing an error. This fixes crashes caused by libraries such as `react-beautiful-dnd` continuing to pass in that option (unnecessarily) to React-Redux v8.
#### What's Changed
- Show warning instead of throwing error that pure option has been removed by [@ApacheEx](https://togithub.com/ApacheEx) in [https://github.com/reduxjs/react-redux/pull/1922](https://togithub.com/reduxjs/react-redux/pull/1922)
**Full Changelog**: https://github.com/reduxjs/react-redux/compare/v8.0.1...v8.0.2
### [`v8.0.1`](https://togithub.com/reduxjs/react-redux/releases/tag/v8.0.1)
[Compare Source](https://togithub.com/reduxjs/react-redux/compare/v8.0.0...v8.0.1)
This release fixes an incorrect internal import of our `Subscription` type, which was causing TS compilation errors in some user projects. We've also listed `@types/react-dom` as an optional peerDep. There are no runtime changes in this release.
#### What's Changed
- Add optional peer dependency on [@types/react-dom](https://togithub.com/types/react-dom) by [@Methuselah96](https://togithub.com/Methuselah96) in [https://github.com/reduxjs/react-redux/pull/1904](https://togithub.com/reduxjs/react-redux/pull/1904)
- fix(ts): incorrect import of `Subscription` causes `noImplicitAny` error by [@vicrep](https://togithub.com/vicrep) in [https://github.com/reduxjs/react-redux/pull/1910](https://togithub.com/reduxjs/react-redux/pull/1910)
**Full Changelog**: https://github.com/reduxjs/react-redux/compare/v8.0.0...v8.0.1
### [`v8.0.0`](https://togithub.com/reduxjs/react-redux/releases/tag/v8.0.0)
[Compare Source](https://togithub.com/reduxjs/react-redux/compare/v7.2.9...v8.0.0)
This **major version** release updates `useSelector`, `connect`, and `` for compatibility with React 18, rewrites the React-Redux codebase to TypeScript (obsoleting use of `@types/react-redux`), modernizes build output, and removes the deprecated `connectAdvanced` API and the `pure` option for `connect`.
npm i react-redux@latest
yarn add react-redux@latest
#### Overview, Compatibility, and Migration
Our public API is still the same ( ``, `connect` and `useSelector/useDispatch`), but we've updated the internals to use the new `useSyncExternalStore` hook from React. React-Redux v8 is still compatible with all versions of React that have hooks (16.8+, 17.x, and 18.x; React Native 0.59+), and *should* just work out of the box.
In most cases, it's very likely that the only change you will need to make is bumping the package version to `"react-redux": "^8.0"`.
*If* you are using the rarely-used `connectAdvanced` API, you will need to rewrite your code to avoid that, likely by using the hooks API instead. Similarly, the `pure` option for `connect` has been removed.
If you are using Typescript, React-Redux is now written in TS and includes its own types. You should remove any dependencies on `@types/react-redux`.
While not directly tied to React-Redux, note that **the recently updated `@types/react@18` major version has changed component definitions to remove having `children` as a prop by default**. This causes errors if you have multiple copies of `@types/react` in your project. To fix this, tell your package manager to resolve `@types/react` to a single version. Details:
[**React issue #24304: React 18 types broken since release**](https://togithub.com/facebook/react/issues/24304#issuecomment-1094565891)
Additionally, please see the React post on [**How to Ugprade to React 18**](https://reactjs.org/blog/2022/03/08/react-18-upgrade-guide.html) for details on how to migrate existing apps to correctly use React 18 and take advantage of its new features.
#### Changelog
##### React 18 Compatibility
React-Redux now requires the new [`useSyncExternalStore` API in React 18](https://togithub.com/reactwg/react-18/discussions/86). By default, it uses the "shim" package which backfills that API in earlier React versions, so **React-Redux v8 is compatible with all React versions that have hooks** (16.8+, and React Native 0.59+) as its acceptable peer dependencies.
We'd especially like to thank the React team for their extensive support and cooperation during the `useSyncExternalStore` development effort. They specifically designed `useSyncExternalStore` to support the needs and use cases of React-Redux, and we used React-Redux v8 as a testbed for how `useSyncExternalStore` would behave and what it needed to cover. This in turn helped ensure that `useSyncExternalStore` would be useful and work correctly for other libraries in the ecosystem as well.
Our performance benchmarks show parity with React-Redux v7.2.5 for both `connect` and `useSelector`, so we do not anticipate any meaningful performance regressions.
##### `useSyncExternalStore` and Bundling
The `useSyncExternalStore` shim is imported directly in the main entry point, so it's *always* included in bundles even if you're using React 18. This adds roughly 600 bytes minified to your bundle size.
If you are using React 18 and would like to avoid that extra bundle cost, React-Redux now has a new `/next` entry point. This exports the exact same APIs, but directly imports `useSyncExternalStore` from React itself, and thus avoids including the shim. You can alias `"react-redux": "react-redux/next"` in your bundler to use that instead.
##### SSR and Hydration
React 18 introduces a new `hydrateRoot` method for hydrating the UI on the client in Server-Side Rendering usage. As part of that, the `useSyncExternalStore` API requires that we pass in an alternate state value other than what's in the actual Redux store, and that alternate value will be used for the entire initial hydration render to ensure the initial rehydrated UI is an exact match for what was rendered on the server. After the hydration render is complete, React will then apply any additional changes from the store state in a follow-up render.
React-Redux v8 supports this by adding a new `serverState` prop for ``. If you're using SSR, you should pass your serialized state to `` to ensure there are no hydration mismatch errors:
```ts
import { hydrateRoot } from 'react-dom/client'
import { configureStore } from '@reduxjs/toolkit'
import { Provider } from 'react-redux'
const preloadedState = window.__PRELOADED_STATE__
const clientStore = configureStore({
reducer: rootReducer,
preloadedState,
})
hydrateRoot(
document.getElementById('root'),
)
```
##### TypeScript Migration and Support
The React-Redux library source has always been written in plain JS, and the community maintained the TS typings separately as `@types/react-redux`.
We've (finally!) [migrated the React-Redux codebase to TypeScript](https://togithub.com/reduxjs/react-redux/issues/1737), using the existing typings as a starting point. This means that **the `@types/react-redux` package is no longer needed, and you should remove that as a dependency**.
> **Note** Please ensure that any installed copies of `redux` and `@types/react` are de-duped. You are also encouraged to update to the latest versions of Redux Toolkit (1.8.1+) or Redux (4.1.2), to ensure consistency between installed types and avoid problems from types mismatches.
We've tried to maintain the same external type signatures as much as possible. If you do see any compile problems, please file issues with any apparent TS-related problems so we can review them.
The TS migration was a great collaborative effort, with many community members contributing migrated files. Thank you to everyone who helped out!
In addition to the "pre-typed" `TypedUseSelectorHook`, there's now also a `Connect` type that can be used as a "pre-typed" version of `connect` as well.
As part of the process, we also updated the repo to use Yarn 3, copied the typetests files from DefinitelyTyped and expanded them, and improved our CI setup to test against multiple TS versions.
##### Removal of the `DefaultRootState` type
The `@types/react-redux` package, which has always been maintained by the community, included a `DefaultRootState` interface that was intended for use with TS's "module augmentation" capability. Both `connect` and `useSelector` used this as a fallback if no state generic was provided. When we migrated React-Redux to TS, we copied over all of the types from that package as a starting point.
However, the Redux team [specifically considers use of a globally augmented state type to be an anti-pattern](https://togithub.com/reduxjs/react-redux/issues/1879). Instead, we direct users to [extract the `RootState` and `AppDispatch` types from the store setup](https://redux.js.org/tutorials/typescript-quick-start#define-root-state-and-dispatch-types), and [create pre-typed versions of the React-Redux hooks](https://redux.js.org/tutorials/typescript-quick-start#define-typed-hooks) for use in the app.
Now that React-Redux itself is written in TS, we've opted to remove the `DefaultRootState` type entirely. State generics now default to `unknown` instead.
Technically [the module augmentation approach can still be done in userland](https://togithub.com/reduxjs/react-redux/issues/1879#issuecomment-1073284804), but we discourage this practice.
##### Modernized Build Output
We've always targeted ES5 syntax in our published build artifacts as the lowest common denominator. Even the "ES module" artifacts with `import/export` keywords still were compiled to ES5 syntax otherwise.
With IE11 now effectively dead and many sites no longer supporting it, we've updated our build tooling to target a more modern syntax equivalent to ES2017, which shrinks the bundle size slightly.
If you still need to support ES5-only environments, please compile your own dependencies as needed for your target environment.
##### Removal of Legacy APIs
We announced in 2019 that [the legacy `connectAdvanced` API would be removed in the next major version](https://togithub.com/reduxjs/react-redux/issues/1236), as it was rarely used, added internal complexity, and was also basically irrelevant with the introduction of hooks. As promised, we've removed that API.
We've also removed the `pure` option for `connect`, which forced components to re-render regardless of whether props/state had actually changed if it was set to `false`. This option was needed in some cases in the early days of the React ecosystem, when components sometimes relied on external mutable data sources that could change outside of rendering. Today, no one writes components that way, the option was barely used, and React 18's `useSyncExternalStore` strictly requires immutable updates. So, we've removed the `pure` flag.
Given that both of these options were almost never used, this shouldn't meaningfully affect anyone.
#### Changes
Due to the TS migration effort and number of contributors, this list covers just the major changes:
- Integrate TypeScript port by [@markerikson](https://togithub.com/markerikson) in [https://github.com/reduxjs/react-redux/pull/1739](https://togithub.com/reduxjs/react-redux/pull/1739)
- Initial experimental React 18 compat prototyping by [@markerikson](https://togithub.com/markerikson) in [https://github.com/reduxjs/react-redux/pull/1808](https://togithub.com/reduxjs/react-redux/pull/1808)
- Fix compatibility with React 18 strict effects by [@markerikson](https://togithub.com/markerikson) in [https://github.com/reduxjs/react-redux/pull/1817](https://togithub.com/reduxjs/react-redux/pull/1817)
- Update to latest React 18 alpha dependencies by [@markerikson](https://togithub.com/markerikson) in [https://github.com/reduxjs/react-redux/pull/1834](https://togithub.com/reduxjs/react-redux/pull/1834)
- Port remaining v7 typetests and improve v8 types by [@markerikson](https://togithub.com/markerikson) in [https://github.com/reduxjs/react-redux/pull/1855](https://togithub.com/reduxjs/react-redux/pull/1855)
- Add initial SSR support for React 18 and React-Redux v8 by [@markerikson](https://togithub.com/markerikson) in [https://github.com/reduxjs/react-redux/pull/1835](https://togithub.com/reduxjs/react-redux/pull/1835)
- test: Adjust type tests to be compatible with React 18 typings by [@eps1lon](https://togithub.com/eps1lon) in [https://github.com/reduxjs/react-redux/pull/1868](https://togithub.com/reduxjs/react-redux/pull/1868)
- Switch back to Subscription in useSelector to fix unsubscribe perf by [@markerikson](https://togithub.com/markerikson) in [https://github.com/reduxjs/react-redux/pull/1870](https://togithub.com/reduxjs/react-redux/pull/1870)
- Cleanup more code after `pure` removal by [@Andarist](https://togithub.com/Andarist) in [https://github.com/reduxjs/react-redux/pull/1859](https://togithub.com/reduxjs/react-redux/pull/1859)
- Swap `useSyncExternalStore` shim behavior and update React deps by [@markerikson](https://togithub.com/markerikson) in [https://github.com/reduxjs/react-redux/pull/1884](https://togithub.com/reduxjs/react-redux/pull/1884)
- Remove `DefaultRootState` type by [@markerikson](https://togithub.com/markerikson) in [https://github.com/reduxjs/react-redux/pull/1887](https://togithub.com/reduxjs/react-redux/pull/1887)
- Add SSR test for `serverState` behavior by [@markerikson](https://togithub.com/markerikson) in [https://github.com/reduxjs/react-redux/pull/1888](https://togithub.com/reduxjs/react-redux/pull/1888)
- Cleanup internal types in selectorFactory.ts by [@Methuselah96](https://togithub.com/Methuselah96) in [https://github.com/reduxjs/react-redux/pull/1889](https://togithub.com/reduxjs/react-redux/pull/1889)
- Remove ts-ignore for initMergeProps by [@Methuselah96](https://togithub.com/Methuselah96) in [https://github.com/reduxjs/react-redux/pull/1891](https://togithub.com/reduxjs/react-redux/pull/1891)
- fix(deps): add optional peer deps into `peerDependencies` by [@kyletsang](https://togithub.com/kyletsang) in [https://github.com/reduxjs/react-redux/pull/1893](https://togithub.com/reduxjs/react-redux/pull/1893)
- Update peer deps for v8 by [@markerikson](https://togithub.com/markerikson) in [https://github.com/reduxjs/react-redux/pull/1895](https://togithub.com/reduxjs/react-redux/pull/1895)
- Port DT fix for `dispatchProp` arg in `mergeProps` by [@markerikson](https://togithub.com/markerikson) in [https://github.com/reduxjs/react-redux/pull/1897](https://togithub.com/reduxjs/react-redux/pull/1897)
- Update docs for v8 final by [@markerikson](https://togithub.com/markerikson) in [https://github.com/reduxjs/react-redux/pull/1902](https://togithub.com/reduxjs/react-redux/pull/1902)
### [`v7.2.9`](https://togithub.com/reduxjs/react-redux/releases/tag/v7.2.9)
[Compare Source](https://togithub.com/reduxjs/react-redux/compare/v7.2.8...v7.2.9)
This patch release updates the rarely-used `areStatesEqual` option for `connect` to now pass through `ownProps` for additional use in determining which pieces of state to compare if desired.
The new signature is:
```ts
{
areStatesEqual?: (
nextState: State,
prevState: State,
nextOwnProps: TOwnProps,
prevOwnProps: TOwnProps
) => boolean
}
```
#### What's Changed
- connect: pass ownProps to areStatesEqual by [@jspurlin](https://togithub.com/jspurlin) in [https://github.com/reduxjs/react-redux/pull/1952](https://togithub.com/reduxjs/react-redux/pull/1952)
**Full Changelog**: https://github.com/reduxjs/react-redux/compare/v7.2.8...v7.2.9
Configuration
📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).
🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.
♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.
🔕 Ignore: Close this PR and you won't be reminded about this update again.
[ ] If you want to rebase/retry this PR, check this box
This PR has been generated by Mend Renovate. View repository job log here.
This PR contains the following updates:
7.2.8->8.0.7Release Notes
reduxjs/react-redux
### [`v8.0.7`](https://togithub.com/reduxjs/react-redux/releases/tag/v8.0.7) [Compare Source](https://togithub.com/reduxjs/react-redux/compare/v8.0.6...v8.0.7) This release updates the peer dependencies to accept Redux Toolkit, and accept the ongoing RTK and Redux core betas as valid peer deps. > **Note**: These changes were initially in 8.0.6, but that had a typo in the peer deps that broke installation. Sorry! ##### What's Changed - Bump Redux peer deps to accept 5.0 betas, and bump RTK dev dep by [@markerikson](https://togithub.com/markerikson) in [https://github.com/reduxjs/react-redux/pull/2017](https://togithub.com/reduxjs/react-redux/pull/2017) - [`d45204f`](https://togithub.com/reduxjs/react-redux/commit/d45204f) : Fix broken RTK peer dep **Full Changelog**: https://github.com/reduxjs/react-redux/compare/v8.0.5...v8.0.7 ### [`v8.0.6`](https://togithub.com/reduxjs/react-redux/releases/tag/v8.0.6) [Compare Source](https://togithub.com/reduxjs/react-redux/compare/v8.0.5...v8.0.6) \~~This release updates the peer dependencies to accept Redux Toolkit, and accept the ongoing RTK and Redux core betas as valid peer deps.~~ **This release has a peer deps typo that breaks installation - please use 8.0.7 instead !** #### What's Changed - Bump Redux peer deps to accept 5.0 betas, and bump RTK dev dep by [@markerikson](https://togithub.com/markerikson) in [https://github.com/reduxjs/react-redux/pull/2017](https://togithub.com/reduxjs/react-redux/pull/2017) **Full Changelog**: https://github.com/reduxjs/react-redux/compare/v8.0.5...v8.0.6 ### [`v8.0.5`](https://togithub.com/reduxjs/react-redux/releases/tag/v8.0.5) [Compare Source](https://togithub.com/reduxjs/react-redux/compare/v8.0.4...v8.0.5) This release fixes a few minor TS issues. #### What's Changed - `Provider`: pass state (`S`) generic through to `ProviderProps` by [@OliverJAsh](https://togithub.com/OliverJAsh) in [https://github.com/reduxjs/react-redux/pull/1960](https://togithub.com/reduxjs/react-redux/pull/1960) - wrap `equalityFn` type in `NoInfer` by [@phryneas](https://togithub.com/phryneas) in [https://github.com/reduxjs/react-redux/pull/1965](https://togithub.com/reduxjs/react-redux/pull/1965) - Fix wrapped component prop types when passing nullish mapDispatchToProps by [@marconi1992](https://togithub.com/marconi1992) in [https://github.com/reduxjs/react-redux/pull/1928](https://togithub.com/reduxjs/react-redux/pull/1928) **Full Changelog**: https://github.com/reduxjs/react-redux/compare/v8.0.4...v8.0.5 ### [`v8.0.4`](https://togithub.com/reduxjs/react-redux/releases/tag/v8.0.4) [Compare Source](https://togithub.com/reduxjs/react-redux/compare/v8.0.3...v8.0.4) This patch release fixes some minor TS types issues, and updates the rarely-used `areStatesEqual` option for `connect` to now pass through `ownProps` for additional use in determining which pieces of state to compare if desired. > **Note**: 8.0.3 was accidentally published without one of these fixes. Use 8.0.4 instead. #### Changelog ##### TS Fixes We've fixed an import of `React` that caused issues with the `allowSyntheticDefaultImports` TS compiler flag in user projects. `connect` already accepted a custom context instance as `props.context`, and had runtime checks in case users were passing through a real value with app data as `props.context` instead. However, the TS types did not handle that case, and this would fail to compile. If your own component expects `props.context` with actual data, `connect`'s types now use that type instead. The `ConnectedPropsConfiguration
📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).
🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.
♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.
🔕 Ignore: Close this PR and you won't be reminded about this update again.
This PR has been generated by Mend Renovate. View repository job log here.