react antd自定义表单组件详解

先看下 antd 官网自定义(第三方)表单组件的写法:

import { Form, Input, Select, Button } from 'antd';

const { Option } = Select;

class PriceInput extends React.Component {
  static getDerivedStateFromProps(nextProps) {
    // Should be a controlled component.
    if ('value' in nextProps) {
      return {
        ...(nextProps.value || {}),
      };
    }
    return null;
  }

  constructor(props) {
    super(props);

    const value = props.value || {};
    this.state = {
      number: value.number || 0,
      currency: value.currency || 'rmb',
    };
  }

  handleNumberChange = e => {
    const number = parseInt(e.target.value || 0, 10);
    if (isNaN(number)) {
      return;
    }
    if (!('value' in this.props)) {
      this.setState({ number });
    }
    this.triggerChange({ number });
  };

  handleCurrencyChange = currency => {
    if (!('value' in this.props)) {
      this.setState({ currency });
    }
    this.triggerChange({ currency });
  };

  triggerChange = changedValue => {
    // Should provide an event to pass value to Form.
    const { onChange } = this.props;
    if (onChange) {
      onChange({
        ...this.state,
        ...changedValue,
      });
    }
  };

  render() {
    const { size } = this.props;
    const { currency, number } = this.state;
    return (
      <span>
        <Input
          type="text"
          size={size}
          value={number}
          onChange={this.handleNumberChange}
          style={{ width: '65%', marginRight: '3%' }}
        />
        <Select
          value={currency}
          size={size}
          style={{ width: '32%' }}
          onChange={this.handleCurrencyChange}
        >
          <Option value="rmb">RMB</Option>
          <Option value="dollar">Dollar</Option>
        </Select>
      </span>
    );
  }
}

官方示例中有个函数需要引起我们的注意 getDerivedStateFromProps
这个函数的意思就是吧props中传入的参数注入到state中。
这个函数中的代码块的意思是当props中有value时,往state中注入nextProps.value,如果没有则返回null,不往state中注入数据。

当我们更改了数据时,需要往组件外传递修改后的值,一般就是通过onChange回调来做。所以,有一个在这个示例中有一个triggerChange 函数专门来处理这个事情。这里也是判断如果有这个回调函数就调用onChange
不过,为什么数据变化的时候会需要先有下面的操作呢?

 if (!('value' in this.props)) {
      this.setState({ currency });
    }

我觉得是为了防止重复渲染
因为setState会触发视图渲染,而只要props中有value就会在getDerivedStateFromProps 中执行一次state的变化。而onChange回调会改变propsvalue的值,因此如果不做这个判断就会导致重复渲染了。

下面给个我自己写的示例:
先看需求

未勾选状态
勾选状态
/**
 * 统计维度自定义表单组件
 *
 */

import React from 'react';
import { Checkbox, Row, Col, Select } from 'antd';
import RaMulitCheckSelect from '@/components/RaMulitCheckSelect';
// 这些都是定义的数据格式类型,不用在意
import { SelectOption, DimensionValue, DimensionValueMap, DimensionMap } from '@/utils/interfaces';
import styles from './dimensionInput.less';

// 维度输入组件的state
interface DimensionInputState {
  dimensionValueMap: DimensionValueMap;
}

// 维度输入组件的props
interface DimensionInputProps {
  value?: DimensionValueMap | undefined;
  options?: DimensionMap;
  onChange?: Function;
}

function getDimensionMapModel(): DimensionMap {
  return {
    组织: {
      label: '组织',
      value: '组织',
      options: [
        { label: '总部', value: '总部' },
        { label: '大区', value: '大区' },
        { label: '地区', value: '地区' },
        { label: '分部', value: '分部' },
        { label: '点部', value: '点部' },
      ],
    },
  };
}

// 初始化value
function initValue(
  dimensionValueMap: DimensionValueMap,
  options = getDimensionMapModel(),
): DimensionValueMap {
  Object.keys(options).forEach(key => {
    if (!dimensionValueMap[key]) {
      dimensionValueMap[key] = {
        checked: false,
        value: [],
      };
    }
  });
  return dimensionValueMap;
}

const { Option } = Select;

class DimensionInput extends React.PureComponent<DimensionInputProps, DimensionInputState, any> {
  static getDerivedStateFromProps(nextProps: DimensionInputProps) {
    if ('value' in nextProps) {
      // 如果props中有value则替代state中的dimensionValueMap
      return {
        dimensionValueMap: initValue(nextProps.value || {}, nextProps.options),
      };
    }
    return null;
  }

  constructor(props: DimensionInputProps) {
    super(props);
    const dimensionValueMap = props.value || {};
    // 初始化dimensionValueMap
    this.state = {
      dimensionValueMap: initValue(props.value || {}, props.options),
    };
  }

  // 这里也是一个自定义的组件 RaMulitCheckSelect 的value发生变化时的数据收集
  changeValue = (key: string, value: string) => {
    const valueList = (value || '').split(',').filter(v => !!v);
    const { dimensionValueMap } = this.state;
    this.triggerChange({ ...dimensionValueMap, [key]: { checked: true, value: valueList } });
  };

  // 当数据发生变化时
  triggerChange = (dimensionValueMap: DimensionValueMap) => {
    const { onChange } = this.props;
    if (!('value' in this.props)) {
      this.setState({ dimensionValueMap });
    }
    if (onChange) {
      onChange(dimensionValueMap);
    }
  };

  // 当勾选某一个维度时
  checkOptions = (event: any, key: string) => {
    const checked = event.target.checked;
    const { dimensionValueMap } = this.state;
    if (!dimensionValueMap[key]) dimensionValueMap[key] = { checked: false, value: [] };
    dimensionValueMap[key].checked = checked;
    if (!checked) dimensionValueMap[key].value = [];
    this.triggerChange({ ...dimensionValueMap });
  };

  render() {
    const { dimensionValueMap } = this.state;
    const { options = getDimensionMapModel() } = this.props;
    return (
      <div className={styles.dimensionInput}>
        {Object.keys(options).map((dimensionCode: string) => (
          <Row className={styles.dimensionInputItem} key={dimensionCode}>
            <Col span={5}>
              <Checkbox
                className="ra"
                checked={dimensionValueMap[dimensionCode].checked}
                onChange={event => this.checkOptions(event, options[dimensionCode].value)}
              >
                <span>{options[dimensionCode].label}</span>
              </Checkbox>
            </Col>
            <Col span={18} offset={1}>
              <RaMulitCheckSelect
                allowClear
                placeholder="勾选左侧多选框后才可选择内容"
                disabled={!(dimensionValueMap[dimensionCode] || { checked: false }).checked}
                value={
                  Array.isArray((dimensionValueMap[dimensionCode] || { value: [] }).value)
                    ? ((dimensionValueMap[dimensionCode] || { value: [] }).value || []).join(',')
                    : ''
                }
                dataSource={options[dimensionCode].options}
                onChange={(value: string) => this.changeValue(dimensionCode, value)}
              ></RaMulitCheckSelect>
            </Col>
          </Row>
        ))}
      </div>
    );
  }
}

export default DimensionInput;

最后要说明一下,这个自定义组件的方式会有一个小缺陷,当使用Form表单的getFieldDecorator时如果想另外使用onChange来监测自定义组件数据是否有变化时会与Form表单相冲突。所以,可以另外再定义一个回调,或者使用FormonValuesChange来处理

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

推荐阅读更多精彩内容