CyanX 基于ReactHook的,针对函数式组件的极简、可扩展的状态管理器

CyanX

CyanX是一款基于ReactHook的,针对函数式组件的极简、可扩展的状态管理器

设计哲学——任何状态,无论在哪都应该简单快速地获得

特性

极简,1分钟上手,两行代码

无限层级叠加,告别组件之间复杂的传值

极低的内存消耗,数据按需加载,组件所需的状态值变化时,才会重新渲染

基于ReactHook,仅支持React函数式组件开发

兼容环境

现代浏览器和 IE11

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-nJfVhPqU-1597115354094)(README_files/1.png)]

安装

npm

$ npm install cyanx

yarn

$ yarn add cyanx

核心概念

Public Store(公用仓库)

存放多个组件均需使用的状态的仓库

存放的数据类型

值类型(基本类型):字符串(String)、数字(Number)、布尔(Boolean)、对空(Null)、未定义(Undefined)、Symbol

引用数据类型:对象(Object)、数组(Array)、函数(Function)

函数方法

withCyanxObserver(观察者)

观察指定的公用仓库&使用此公用仓库中状态的可观察组件,当公用仓库的某个状态值发生变化时,会重新渲染使用了此状态的可观察组件

withCyanxObserver(component, publicStoreName, publicStoreDefaultValues)是一个高阶组件HOC,有3个参数

参数名是否必填说明

component*必填需转化为观察者的组件

publicStoreName*必填需观察公用仓库的名称

publicStoreDefaultValues*必填公用仓库的默认值

withCyanxObservable(可观察的)

将组件转为可观察状态,并得到所需的公用仓库的状态(存于props中),当使用的公用仓库的状态值改变时,将自动重新渲染,并得到最新的公用仓库的状态

withCyanxObservable(component, publicStoreName, stateKeyArray)是一个高阶组件HOC,有3个参数

参数名是否必填说明

component*必填需转化为可观察的组件

publicStoreName*必填需引入的公用仓库的名称

stateKeyArray选填组件需引用的公用仓库中状态的Key名称,引入的state会直接存入可观察组件的props中

dispatch(调遣)

dispatch是一个函数function,用于改变公用仓库的状态

特征

每一个公用仓库都会有唯一一个dispatch函数

dispatch会存在可观察组件的props中,函数名为${公用仓库的名称}Dispatch;或可观察组件的props中的名为${公用仓库的名称}的对象。此中有dispatch的元素

例子:有一个公用仓库publicStore,可观察组件C观察了公用仓库publicStore;可观察组件C获取公用仓库publicStore的dispatch可以通过一下两种方式拿到:

props.publicStoreDispatch

||

props.publicStore.dispatch

dispatch改变状态的规则,同React中的setState()函数

实例

常量

// 公用仓库的名称constPublicStoreName='publicStore';// 公用仓库的名称,自己定义// 公用仓库默认值constpublicStoreDefaultValues={a:1,b:{},c:()=>{},}

设置观察者组件&需观察的公用仓库

import{withCyanxObserver}from'cyanx';// 引入观察者HOC// 观察者组件constComponentObserver=()=>{...return(<><ComponentObservable/></>)}exportdefaultwithCyanxObserver(ComponentObserver,PublicStoreName,publicStoreDefaultValues);

转化可观察组件&组件所需的公用仓库的状态

import{withCyanxObservable}from'cyanx';// 引入可观察的HOC// 观察者组件constComponentObservable=({a,b,c,publicStoreDispatch,...props})=>{...}||constComponentObservable=(props)=>{const{a,b,c,dispatch}=props.publicStore;}exportdefaultwithCyanxObservable(ComponentObservable,PublicStoreName,['a','b','c']);

注意事项

出于内存的考虑,建议观察者组件的下1级的子组件均转化成可观察组件

GitHub

https://github.com/Bholder/CyanX

License

MIT

Copyright © 2020-present, Bholder CY

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 211,265评论 6 490
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,078评论 2 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 156,852评论 0 347
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,408评论 1 283
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,445评论 5 384
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,772评论 1 290
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,921评论 3 406
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,688评论 0 266
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,130评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,467评论 2 325
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,617评论 1 340
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,276评论 4 329
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,882评论 3 312
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,740评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,967评论 1 265
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,315评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,486评论 2 348