redux-form 部分Api说明

reduxForm(config:Object)

一个装饰器,用于你的表单组件联接到Redux.可以通过一些参数来配置你的表单

Config Properties

IMPORTANT:所有的配置选项应该在“design time”(设计阶段)传递给reduxForm() 或者在运行阶段通过props传递给你的组件

Required(必需的)

form : String

这是你组件的name和key,它将加载在redux-form reducer下面

Optional(可选的)

enableReinitialize : boolean [optional]

当值为true时,表单的值会一直是initialValues的值。默认是false.

initialValues : Object<String, String> [optional]

values将在componentWillMount()初始化你的表单。这些值将与你的表单{field1:"value1",field2:"value1"}对应。

validate : (values:Object, props:Object) => errors:Object [optional]

一个同步验证函数,传入整个表单的values与props.如果你的验证需要返回{},如果验证失败,你需要返回验证的错误信息{field:<string,field2:<string>}

Props

以下所有的属性都是存在于redux-form装饰过的表单组件。其他部分props可以通过包裹组件传递

anyTouched : boolean

如果你触碰了任何fields anyTouched的值为true,否则为false

form : String

通过装饰器给表单的名字或通过属性给组件的名字(多个表单时候使用)

handleSubmit(eventOrSubmit) : Function

function,你可以这样使用<form onSubmit={handleSubmit}>or to <button onClick={handleSubmit}>.它可以验证数据,同步异步都行,如果表单有效,它将执行 this.props.onSubmit(data)data为表单的数据。
另外,你可以将你定义的onSubmit函数传递给handleSubmit它将代替属性中的onSubmit.例如<form onSubmit={handleSubmit(this.save.bind(this))}>如果你的onSubmit函数返回一个promise,submitting属性将被设置为trun直到promise变为resolve或reject.如果reject的是一个object像 new SubmissionError({field:"err"})那么submission errors将被添加到每一个field的error属性中就像异步验证错误一样。如果这个error没指定任何field,但是适用于整个表单。 you may pass that as if it were the error for a field called _error, and it will be given as the error prop.(这句有不是很明白什么意思)
handleSubmit的两种用法
1.传递一个函数来调用

<button onClick={handleSubmit(data => {
  // do something with data. validation will have been called at this point,
  // so you know the data is valid
})}>Submit</button>

2.给onSubmit属性传递一个函数

<MyDecoratedForm onSubmit={data => {
  // do something with data. validation will have been called at this point,
  // so you know the data is valid
}}/>

initialize(data:Object) : Function

初始化函数,用于初始化表单的值。dirty和pristine会由当前值与初始值对比来确定,这是一个绑定行为创造者,所以没有返回值

initialValues : Object

通过reduxForm的属性来初始值来初始化initalize表单数据

invalid : boolean

如果有验证的错误信息则为true, valid属性与之相反

pristine: boolean

如果表单数据与初始值相同则为true, dirty属性与之相反

reset() : Functionå

用初始值重设表单的数据,重置pristine。这是一个绑定行为创造者,所以没有返回值

submitting : boolean

不管你的表单是否提交,这是属性只在你的handleSubmit函数返回值是个promise时有效,它的值在此过程中为true直到你的promise返回一个resolve或reject

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

推荐阅读更多精彩内容