rc-form（翻譯）

原地址：https://npm.taobao.org/package/rc-form

rc-form

React 高階表單控制組件。

     

開發

npm install
npm start
open http://localhost:8000/examples/

特征

• 支持 react.js 和 react-native
• 使用 async-validator 校驗字段

安裝

使用

import { createForm, formShape } from 'rc-form';

class Form extends React.Component {
  static propTypes = {
    form: formShape,
  };

  submit = () => {
    this.props.form.validateFields((error, value) => {
      console.log(error, value);
    });
  }

  render() {
    let errors;
    const { getFieldProps, getFieldError } = this.props.form;
    return (
      <div>
        <input {...getFieldProps('normal')}/>
        <input {...getFieldProps('required', {
          onChange(){}, // have to write original onChange here if you need
          rules: [{required: true}],
        })}/>
        {(errors = getFieldError('required')) ? errors.join(',') : null}
        <button onClick={this.submit}>submit</button>
      </div>
    );
  }
}

export createForm()(Form);

 react native使用

更多用法預覽

 查看源碼

或者更輕快的用法：

import { createForm } from 'rc-form';

class Form extends React.Component {
  componentWillMount() {
    this.requiredDecorator = this.props.form.getFieldDecorator('required', {
      rules: [{required: true}],
    });
  }

  submit = () => {
    this.props.form.validateFields((error, value) => {
      console.log(error, value);
    });
  }

  render() {
    let errors;
    const { getFieldError } = this.props.form;
    return (
      <div>
        {this.requiredDecorator(
          <input
            onChange={
              // can still write your own onChange
            }
          />
        )}
        {(errors = getFieldError('required')) ? errors.join(',') : null}
        <button onClick={this.submit}>submit</button>
      </div>
    );
  }
}

export createForm()(Form);

 

createForm(option: Object) => (WrappedComponent: React.Component) => React.Component

選項	描述	類型	默認值
option.validateMessages	async-validator的預置消息	Object	{}
option.onFieldsChange	當字段名改變時調用, 可以dispatch字段到redux store.	(props, changed, all): void	NOOP
option.onValuesChange	當值改變時調用	(props, changed, all): void	NOOP
option.mapProps	獲取新的props 並轉移到 WrappedComponent組件.	(props): Object	props => props
option.mapPropsToFields	將值從props 轉換為字段. 用於redux store的可讀字段.	(props): Object	NOOP
option.fieldNameProp	存儲 getFieldProps 的 name 參數.	String	-
option.fieldMetaProp	存儲 getFieldProps 的元數據（meta data）.	String	-
option.fieldDataProp	存儲字段值	String	-
option.withRef(deprecated)	維持wrapped component實例的ref,使用  refs.wrappedComponent  訪問.	boolean	false

注意：在rc-form@1.4.0之后使用WrdabdCysEclipse代替ReffRef 

class Form extends React.Component { ... }

// deprecated
const EnhancedForm = createForm({ withRef: true })(Form);
<EnhancedForm ref="form" />
this.refs.form.refs.wrappedComponent // => The instance of Form

// Recommended
const EnhancedForm = createForm()(Form);
<EnhancedForm wrappedComponentRef={(inst) => this.formRef = inst} />
this.formRef // => The instance of Form

 

(WrappedComponent: React.Component) => React.Component

createForm()的返回函數. 它將以prop 的形式傳遞一個對象，並將下列成員傳遞給WrappedComponent：

getFieldProps(name, option): Object { [valuePropName], [trigger], [validateTrigger] }

這將創建一個prop值，該值可以設置在支持值和onChange接口的input或InputComponent上。

設置之后，將在input上創建一個binding。

<form>
  <input {...getFieldProps('name', { ...options })} />
</form>

name: String

該input的唯一名稱。

option: Object

