Version 2.0

.size-limit.json

@@ -1,13 +1,13 @@
 [
     {
         "path": "dist/mobxreactlite.umd.production.min.js",
-        "limit": "1.6 KB",
+        "limit": "1.7 KB",
         "webpack": false,
         "running": false
     },
     {
         "path": "dist/mobxreactlite.cjs.production.min.js",
-        "limit": "1.6 KB",
+        "limit": "1.7 KB",
         "webpack": false,
         "running": false
     }

README.md

@@ -1,37 +1,46 @@
-# mobx-react-lite <!-- omit in toc -->
+# mobx-react-lite
 
-[![CircleCI](https://circleci.com/gh/mobxjs/mobx-react-lite.svg?style=svg)](https://circleci.com/gh/mobxjs/mobx-react-lite)[![Coverage Status](https://coveralls.io/repos/github/mobxjs/mobx-react-lite/badge.svg)](https://coveralls.io/github/mobxjs/mobx-react-lite)
+[![CircleCI](https://circleci.com/gh/mobxjs/mobx-react-lite.svg?style=svg)](https://circleci.com/gh/mobxjs/mobx-react-lite)[![Coverage Status](https://coveralls.io/repos/github/mobxjs/mobx-react-lite/badge.svg)](https://coveralls.io/github/mobxjs/mobx-react-lite)[![NPM downloads](https://img.shields.io/npm/dm/mobx-react-lite.svg?style=flat)](https://npmjs.com/package/mobx-react-lite)[![Minzipped size](https://img.shields.io/bundlephobia/minzip/mobx-react-lite.svg)](https://bundlephobia.com/result?p=mobx-react-lite)
+
+[![TypeScript](https://badges.frapsoft.com/typescript/code/typescript.svg?v=101)](https://github.com/ellerbrock/typescript-badges/)[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://github.com/prettier/prettier)
 
 [![Join the chat at https://gitter.im/mobxjs/mobx](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/mobxjs/mobx?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 
-This is a next iteration of [mobx-react](https://github.com/mobxjs/mobx-react) coming from introducing React hooks which simplifies a lot of internal workings of this package.
+[![NPM](https://nodei.co/npm/mobx-react-lite.png)](https://www.npmjs.com/package/mobx-react-lite)
 
 **You need React version 16.8.0 and above**
 
-Class based components **are not supported** except using `<Observer>` directly in class `render` method. If you want to transition existing projects from classes to hooks (as most of us do), you can use this package alongside the [mobx-react](https://github.com/mobxjs/mobx-react) just fine. The only conflict point is about the `observer` HOC. Subscribe [to this issue](https://github.com/mobxjs/mobx-react/issues/640) for a proper migration guide.
+This is a lighter version of [mobx-react](https://github.com/mobxjs/mobx-react) which supports React **functional components only** and as such makes the library slightly faster and smaller (_only 1.5kB gzipped_). In fact `mobx-react@6` has this library as a dependency and builds on top of it.
 
-[![NPM](https://nodei.co/npm/mobx-react-lite.png)](https://www.npmjs.com/package/mobx-react-lite)
+The library does not include any Provider/inject utilities as they can be fully replaced with [React Context](https://mobx-react.js.org/recipes-context). Check out [the migration guide](https://mobx-react.js.org/recipes-migration).
 
-Project is written in TypeScript and provides type safety out of the box. No Flow Type support is planned at this moment, but feel free to contribute.
+Class based components **are not supported** except using `<Observer>` directly in class `render` method. If you want to transition existing projects from classes to hooks, use [mobx-react 6+](https://github.com/mobxjs/mobx-react).
+
+See more at [the libraries overview](https://mobx-react.js.org/libraries).
 
 ## User Guide 👉 https://mobx-react.js.org
 
 The site contains various examples and recipes for using MobX in React world. Feel free to contribute. The API reference of this package follows 👇.
 
 ## API reference ⚒
 
-> **`<Observer>{renderFn}</Observer>`** _([user guide](https://mobx-react.js.org/observer-component))_
+### **`<Observer>{renderFn}</Observer>`** _([user guide](https://mobx-react.js.org/observer-component))_
+
+Is a React component, which applies observer to an anonymous region in your component.
 
-> **`observer<P>(baseComponent: FunctionComponent<P>, options?: IObserverOptions): FunctionComponent<P>`** _([user guide](https://mobx-react.js.org/observer-hoc))_
+### **`observer<P>(baseComponent: FunctionComponent<P>, options?: IObserverOptions): FunctionComponent<P>`** _([user guide](https://mobx-react.js.org/observer-hoc))_
 
 ```ts
 interface IObserverOptions {
-    // Pass true to use React.forwardRef over the inner component. It's false by the default.
+    // Pass true to wrap the inner component with React.forwardRef.
+    // It's false by the default.
     forwardRef?: boolean
 }
 ```
 
-> **`useObserver<T>(fn: () => T, baseComponentName = "observed", options?: IUseObserverOptions): T`** _([user guide](https://mobx-react.js.org/observer-hook))_
+The observer converts a component into a reactive component, which tracks which observables are used automatically and re-renders the component when one of these values changes.
+
+### **`useObserver<T>(fn: () => T, baseComponentName = "observed", options?: IUseObserverOptions): T`** _([user guide](https://mobx-react.js.org/observer-hook))_
 
 ```ts
 interface IUseObserverOptions {
@@ -40,142 +49,12 @@ interface IUseObserverOptions {
 }
 ```
 
-**`useLocalStore<T, S>(initializer: () => T, source?: S): T`** _([user guide](https://mobx-react.js.org/state-local))_
-
-**`useAsObservableSource<T>(source: T): T`** _([user guide](https://mobx-react.js.org/state-outsourcing))_
-
-## React Strict mode ☄
-
-Feel free to try out `mobx-react-lite@next` which is based on latest 1.x, but contains experimental support for handling Concurrent mode in React properly.
+It allows you to use an observer like behaviour, but still allowing you to optimize the component in any way you want (e.g. using memo with a custom areEqual, using forwardRef, etc.) and to declare exactly the part that is observed (the render phase).
 
-## Deprecation notice ⚠
+### **`useLocalStore<T, S>(initializer: () => T, source?: S): T`** _([user guide](https://mobx-react.js.org/state-local))_
 
-Following utilities are still available in the package, but they are deprecated and will be removed in the next major version (2.x). As such, they are not mentioned in the user guide and it's not recommend to continue using these.
+Local observable state can be introduced by using the useLocalStore hook, that runs its initializer function once to create an observable store and keeps it around for a lifetime of a component.
 
----
-
-### `useObservable<T>(initialValue: T): T`
-
-> **Use the `useLocalStore` instead** ([user guide](https://mobx-react.js.org/state-local))
-
-React hook that allows creating observable object within a component body and keeps track of it over renders. Gets all the benefits from [observable objects](https://mobx.js.org/refguide/object.html) including computed properties and methods. You can also use arrays, Map and Set.
-
-Warning: With current implementation you also need to wrap your component to `observer`. It's also possible to have `useObserver` only in case you are not expecting rerender of the whole component.
-
-```tsx
-import { observer, useObservable, useObserver } from "mobx-react-lite"
-
-const TodoList = () => {
-    const todos = useObservable(new Map<string, boolean>())
-    const todoRef = React.useRef()
-    const addTodo = React.useCallback(() => {
-        todos.set(todoRef.current.value, false)
-        todoRef.current.value = ""
-    }, [])
-    const toggleTodo = React.useCallback((todo: string) => {
-        todos.set(todo, !todos.get(todo))
-    }, [])
-
-    return useObserver(() => (
-        <div>
-            {Array.from(todos).map(([todo, done]) => (
-                <div onClick={() => toggleTodo(todo)} key={todo}>
-                    {todo}
-                    {done ? " ✔" : " ⏲"}
-                </div>
-            ))}
-            <input ref={todoRef} />
-            <button onClick={addTodo}>Add todo</button>
-        </div>
-    ))
-}
-```
+### **`useAsObservableSource<T>(source: T): T`** _([user guide](https://mobx-react.js.org/state-outsourcing))_
 
-#### Lazy initialization
-
-Lazy initialization (similar to `React.useState`) is not available. In most cases your observable state should be a plain object which is cheap to create. With `useObserver` the component won't even rerender and state won't be recreated. In case you really want a more complex state or you need to use `observer`, it's very simple to use MobX directly.
-
-```tsx
-import { observer } from "mobx-react-lite"
-import { observable } from "mobx"
-import { useState } from "react"
-
-const WithComplexState = observer(() => {
-    const [complexState] = useState(() => observable(new HeavyState()))
-    if (complexState.loading) {
-        return <Loading />
-    }
-    return <div>{complexState.heavyName}</div>
-})
-```
-
-[![Edit TodoList](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/jzj48v2xry?module=%2Fsrc%2FTodoList.tsx)
-
-Note that if you want to track a single scalar value (string, number, boolean), you would need [a boxed value](https://mobx.js.org/refguide/boxed.html) which is not recognized by `useObservable`. However, we recommend to just `useState` instead which gives you almost same result (with slightly different API).
-
-### `useComputed(func: () => T, inputs: ReadonlyArray<any> = []): T`
-
-> **Use the `useLocalStore` instead** ([user guide](https://mobx-react.js.org/state-local))
-
-Another React hook that simplifies computational logic. It's just a tiny wrapper around [MobX computed](https://mobx.js.org/refguide/computed-decorator.html#-computed-expression-as-function) function that runs computation whenever observable values change. In conjuction with `observer` the component will rerender based on such a change.
-
-```tsx
-const Calculator = observer(({ hasExploded }: { hasExploded: boolean }) => {
-    const inputRef = React.useRef()
-    const inputs = useObservable([1, 3, 5])
-    const result = useComputed(
-        () => (hasExploded ? "💣" : inputs.reduce(multiply, 1) * Number(!hasExploded)),
-        [hasExploded]
-    )
-
-    return (
-        <div>
-            <input ref={inputRef} />
-            <button onClick={() => inputs.push(parseInt(inputRef.current.value) | 1)}>
-                Multiply
-            </button>
-            <div>
-                {inputs.join(" * ")} = {result}
-            </div>
-        </div>
-    )
-})
-```
-
-Notice that since the computation depends on non-observable value, it has to be passed as a second argument to `useComputed`. There is [React `useMemo`](https://reactjs.org/docs/hooks-reference.html#usememo) behind the scenes and all rules applies here as well except you don't need to specify dependency on observable values.
-
-[![Edit Calculator](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/jzj48v2xry?module=%2Fsrc%2FCalculator.tsx)
-
-### `useDisposable<D extends TDisposable>(disposerGenerator: () => D, inputs: ReadonlyArray<any> = []): D`
-
-> **Use the `React.useEffect` instead** ([user guide](https://mobx-react.js.org/recipes-effects))
-
-The disposable is any kind of function that returns another function to be called on a component unmount to clean up used resources. Use MobX related functions like [`reaction`](https://mobx.js.org/refguide/reaction.html), [`autorun`](https://mobx.js.org/refguide/autorun.html), [`when`](https://mobx.js.org/refguide/when.html), [`observe`](https://mobx.js.org/refguide/observe.html), or anything else that returns a disposer.
-Returns the generated disposer for early disposal.
-
-Example (TypeScript):
-
-```typescript
-import { reaction } from "mobx"
-import { observer, useComputed, useDisposable } from "mobx-react-lite"
-
-const Name = observer((props: { firstName: string; lastName: string }) => {
-    const fullName = useComputed(() => `${props.firstName} ${props.lastName}`, [
-        props.firstName,
-        props.lastName
-    ])
-
-    // when the name changes then send this info to the server
-    useDisposable(() =>
-        reaction(
-            () => fullName,
-            () => {
-                // send this to some server
-            }
-        )
-    )
-
-    // render phase
-    return `Your full name is ${props.firstName} ${props.lastName}`
-})
-```
+The useAsObservableSource hook can be used to turn any set of values into an observable object that has a stable reference (the same object is returned every time from the hook).

package.json

@@ -1,6 +1,6 @@
 {
   "name": "mobx-react-lite",
-  "version": "1.4.1",
+  "version": "2.0.0-alpha.2",
   "description": "Lightweight React bindings for MobX based on React 16.8 and Hooks",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -24,7 +24,8 @@
     "prebuild": "rimraf dist",
     "build": "yarn bundle",
     "bundle": "tsdx build --name mobxReactLite --format=cjs,esm,umd",
-    "prepublishOnly": "yarn build"
+    "prepublishOnly": "yarn build",
+    "dedup": "npx yarn-deduplicate -s fewer yarn.lock"
   },
   "author": "Daniel K.",
   "license": "MIT",
@@ -37,14 +38,14 @@
     "react": "^16.8.0"
   },
   "devDependencies": {
-    "@size-limit/preset-small-lib": "^2.1.1",
-    "@size-limit/time": "^2.1.1",
+    "@size-limit/preset-small-lib": "2.1.1",
+    "@size-limit/time": "2.1.1",
+    "@testing-library/jest-dom": "4.1.0",
     "@testing-library/react": "9.1.3",
     "@testing-library/react-hooks": "1.1.0",
-    "@testing-library/jest-dom": "4.1.0",
     "@types/jest": "24.0.18",
     "@types/node": "12.7.2",
-    "@types/react": "16.8.22",
+    "@types/react": "16.9.2",
     "@types/react-dom": "16.9.0",
     "coveralls": "3.0.6",
     "husky": "3.0.4",
@@ -54,9 +55,9 @@
     "lint-staged": "9.2.3",
     "mobx": "5.13.0",
     "prettier": "1.18.2",
-    "react": "16.8.6",
-    "react-dom": "16.8.6",
-    "react-test-renderer": "16.8.6",
+    "react": "16.9.0",
+    "react-dom": "16.9.0",
+    "react-test-renderer": "16.9.0",
     "rimraf": "3.0.0",
     "size-limit": "2.1.1",
     "ts-jest": "24.0.2",

src/index.ts

@@ -1,8 +1,5 @@
 import "./assertEnvironment"
 
-export { useObservable } from "./useObservable"
-export { useComputed } from "./useComputed"
-export { useDisposable } from "./useDisposable"
 export { isUsingStaticRendering, useStaticRendering } from "./staticRendering"
 export { observer, IObserverOptions } from "./observer"
 export { useObserver, ForceUpdateHook, IUseObserverOptions } from "./useObserver"

src/printDebugValue.ts

@@ -1,8 +1,5 @@
 import { getDependencyTree, Reaction } from "mobx"
 
-export function printDebugValue(v: React.MutableRefObject<Reaction | null>) {
-    if (!v.current) {
-        return "<unknown>"
-    }
-    return getDependencyTree(v.current)
+export function printDebugValue(v: Reaction) {
+    return getDependencyTree(v)
 }