@react-libraries/use-local-state

What is this

Simplify communication between React's child components

Table of contents

Interfaces link

• LocalState

Functions link

• mutateLocalState
• useLocalStateCreate
• useLocalSelector
• useLocalState

Samples link

• useLocalState
• useLocalSelector

Interface

LocalState<T>

Type for State control

Properties

• dispatches
• value

Functions

mutateLocalState

▸ Const mutateLocalState<T>(state, value): void

Write a value to state

mutateLocalState - Type parameters

| Name | Type | Description | | :--- | :---------------- | :--------------------------------- | | T | T = undefined | The type of value to use for state |

mutateLocalState - Parameters

| Name | Type | Description | | :------ | :----------------------------- | :-------------------------------------------- | | state | LocalState<T> | The type of value to use for state | | value | T | (value: T) => T | A value to set for state or a callback to set |

useLocalStateCreate

▸ Const useLocalStateCreate<T>(value?): LocalState<T>

Create a state

useLocalStateCreate - Type parameters

| Name | Description | | :--- | :--------------------------------- | | T | The type of value to use for state |

useLocalStateCreate - Parameters

| Name | Type | Description | | :------- | :--------------- | :------------ | | value? | T | () => T | Initial value |

useLocalStateCreate - Returns

LocalState<T>

Instances of state

useLocalSelector

▸ Const useLocalSelector<T, K>(state, callback): K

Select and retrieve the value of state

export

useLocalSelector - Type parameters

| Name | Description | | :--- | :--------------------------------- | | T | The type of value to use for state | | K | Type of the selected value |

useLocalSelector - Parameters

| Name | Type | Description | | :--------- | :----------------------------- | :---------------------------------- | | state | LocalState<T> | The type of value to use for state | | callback | (value: T) => K | callbak to select the target state. |

useLocalSelector - Returns

K

{K} Selected state

useLocalState

▸ Const useLocalState<T>(state): [T, (value: T | (value: T) => T) => void]

Perform the same action as useState

export

useLocalState - Type parameters

| Name | Type | Description | | :--- | :---------------- | :--------------------------------- | | T | T = undefined | The type of value to use for state |

useLocalState - Parameters

| Name | Type | Description | | :------ | :----------------------------- | :--------------------------------- | | state | LocalState<T> | The type of value to use for state |

useLocalState - Returns

[T, (value: T | (value: T) => T) => void]

useLocallReducer

▸ Const useLocallReducer<T>(state,reducer): ((action: K) => void)

Reducer to manipulate the state.

useLocallReducer - Type parameters

| Name | Type | Description | | :--- | :--- | :--------------------------------- | | T | T | The type of value to use for state | | K | K | Action function |

useLocallReducer - Parameters

| Name | Type | Description | | :-------- | :----------------------------- | :--------------------------------- | | state | LocalState<T> | The type of value to use for state | | reducer | (state: T, action: K) => <T> | Reducer |

useLocallReducer - Returns

(action: K) => void

Samples

Sample(useLocalState)

import React from 'react';
import {
  useLocalStateCreate,
  LocalState,
  useLocalState,
  mutateLocalState,
} from '@react-libraries/use-local-state';

const Component1 = ({ localState }: { localState: LocalState<number> }) => {
  const [value, setValue] = useLocalState(localState);
  console.log('Component1(send)');
  return (
    <div>
      <div>Component1</div>
      <div>{value}</div>
      <button onClick={() => setValue(value + 1)}>BUTTON</button>
    </div>
  );
};
const Component2 = ({ localState }: { localState: LocalState<number> }) => {
  const [value, setValue] = useLocalState(localState);
  console.log('Component2(send)');
  return (
    <div>
      <div>Component2</div>
      <div>{value}</div>
      <button onClick={() => setValue(value + 1)}>BUTTON</button>
    </div>
  );
};
const Component3 = ({ localState }: { localState: LocalState<number> }) => {
  console.log('Component3(recv)');
  return (
    <div>
      <div>Component3</div>
      <button onClick={() => mutateLocalState(localState, (v) => v + 1)}>BUTTON</button>
    </div>
  );
};
const App = () => {
  const localState = useLocalStateCreate(0);
  console.log('Parent');
  return (
    <>
      <div>Parent</div>
      <Component1 localState={localState} />
      <Component2 localState={localState} />
      <Component3 localState={localState} />
    </>
  );
};