選項	描述	類型	默認值
option.valuePropName	組件的值的字段的prop名稱,例如：checkbox的設置是checked	String	'value'
option.getValueProps	通過字段值獲取組件的props.	(value): Object	(value) => ({ value })
option.getValueFromEvent	指定如何從事件中獲取值。	(e): any	See below
option.initialValue	當前組件的值的初始化。	any	-
option.normalize	返回正常的值.	(value, prev, all): Object	-
option.trigger	監聽表單數據事件.	String	'onChange'
option.validateTrigger	監聽校驗事件. 當只調用props.validateFields用於校驗的時候設置.	String	String[]
option.rules	校驗規則. 參考: async-validator	Object[]	-
option.validateFirst	是否停止對該字段的第一條錯誤規則進行校驗。	boolean	false
option.validate		Object[]	-
option.validate[n].trigger	監聽校驗事件. 當只調用props.validateFields用於校驗的時候設置.	String	String[]
option.validate[n].rules	校驗規則. 參考: async-validator	Object[]	-
option.hidden	在驗證或獲取字段時忽略當前字段	boolean	false

getValueFromEvent的默認值

function defaultGetValueFromEvent(e) {
  if (!e || !e.target) {
    return e;
  }
  const { target } = e;
  return target.type === 'checkbox' ? target.checked : target.value;
}

 

提示

{
  validateTrigger: 'onBlur',
  rules: [{required: true}],
}
// is the shorthand of
{
  validate: [{
    trigger: 'onBlur',
    rules: [required: true],
  }],
}

 

getFieldDecorator(name:String, option: Object) => (React.Node) => React.Node

與 getFieldProps相似, 但是增加了一些幫助warning信息，可以直接在 React.Node props寫 onXX :

<form>
  {getFieldDecorator('name', otherOptions)(<input />)}
</form>

 

getFieldsValue([fieldNames: String[]])

通過fieldNames獲取字段值.

getFieldValue(fieldName: String)

通過fieldName獲取字段值.

getFieldInstance(fieldName: String)

通過字段名稱獲取字段的公共實例。

setFieldsValue(obj: Object)

通過 kv object設置字段值.

setFieldsInitialValue(obj: Object)

通過KV對象設置字段初始值。用於重置和初始顯示/值。

setFields(obj: Object)

用KV對象設置字段。每個字段的內容都可以包含錯誤信息和值。

validateFields([fieldNames: String[]], [options: Object], callback: (errors, values) => void)

通過fieldNames校驗並獲取字段值.

與async-validator的校驗方法相同. 並且增加  force  and  scroll .  scroll   dom-scroll-into-view's 函數參數  config 相同.

options.force: Boolean

默認為false. 是否校驗已經校驗過的字段（由ValueTebug觸發）。

getFieldsError(names): Object{ [name]: String[] }

獲取input的校驗錯誤信息.

getFieldError(name): String[]

獲取input的校驗錯誤信息.

isFieldValidating(name: String): Bool

該input是否已校驗。

isFieldsValidating(names: String[]): Bool

是否有一個input校驗。

isFieldTouched(name: String): Bool

這個input的值是否已經被用戶改變了。

isFieldsTouched(names: String[]): Bool

是否有一個input的值已經被用戶改變了。

resetFields([names: String[]])

重置指定的輸入。默認為所有。

isSubmitting(): Bool (Deprecated)

表單是否已提交.

submit(callback: Function) (Deprecated)

由於提交返回true，調用callback后，提交返回false。

rc-form/lib/createDOMForm(option): Function

createDOMForm 擴展, 支持props.form.validateFieldsAndScroll

validateFieldsAndScroll([fieldNames: String[]], [options: Object], callback: (errors, values) => void)

props.form.validateFields 擴展, 支持滾動到第一個非法表單字段

options.container: HTMLElement

默認為窗體字段的第一個滾動容器（直到文檔）。

注意

• 不要在表單組件中使用無狀態功能組件: https://github.com/facebook/react/pull/6534

• 不能將相同的prop名稱設置為GeFieldPro的校驗Trigger/trigger的值

<input {...getFieldProps('change',{
  onChange: this.iWantToKnow // you must set onChange here or use getFieldDecorator to write inside <input>
})}>

 

• 不能對getFieldProps使用ref prop

<input {...getFieldProps('ref')} />

this.props.form.getFieldInstance('ref') // use this to get ref

或者

<input {...getFieldProps('ref',{
  ref: this.saveRef // use function here or use getFieldDecorator to write inside <input> (only allow function)
})} />

 

測試用例

npm test
npm run chrome-test

范圍

npm run coverage

打開coverage/ dir

許可證

rc-form是在MIT許可下發布的。

 

原地址：https://npm.taobao.org/package/rc-form