mobx-react 7.6.0 → 8.0.0

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # mobx-react
 
+## 8.0.0
+
+### Major Changes
+
+-   [`44a2cf42`](https://github.com/mobxjs/mobx/commit/44a2cf42dec7635f639ddbfb19202ebc710bac54) [#3590](https://github.com/mobxjs/mobx/pull/3590) Thanks [@urugator](https://github.com/urugator)! - Functional components now use `useSyncExternalStore`, which should prevent tearing - you have to update mobx, otherwise it should behave as previously.<br>
+    Improved displayName/name handling of functional components as discussed in #3438.<br>
+    Reactions of uncommited class components are now correctly disposed, fixes #3492.<br>
+    Reactions don't notify uncommited class components, avoiding the warning, fixes #3492.<br>
+    Removed symbol "polyfill" and replaced with actual Symbols.<br>
+    Removed `this.render` replacement detection + warning. `this.render` is no longer configurable/writable (possibly BC).<br>
+    Class component instance is no longer exposed as `component[$mobx]["reactcomponent"]` (possibly BC).<br>
+    Deprecated `disposeOnUnmount`, it's not compatible with remounting.<br>
+
+### Patch Changes
+
+-   Updated dependencies [[`44a2cf42`](https://github.com/mobxjs/mobx/commit/44a2cf42dec7635f639ddbfb19202ebc710bac54)]:
+    -   mobx-react-lite@4.0.0
+
 ## 7.6.0
 
 ### Minor Changes

package/README.md

@@ -11,15 +11,15 @@ Exports the `observer` decorator and other utilities.
 For documentation, see the [MobX](https://mobx.js.org) project.
 This package supports both React and React Native.
 
-## Choosing your version
+## Compatibility matrix
 
-There are currently two actively maintained versions of mobx-react:
+Only the latest version is actively maintained. If you're missing a fix or a feature in older version, consider upgrading or using [patch-package](https://www.npmjs.com/package/patch-package)
 
 | NPM Version | Support MobX version | Supported React versions | Supports hook based components                                                   |
 | ----------- | -------------------- | ------------------------ | -------------------------------------------------------------------------------- |
-| v7          | 6.\*                 | 16.8+                    | Yes                                                                              |
-| v6          | 4._ / 5._            | 16.8+                    | Yes                                                                              |
-| v5          | 4._ / 5._            | 0.13+                    | No, but it is possible to use `<Observer>` sections inside hook based components |
+| v7          | 6.\*                 | >16.8                    | Yes                                                                              |
+| v6          | 4.\* / 5.\*          | >16.8 <18                | Yes                                                                              |
+| v5          | 4.\* / 5.\*          | >0.13 <18                | No, but it is possible to use `<Observer>` sections inside hook based components |
 
 mobx-react 6 / 7 is a repackage of the smaller [mobx-react-lite](https://github.com/mobxjs/mobx/tree/main/packages/mobx-react-lite) package + following features from the `mobx-react@5` package added:
 
@@ -136,8 +136,6 @@ person.name = "Mike" // will cause the Observer region to re-render
 
 ### `useLocalObservable` hook
 
-[User guide](https://mobx-react.js.org/state-local)
-
 Local observable state can be introduced by using the `useLocalObservable` hook, that runs once to create an observable store. A quick example would be:
 
 ```javascript
@@ -218,8 +216,6 @@ Use `import { PropTypes } from "mobx-react"` to import them, then use for exampl
 
 ### `Provider` and `inject`
 
-See also [the migration guide to React Hooks](https://mobx-react.js.org/recipes-migration).
-
 _Note: usually there is no need anymore to use `Provider` / `inject` in new code bases; most of its features are now covered by `React.createContext`._
 
 `Provider` is a component that can pass stores (or other stuff) using React's context mechanism to child components.
@@ -270,7 +266,7 @@ Notes:
 #### "The set of provided stores has changed" error
 
 Values provided through `Provider` should be final. Make sure that if you put things in `context` that might change over time, that they are `@observable` or provide some other means to listen to changes, like callbacks. However, if your stores will change over time, like an observable value of another store, MobX will throw an error.
-This restriction exists mainly for legacy reasons. If you have a scenario where you need to modify the set of stores, please leave a comment about it in this issue https://github.com/mobxjs/mobx-react/issues/745. Or a preferred way is to [use React Context](https://mobx-react.js.org/recipes-context) directly which does not have this restriction.
+This restriction exists mainly for legacy reasons. If you have a scenario where you need to modify the set of stores, please leave a comment about it in this issue https://github.com/mobxjs/mobx-react/issues/745. Or a preferred way is to [use React Context](https://reactjs.org/docs/context.html) directly which does not have this restriction.
 
 #### Inject as function
 
@@ -398,8 +394,6 @@ public render() {
 }
 ```
 
-By [migrating to React Hooks](https://mobx-react.js.org/recipes-migration) you can avoid problems with TypeScript.
-
 #### Testing store injection
 
 It is allowed to pass any declared store in directly as a property as well. This makes it easy to set up individual component tests without a provider.

package/dist/disposeOnUnmount.d.ts

@@ -1,5 +1,11 @@
 import React from "react";
 declare type Disposer = () => void;
+/**
+ * @deprecated `disposeOnUnmount` is not compatible with React 18 and higher.
+ */
 export declare function disposeOnUnmount(target: React.Component<any, any>, propertyKey: PropertyKey): void;
+/**
+ * @deprecated `disposeOnUnmount` is not compatible with React 18 and higher.
+ */
 export declare function disposeOnUnmount<TF extends Disposer | Array<Disposer>>(target: React.Component<any, any>, fn: TF): TF;
 export {};