formik中文文档

1、本文对Formik文档进行了归纳整理, https://formik.org/docs ,并结合源码,总结了学习心得,供大家参考
2、本文Formik版本:v2.x

一、简介:
1、什么是Formik:是由React组件和hooks组成,它内置了表单的state管理操作,无需我们在单独为表单建立state,同时使用了Context,能够让表单组件多层嵌套,不再需要我们一层层传递。

2、解决哪些问题:

  • 使值进入和脱离表单状态
  • 验证和错误消息
  • 处理表格提交

二、起步
1、安装

$ yarn add formik
或
$ npm install formik --save
或
<script src="https://unpkg.com/formik/dist/formik.umd.production.min.js"></script>

2、推荐的校验库 Yup
学习文档推荐:https://www.zhihu.com/search?type=content&q=Yup%20js
官方文档:https://github.com/jquense/yup

$ yarn add yup
或
$ npm install yup --save

3、可以结合第三方UI库一起使用

4、Formik提交流程
提交前:

  • 触摸所有字段。initialValues是必需的,应该始终指定。
  • 设置isSubmittingtrue
  • 增量submitCount+1

校验:

  • 设置isValidatingtrue
  • 运行所有字段级别的验证validate,并validationSchema异步深入地合并结果
  • 有没有错误?
    是:中止提交。设置 isValidatingfalse,设置为errors,设置isSubmittingfalse
    否:设置 isValidatingfalse,继续“提交”

提交:

  • 运行您的提交处理程序
  • 调用setSubmitting(false)

5、校验
https://formik.org/docs/guides/validation, 这里写的很详细,标明了何时会触发校验

三、组件用法
1、<Field />
as
input
select
textarea
有效的HTML元素名
React组件

children: 是个react组件, 接收这3个参数

  • field: 当前这个Field的 onChange, onBlur, name, and value 的一些属性和方法
  • form: 跟整个form有关的属性和方法,整个Formik包
  • meta: value, touched, error, and initialValue

component:接收一个组件,( { field, form, ...props }) => ()
innerRef:回调函数,接收一个DOM节点
name: 字段名称,name也可以接受类似lodash的点路径,例如:

social.facebook  相当于:social = {facebook}
friends[0].firstName  相当于:friends = [firstName]

权重:children > component > as

2、<FieldArray />
渲染子节点方法:

  • <FieldArray name="..." component>
  • <FieldArray name="..." render>
  • <FieldArray name="..." children>
<FieldArray
         name="friends"
         render={({ move, swap, push, insert, unshift, pop }) => (
           <Form>
               {/*... use these however you want */}
           </Form>
         )}
 />

push: (obj: any) => void: 向数组中添加一条
swap: (indexA: number, indexB: number) => void: 交换数组中的两个值
move: (from: number, to: number) => void: 移除某条至某处
insert: (index: number, value: any) => void: 在给定索引处插入一个元素到数组中
unshift: (value: any) => number: 在数组的开头添加一个元素并返回它的长度
remove<T>(index: number): T | undefined: 删除数组中的某条
pop<T>(): T | undefined: 从数组的末尾移除并返回值
replace: (index: number, value: any) => void: 将给定索引处的值替换到数组中

3、<ErrorMessage />
children?: ((message: string) => React.ReactNode)
component?: string | React.ComponentType<FieldProps>
name: string
render?: (error: string) => React.ReactNode

注意: 接受到的错误信息必须是string类型,其他类型会报错

4、<Form />
Form组件都干了啥?
1、在<form>标签基础上进行封装
2、接收Formik传下来的参数,把form标签自带的方法传进去

image.png

5、<FastField />
<FastField /><Field />用于大型表单(〜30多个字段)或字段具有非常昂贵的验证要求的优化版本。<FastField />具有与完全相同的API <Field>,但在shouldComponentUpdate()内部实现以阻止所有其他重新渲染,除非<FastField />Formik状态的的相关部分/片段进行了直接更新。如果您的表单中的<Field />与其他所有<Field />表单“无关” ,则可以使用<FastField />,它不依赖于顶级其他部分<Formik />的状态。

6、<Formik />

  • <Formik component>
  • <Formik children>
    每个渲染方法将传递相同的参数,Formik组件本身没干啥,是个壳子,用于渲染,传递useFormik的参数。排了一下渲染方法的权重:component > render > children > null
    image.png

    具体每个参数是干嘛的,详见:https://formik.org/docs/api/formik,英文看不懂的话,谷歌翻译一下吧~我会归类说明,细节还得看原文档。
image.png

四、hooks
1、useField

const [field, meta, helpers] = useField(propsOrFieldName);

2、useFormikContext

const formik = useFormikContext();
image.png

3、useFormik

const formik = useFormik();

五、方法:
1、connect
将传进来的组件,传个formik对象,共享formik里的属性和方法


image.png

六、Yup的优点缺点
优点:功能强大

缺点:
1、复用性不强,因为他是链式结构
2、一坨,没有json-schema看起来简单直接

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