在React Awesome Query Builder中实现Select组件自定义值功能

概述

React Awesome Query Builder是一个强大的查询构建器组件库，它提供了丰富的字段类型和操作符来构建复杂的查询条件。在实际开发中，我们经常需要让用户既可以从预定义列表中选择值，也可以输入自定义值。本文将详细介绍如何在Select组件中实现这一功能。

问题背景

在使用Ant Design的Select组件时，开发者希望实现以下功能：

1. 用户可以从预定义的选项列表中选择值
2. 用户也可以输入自定义的值
3. 支持使用"contains"等操作符进行过滤

解决方案

使用allowCustomValues属性

从React Awesome Query Builder 6.6.9版本开始，Select组件支持通过allowCustomValues属性来允许自定义值。这是最简单的实现方式：

actionType: {
  label: "Action Type",
  type: "select",
  valueSources: ["value"],
  fieldSettings: {
    listValues: [
      { value: "action1", title: "Action1" },
      { value: "action2", title: "Action2" },
      { value: "action3", title: "Action3" }
    ],
    allowCustomValues: true
  }
}

自定义Select组件实现

如果需要更复杂的自定义功能，可以完全自定义Select组件的实现。以下是一个完整的示例：

import { Select, Divider, Space, Input, Button } from 'antd';
import { PlusOutlined } from '@ant-design/icons';
import React, { useState, useRef } from 'react';

const CustomSelect = ({
  value,
  setValue,
  config,
  readonly,
  placeholder,
  customProps,
}) => {
  const [options, setOptions] = useState(config.settings.listValues || []);
  const [inputValue, setInputValue] = useState('');
  const inputRef = useRef(null);

  const handleChange = (newValue) => {
    setValue(newValue);
  };

  const handleInputChange = (e) => {
    setInputValue(e.target.value);
  };

  const handleAddOption = (e) => {
    e.preventDefault();
    if (inputValue && !options.some((option) => option.value === inputValue)) {
      const newOption = { value: inputValue, title: inputValue };
      setOptions((prevOptions) => [...prevOptions, newOption]);
      setInputValue('');
      setValue(inputValue);
      setTimeout(() => {
        inputRef.current?.focus();
      }, 0);
    }
  };

  return (
    <Select
      disabled={readonly}
      placeholder={placeholder}
      value={value}
      onChange={handleChange}
      style={{ width: 300 }}
      showSearch
      dropdownRender={(menu) => (
        <>
          {menu}
          <Divider style={{ margin: "8px 0" }} />
          <Space style={{ padding: "0 8px 4px" }}>
            <Input
              placeholder="请输入自定义值"
              ref={inputRef}
              value={inputValue}
              onChange={handleInputChange}
              onKeyDown={(e) => e.stopPropagation()}
            />
            <Button
              type="text"
              icon={<PlusOutlined />}
              onClick={handleAddOption}
            >
              添加
            </Button>
          </Space>
        </>
      )}
    >
      {options.map(({ value, title }) => (
        <Select.Option key={value} value={value}>
          {title}
        </Select.Option>
      ))}
    </Select>
  );
};

实现原理

1. 状态管理：使用React的useState管理选项列表和输入框的值
2. 自定义渲染：通过Select的dropdownRender属性自定义下拉菜单，添加输入框和按钮
3. 添加选项：当用户点击添加按钮时，将输入框的值添加到选项列表中
4. 值同步：通过onChange事件将选择的值同步到Query Builder

注意事项

1. 确保使用最新版本的React Awesome Query Builder（6.6.9+）
2. 自定义组件时要注意性能优化，避免不必要的渲染
3. 对于大型选项列表，考虑实现虚拟滚动
4. 添加输入验证逻辑，防止无效值被添加

总结

在React Awesome Query Builder中实现Select组件的自定义值功能有两种主要方式：使用内置的allowCustomValues属性或完全自定义Select组件。前者简单易用，后者灵活强大。开发者可以根据项目需求选择合适的方式。通过这种功能，可以大大提升用户体验，使查询构建更加灵活高效。