export default App;

Sample(useLocalSelector)

import React, { VFC } from 'react';
import {
  useLocalStateCreate,
  LocalState,
  useLocalState,
  mutateLocalState,
  useLocalSelector,
} from '@react-libraries/use-local-state';

interface LocalStateType {
  tall: number;
  weight: number;
}
interface ChildProps {
  localState: LocalState<LocalStateType>;
}

export const Tall: VFC<ChildProps> = ({ localState }) => {
  console.log('Tall');
  const tall = useLocalSelector(localState, (v) => v.tall);
  return (
    <div>
      Tall:
      <input
        value={tall}
        onChange={(e) => {
          mutateLocalState(localState, (v) => ({ ...v, tall: Number(e.target.value) }));
        }}
      />
    </div>
  );
};
export const Weight: VFC<ChildProps> = ({ localState }) => {
  console.log('Weight');
  const weight = useLocalSelector(localState, (v) => v.weight);
  return (
    <div style={{ display: 'flex' }}>
      Weight:
      <input
        value={weight}
        onChange={(e) => {
          mutateLocalState(localState, (v) => ({ ...v, weight: Number(e.target.value) }));
        }}
      />
    </div>
  );
};

export const Bmi: VFC<ChildProps> = ({ localState }) => {
  console.log('Bmi');
  const [{ tall, weight }] = useLocalState(localState);
  return (
    <div>
      {isNaN(Number(tall)) || isNaN(Number(weight))
        ? 'Error'
        : `BMI:${Math.floor((Number(weight) / Math.pow(Number(tall) / 100, 2)) * 100) / 100}`}
    </div>
  );
};

const App = () => {
  const localState = useLocalStateCreate<LocalStateType>({ tall: 170, weight: 60 });
  console.log('Parent');
  return (
    <>
      <Bmi localState={localState} />
      <Tall localState={localState} />
      <Weight localState={localState} />
    </>
  );
};

export default App;

Sample(useLocalReducer)

import React, { VFC } from 'react';
import {
  LocalState,
  useLocalSelector,
  useLocalStateCreate,
  useLocallReducer,
} from '@react-libraries/use-local-state';

interface LocalStateType {
  tall: number;
  weight: number;
}
interface ChildProps {
  state: LocalState<LocalStateType>;
}

const reducer = (
  state: LocalStateType,
  { type, payload: { value } }: { type: 'SET_TALL' | 'SET_WEIGHT'; payload: { value: number } }
) => {
  switch (type) {
    case 'SET_TALL':
      return { ...state, tall: value };
    case 'SET_WEIGHT':
      return { ...state, weight: value };
  }
};

export const Tall: VFC<ChildProps> = ({ state }) => {
  console.log('Tall');
  const tall = useLocalSelector(state, (v) => v.tall);
  const dispatch = useLocallReducer(state, reducer);
  return (
    <div>
      Tall:
      <input
        value={tall}
        onChange={(e) => {
          dispatch({ type: 'SET_TALL', payload: { value: Number(e.target.value) } });
        }}
      />
    </div>
  );
};
export const Weight: VFC<ChildProps> = ({ state }) => {
  console.log('Weight');
  const weight = useLocalSelector(state, (v) => v.weight);
  const dispatch = useLocallReducer(state, reducer);
  return (
    <div style={{ display: 'flex' }}>
      Weight:
      <input
        value={weight}
        onChange={(e) => {
          dispatch({ type: 'SET_WEIGHT', payload: { value: Number(e.target.value) } });
        }}
      />
    </div>
  );
};

export const Bmi: VFC<ChildProps> = ({ state }) => {
  console.log('Bmi');
  const { tall, weight } = useLocalSelector(state, (v) => v);
  return (
    <div>
      {isNaN(Number(tall)) || isNaN(Number(weight))
        ? 'Error'
        : `BMI:${Math.floor((Number(weight) / Math.pow(Number(tall) / 100, 2)) * 100) / 100}`}
    </div>
  );
};

const App = () => {
  const state = useLocalStateCreate<LocalStateType>(() => ({ tall: 170, weight: 60 }));
  console.log('Parent');
  return (
    <>
      <Bmi state={state} />
      <Tall state={state} />
      <Weight state={state} />
    </>
  );
};

export default App;