Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

context-state

Package Overview
Dependencies
Maintainers
1
Versions
25
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

context-state

React state management library

  • 1.1.3
  • unpublished
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
63
increased by57.5%
Maintainers
1
Weekly downloads
 
Created
Source

context-state

简单、优雅的 React hooks 状态管理方案

CI CI CI CI

  • React Hooks 适用于 React Hooks 组件
  • 专注性能 减少额外 rerender,运行畅快
  • 无依赖 仅仅使用了 React,无第三方库的依赖
  • 简单 只需会 React Hooks,即可上手
  • TypeScript 编写 完备的类型提示,轻松编写代码
  • 容易集成 可渐进式引入,与其他状态管理共存
  • 通用 组件、模块、应用以及服务端渲染
  • 灵活 基于 Context,轻松组合 Provider
  • 轻松迁移 它基于自定义 Hooks 创建

安装

yarn add context-state

介绍

React Context 和 useContext 存在一些性能问题,当 context 上下文改变时,所有使用到 context 的组件都会更新渲染。 context-state 为解决性能问题而生。

v1.1.0 之前,它使用 calculateChangedBits 来阻止context更新,但这个 API 将会被 React 废弃。

v1.1.0 之后,将不再依赖 calculateChangedBits

Example

import React from 'react';
import { createContainer, useMemoizedFn } from 'context-state';

function useCounter() {
  const [count, setCount] = React.useState(0);
  const increment = useMemoizedFn(() => setCount((c) => c + 1));

  return {
    count,
    increment,
  };
}

const CounterContainer = createContainer(useCounter);

function CounterDisplay() {
  const { count, increment } = CounterContainer.usePicker(['count', 'increment']);

  return (
    <div>
      {count}
      <button type="button" onClick={increment}>
        ADD
      </button>
    </div>
  );
}

function App() {
  return (
    <CounterContainer.Provider>
      <CounterDisplay />
    </CounterContainer.Provider>
  );
}

render(<App />, document.getElementById('root'));

API

createContainer(useHook)

import { createContainer, useMemoizedFn } from 'context-state';

function useCustomHook() {
  const [value, setInput] = useState();
  const onChange = useMemoizedFn((e) => setValue(e.currentTarget.value));
  return {
    value,
    onChange,
  };
}

const Container = createContainer(useCustomHook);
// Container === { Provider, usePicker }

<Container.Provider>

function ParentComponent() {
  return (
    <Container.Provider>
      <ChildComponent />
    </Container.Provider>
  );
}

<Container.Provider initialState>

function useCustomHook(initialState = '') {
  const [value, setValue] = useState(initialState);
  // ...
}

function ParentComponent() {
  return (
    <Container.Provider initialState="value">
      <ChildComponent />
    </Container.Provider>
  );
}

Container.useSelector()

监听当前容器中选择后的值,若值发生改变,则触发 rerender

function ChildComponent() {
  const value = Container.useSelector((state) => state.value);
  return <span>{value}</span>;
}

Container.usePicker()

useSelector 的语法糖,更常用的写法

function ChildComponent() {
  const { value } = Container.usePicker(['value']);
  return <span>{value}</span>;
}

Container.withPicker()

usePicker 的高阶组件形式

function ChildComponent({ value }) {
  return <span>{value}</span>;
}

Container.withPicker(ChildComponent, ['value']);

useContextUpdate()

context 更新时执行钩子。 此方法在会在 concurrent模式 中生效

import { useContextUpdate } from 'context-state';

const update = useContextUpdate();
update(() => setState(...));

useMemoizedFn

持久化 functionHook。(来自 ahooksuseMemoizedFn

你可能会需要用 useCallback 记住一个回调,但由于内部函数必须经常重新创建,记忆效果不佳,导致子组件重复 render。对于复杂的子组件,重新渲染会对性能造成影响。通过 useMemoizedFn,可以保证函数地址永远不会变化。

Keywords

FAQs

Package last updated on 27 Dec 2021

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc