使用 ReactDOM.createPortal 重写组件

1054 字

5 分钟

使用 ReactDOM.createPortal 重写组件

2024-07-17

React

最近在做一个新项目，这个项目的有一个交互的规范是搜索条件默认是隐藏的然后点击一个过滤器 Icon，展示那些搜索条件，由于我们部门是后来加入的这个项目，在此基础上做一些定制开发，也要遵循这一规范，但是我看到已经有其他开发编写完成了这个组件，但是我认为这样编写的组件扩展性和可维护性比较差，因此我打算使用 ReactDOM.createPortal 重写这个组件。

组件预览#

原组件#

目前这个组件的使用方式，可以看到，实现这个组件需要引入两个组件，分别是 FilterIcon 和 FilterView ，其中 FilterIcon 是那个过滤器的 Icon 主要作用是点击展示隐藏搜索条件。

FilterView 主要是定义一些搜索条件，它这里将那些条件抽象了出来并传入 searchList 。

1
// 示例伪代码
2
import FilterIcon from "@/pages/LuZhiBI/components/FilterIcon/filterIcon";
3
import FilterView from "@/pages/LuZhiBI/components/FilterView";
4

5
const searchList: any[] = [
6
  {
7
    searchType: "string",
8
    searchComponentType: "input",
9
    placeHolder: "请输入指标名称",
10
    title: "指标名称",
11
    key: "indicatorName",
12
  },
13
  {
14
    searchType: "string",
15
    searchComponentType: "multipleSelect",
16
    placeHolder: "请选择指标类型",
17
    title: "指标类型",
18
    key: "indicatorType",
19
    options: options.classificationOfIndicatorsOptions,
20
    mode: "multiple",
21
    defaultValue: options.classificationOfIndicatorsOptions.map(item => item.value),
22
  },
23
  {
24
    searchType: "text",
25
    searchComponentType: "dateRangeTime",
26
    showTime: true,
27
    title: "创建时间",
28
    key: "createdAt",
29
  },
30
];
31

32
<div className={styles.container}>
33
  <div className={styles.headBox}>
34
    ...
35
    <div className={styles.searchBox}>
36
      ...
37
      <FilterIcon handleFilterClick={handleFilterClick} filterTitle="过滤器" />
38
      ...
39
    </div>
40
  </div>
41

42
  <FilterView ref={filterViewRef} searchList={searchList} finish={onFinish} defaultFormValue={defaultSearchInfo} />
43
</div>

从上可以看出，有几点不足之处

一个功能却需要引入两个组件配合
需要手动获取 FilterView ref，并使用 handleFilterClick 控制展示隐藏
searchList 定义复杂，并且不利于自定义的一些配置（需要修改原组件，在内部做一些业务适配，随着项目的不断迭代，组件内部会变得相当庞大，且难以维护，之前做的一个项目就出现了类似的问题），在定义searchList 时没有 typescript 提示，失去了使用它的意义。

新组件#

在打算写这个组件之前，我想到了 Vue 中的 **Teleport** 内置组件，它可以将组件内部的元素传送到目标 dom 节点位置，因此我在想是否 React 中有一个类似的装件，然后我就发现了**ReactDOM.createPortal**，它可以实现类似 Teleport 的功能。

详细解释#

ReactDOM.createPortal：该方法接受两个参数：第一个参数是渲染的子元素，第二个参数是目标 DOM 节点。

对于现在的需求，这个组件需要实现两部分，一个是固定的过滤器 Icon，另一个是需要被传送到目前位置的 children，最终实现代码如下。

1
import { type FC, useEffect, useState } from 'react';
2
import ReactDOM from 'react-dom';
3
import { Button, Tooltip } from 'antd';
4
import { FilterOutlined } from '@ant-design/icons';
5
import { motion } from 'framer-motion';
6

7
interface IProps {
8
  hoverTitle: string;
9
  nodeID: string;
10
  children?: React.ReactNode;
11
}
12

