0.10.0 • Published 6 months ago

use-immer v0.10.0

Weekly downloads
37,503
License
MIT
Repository
github
Last release
6 months ago

use-immer

A hook to use immer as a React hook to manipulate state.

Installation

npm install immer use-immer

API

useImmer

useImmer(initialState) is very similar to useState. The function returns a tuple, the first value of the tuple is the current state, the second is the updater function, which accepts an immer producer function or a value as argument.

Managing state with immer producer function

When passing a function to the updater, the draft argument can be mutated freely, until the producer ends and the changes will be made immutable and become the next state.

Example: https://codesandbox.io/s/l97yrzw8ol

import React from "react";
import { useImmer } from "use-immer";


function App() {
  const [person, updatePerson] = useImmer({
    name: "Michel",
    age: 33
  });

  function updateName(name) {
    updatePerson(draft => {
      draft.name = name;
    });
  }

  function becomeOlder() {
    updatePerson(draft => {
      draft.age++;
    });
  }

  return (
    <div className="App">
      <h1>
        Hello {person.name} ({person.age})
      </h1>
      <input
        onChange={e => {
          updateName(e.target.value);
        }}
        value={person.name}
      />
      <br />
      <button onClick={becomeOlder}>Older</button>
    </div>
  );
}

(obviously, immer is a little overkill for this example)

Managing state as simple useState hook

When passing a value to the updater instead of a function, useImmer hook behaves the same as useState hook and updates the state with that value.

import React from 'react';
import { useImmer } from 'use-immer';

function BirthDayCelebrator(){
  const [age, setAge] = useImmer(20);

  function birthDay(event){
    setAge(age + 1);
    alert(`Happy birthday #${age} Anon! hope you good`);
  }

  return(
    <div>
      <button onClick={birthDay}>It is my birthday</button>
    </div>
  );
}

Obviously if you have to deal with immutability it is better option passing a function to the updater instead of a direct value.

useImmerReducer

Immer powered reducer, based on useReducer hook

Example: https://codesandbox.io/s/2zor1monvp

import React from "react";
import { useImmerReducer } from "use-immer";

const initialState = { count: 0 };

function reducer(draft, action) {
  switch (action.type) {
    case "reset":
      return initialState;
    case "increment":
      return void draft.count++;
    case "decrement":
      return void draft.count--;
  }
}

function Counter() {
  const [state, dispatch] = useImmerReducer(reducer, initialState);
  return (
    <>
      Count: {state.count}
      <button onClick={() => dispatch({ type: "reset" })}>Reset</button>
      <button onClick={() => dispatch({ type: "increment" })}>+</button>
      <button onClick={() => dispatch({ type: "decrement" })}>-</button>
    </>
  );
}
@lwtears/admin-common@tokdaniel/superfluid-widgetbootflex2react-use-huskyreact-use-mahozaro-webocr-front@apraamcos/apra-amcos-uicra-template-notum-material-uireact-bootstrap-extensionsreact-bootstrap-extensionapra-amcos-uilewis-todo-coponents@doublethinkio/spoon@lanaco/lanaco-react-libraryjlmc@heights/heights-uiedisen-ui@infinitebrahmanuniverse/nolb-use-i@a1740942002/widgetcontainer-data-analyticscompanyon-form-builder@pixiebrix/extensionjgu-zac-appsfo-test2react-tagilize@everything-registry/sub-chunk-3026companyon-formbuilder@voytenkodev/pagination-react-ts@novin/salerator-componentstarvantc-site-buildertc-site-builder-betatest-deposit-widgetwjtkwebpack5-appwhistle.modifysa-fe-starter-templatescaffoldr-reactsalerator-componentsrice-drip-formrn-hjri-calendarreact_multiple_select_with_chipssdx-inputsendtime_clientserenity-controlstheseboysvisual-interface-pojectcds-support-chatbot@groupos/smart-accounts@wechange/frontend-coreefuicomponentsmegahelpersmobin-tagmobin-tagilizehepai-authhy-design-mobileisigningsdkinttelligentlewis-todo-componentslei-hooksmtmaiadminmtmaiwebmui-toastifymovie_widgetkaleem-utilsgs-notebookhs-test-1huse-copy-methodsinciduntquikana-widgetjupyterlab-model-cardlcflow-material-antdmoon-hooksnaksha-component-react-restructurednaksha-component-react-restructured-2lzh_admin_vitelq-designlumu-editor-corelumu-tableouraioem-librarypbl-create-libreact-context-helperreact-auth-hookreact-dnd-antd-form-builderreact-cismapreact-cismap-experimentalqvdomgqvdomgreact-entity-component-systemreact-encompass-ecsreact-create-storereact-reportreact-simple-json-rendererreact-scaled-contentnative-ui-rn-pickerrandom-dummy-package-test1sentinel-desktopreact-native-toolbeltreact-native-image-select
0.10.0

6 months ago

0.9.0

2 years ago

0.8.1

2 years ago

0.8.0

2 years ago

0.7.0

3 years ago

0.6.0

3 years ago

0.5.2

4 years ago

0.5.0

4 years ago

0.5.1

4 years ago

0.4.2

4 years ago

0.4.1

4 years ago

0.4.0

5 years ago

0.3.5

5 years ago

0.3.4

5 years ago

0.3.3

5 years ago

0.3.2

6 years ago

0.3.1

6 years ago

0.3.0

6 years ago

0.2.2

6 years ago

0.2.1

6 years ago

0.2.0

6 years ago

0.1.0

6 years ago

0.0.5

6 years ago

0.0.4

6 years ago

0.0.3

6 years ago

0.0.2

6 years ago

0.0.1

6 years ago