13
const FilterIcon: FC<IProps> = props => {
14
  const { hoverTitle = '过滤器', nodeID, children } = props;
15
  const [node, setNode] = useState<any>(null);
16
  const [height, setHeight] = useState<string | number>(0);
17
  const filterClick = () => {
18
    if (height === 0) {
19
      setHeight('auto');
20
    } else {
21
      setHeight(0);
22
    }
23
  };
24
  useEffect(() => {
25
    const targetNode = document.getElementById(nodeID);
26
    setNode(targetNode);
27
  }, [nodeID]);
28
  return (
29
    <>
30
      <Tooltip placement="bottom" title={hoverTitle}>
31
        <Button
32
          onClick={filterClick}
33
          icon={
34
            <FilterOutlined
35
              style={{
36
                fontSize: 16,
37
              }}
38
            />
39
          }
40
          type="text"
41
        ></Button>
42
      </Tooltip>
43
      {node &&
44
        ReactDOM.createPortal(
45
          <motion.div
46
            animate={{ height }}
47
            className="filter-conditions"
48
            style={{
49
              height: 0,
50
              overflow: 'hidden',
51
              width: '100%',
52
              backgroundColor: '#f5f5f5',
53
              borderRadius: 4,
54
              marginTop: 10,
55
              padding: '0 16px',
56
            }}
57
          >
58
            {children}
59
          </motion.div>,
60
          node,
61
        )}
62
    </>
63
  );
64
};
65
export default FilterIcon;

使用方式#

使用时只需要引入 Filter ，并在合适的位置建立一个空的 div 节点 <div id="filter-main" />，并指定节点 id，并将它传入给 Filter 组件即可，过滤条件则直接作为 children 写入 Filter 组件内部即可。

1
// 示例伪代码
2
import Filter from '@/pages/LuZhiBI/components/Filter';
3

4
<div className={styles.DatasetView}>
5
  <div className={styles.titleBox}>
6
    <div style={{ display: 'flex', justifyContent: 'space-between', alignItems: 'center' }}>
7
      <div className={styles.filterBox}>
8
        <Filter hoverTitle="过滤器" nodeID="filter-main">
9
          <Form
10
          name="filter"
11
          onFinish={onFinish}
12
          autoComplete="off"
13
          initialValues={{
14
            date: [],
15
            indicator: [''],
16
          }}
17
          >
18
            <Row gutter={16} style={{ marginTop: 16 }}>
19
              <Col span={8}>
20
                <Form.Item<FieldType>
21
                  label="日期"
22
                  name="date"
23
                  rules={[{ required: true, message: '请选择查询日期' }]}
24
                >
25
                  <RangePicker style={{ width: '100%' }} />
26
                </Form.Item>
27
              </Col>
28
              <Col span={8}>
29
                <Form.Item<FieldType>
30
                  label="指标"
31
                  name="indicator"
32
                  required
33
                  rules={[{
34
                    validator: (_rule, value) => {
35
                      if (!value && value !== '') {
36
                        return Promise.reject('请选择指标');
37
                      }
38
                      return Promise.resolve();
39
                    }
40
                  }]}
41
                >
42
                  <Select mode='multiple' options={indicatorOptions} />
43
                </Form.Item>
44
              </Col>
45
              <Col span={8}>
46
                <Flex justify="flex-end">
47
                  <Form.Item>
48
                    <Space size="small">
49
                      <Button htmlType="reset">
50
                        重置
51
                      </Button>
52
                      <Button type="primary" htmlType="submit">
53
                        查询
54
                      </Button>
55
                    </Space>
56
                  </Form.Item>
57
                </Flex>
58
              </Col>
59
            </Row>
60
          </Form>
61
        </Filter>
62
      </div>
63
    </div>
64
    <div id="filter-main" />
65
  </div>
66
</div>