带有响应选择作为弹出式自定义单元格编辑器的ag-grid中的键盘事件问题

Question

我想使用react-select作为ag-grid的自定义单元格编辑器

这是代码沙箱链接

您可以在此处下载源代码

npm install
npm start

我已经删除了所有的css，因此看起来很普通，但是仍然可以完成工作。

这是我的package.json

{
  "name": "Test",
  "version": "1.5.0",
  "private": true,
  "dependencies": {
    "react": "16.8.1",
    "react-dom": "16.8.1",
    "react-select": "^2.4.1",
    "react-scripts": "2.1.5",
    "ag-grid-community": "20.1.0",
    "ag-grid-react": "20.1.0"
  },
  "scripts": {
    "start": "react-scripts start",
    "build": "react-scripts build",
    "test": "react-scripts test --env=jsdom",
    "eject": "react-scripts eject",
    "deploy": "npm run build",
    "lint:check": "eslint . --ext=js,jsx;  exit 0",
    "lint:fix": "eslint . --ext=js,jsx --fix;  exit 0",
    "install:clean": "rm -rf node_modules/ && rm -rf package-lock.json && npm install && npm start"
  },
  "optionalDependencies": {
    "@types/googlemaps": "3.30.16",
    "@types/markerclustererplus": "2.1.33",
    "ajv": "6.9.1",
    "prettier": "1.16.4"
  },
  "devDependencies": {
    "eslint-config-prettier": "4.0.0",
    "eslint-plugin-prettier": "3.0.1"
  },
  "browserslist": [
    ">0.2%",
    "not dead",
    "not ie <= 11",
    "not op_mini all"
  ]
}

index.js

import React from "react";
import ReactDOM from "react-dom";
import Grid from './app/AgGrid'

const colDefs = [
    {
        headerName              : "Test",
        field                   : "test",       
        editor                  : "manyToOne",
        editable                : true,
        suppressKeyboardEvent   : function suppressEnter(params) {
            let KEY_ENTER = 13;
            let KEY_LEFT = 37;
            let KEY_UP = 38;
            let KEY_RIGHT = 39;
            let KEY_DOWN = 40;
            var event = params.event;
            var key = event.which;
            var editingKeys = [KEY_LEFT, KEY_RIGHT, KEY_UP, KEY_DOWN, KEY_ENTER];
            var suppress = params.editing && editingKeys.indexOf(key) >= 0;
            console.log("suppress "+suppress);
            return suppress;
        },
        cellEditor              : "reactSelectCellEditor",
    },
]

ReactDOM.render(
<Grid
    readOnly={false}
    field={null}
    columnDefs={colDefs}
    editable={true}
    editingMode={null}
    rowData={[]}
/>
,
document.getElementById("root")
);

AgGrid.js

import React, { Component } from 'react'
import { AgGridReact } from 'ag-grid-react'
import 'ag-grid-community/dist/styles/ag-grid.css'
import ReactSelectCellEditor from './ReactSelectCellEditor'

class Grid extends Component {

    constructor(props) {
        super(props);
        this.state = {
            columnDefs  : props.columnDefs,
            rowData     : [],
            isFormOpen  : false,
            editedData  : {
                data        : [],
                rowIndex    : null,
                columns     : []
            },
            frameworkComponents:{
                'reactSelectCellEditor': ReactSelectCellEditor,
            },
        }
    }

    updateRowData = (newData,index) => {
        var unsavedData = this.state.rowData.map((row,i)=>{
            if (i === index) {
                return newData
            }
            else{
                return row
            }
        })
        this.setState({rowData:unsavedData})
    }

    onGridReady = params => {       
    }

    createData = () => {
        let fields = this.state.columnDefs.map(column=>{
            return column.field
        })
        let newData = {}
        fields.map(field=>{
            if (field !== "id") {
                newData[field] = ""
            }           
        })
        newData["delete"] = false
        this.setState({rowData:[...this.state.rowData,newData]})
    }

    toggleModal = () => {
        this.setState({isFormOpen:!this.state.isFormOpen})
    }

    setEditedData = (data) => {
        console.log("editedData",data)
        this.setState({editedData:data})
    }


    render() {
        var defaultColDef = {
            editable:this.state.editable,
            sortable:false
        }

        var initColDefs = this.state.columnDefs.map(colDef=>{
            return {
                ...colDef,
                cellEditorParams:{
                    ...colDef.cellEditorParams,
                }
            }
        })

        var renderedColumnDefs = []
        if (this.props.editingMode === "inline") {
            renderedColumnDefs = [
                ...initColDefs
            ]
        }
        else if (this.props.readOnly) {
            renderedColumnDefs = [...initColDefs]
        }
        else{
            defaultColDef = {
                editable:false,
                sortable:false
            }
            renderedColumnDefs = [
                ...initColDefs,
            ]
        }
        var renderedRowData = []
        this.state.rowData.map(row=>{
            if (row.delete !== true) {
                renderedRowData.push(row)
            }
        })
        return (
            <React.Fragment>
                <AgGridReact
                    defaultColDef                   = {defaultColDef}
                    columnDefs                      = {renderedColumnDefs}
                    rowData                         = {renderedRowData}
                    onGridReady                     = {this.onGridReady}
                    onCellValueChanged              = {this.handleChange}
                    frameworkComponents             = {this.state.frameworkComponents}
                    singleClickEdit                 = {true}
                    stopEditingWhenGridLosesFocus   = {true}
                    reactNext={true}
                />
                <div className="addButton" style={{padding:'5px', border: '1px solid black'}} onClick={()=>this.createData()}>Add</div>
            </React.Fragment>
        );
    } 
}

export default Grid

还有ReactSelectCellEditor.js

import React, { Component } from 'react'
import CreatableSelect  from "react-select/lib/Creatable"
import { components } from 'react-select'
import ReactDOM from 'react-dom'

const colourOptions = [
    { value: 'red', label: 'Red' },
    { value: 'blue', label: 'Blue' },
    { value: 'yellow', label: 'Yellow' }
]

class ReactSelectCellEditor extends Component {

    constructor(props) {
        super(props);
        this.state = {
            value : null
        }
        this.handleChange = this.handleChange.bind(this)
    }

    componentDidMount() {
    }

    handleCreateOption = (inputValue:any) => {
    }

    handleChange(selected){
        this.setState({
            value : selected.value
        })
    }

    afterGuiAttached(param) {
        let self = this;
        this.Ref.addEventListener('keydown', function (event) {
            // let key = event.which || event.keyCode
            // if (key === 37 || key === 38 || key === 39 || key === 40 || key === 13) {
            //     event.stopPropagation();
            //     console.log("onKeyDown "+key);
            // }
        });
        this.SelectRef.focus()
    }

    formatCreate = (inputValue) => {
        return (<p> Add: {inputValue}</p>); 
    };

    isPopup(){
        return true
    }

    getValue() {
        return this.state.value
    }

    render() {
        return (
            <div ref = { ref => { this.Ref = ref }} style={{width: '200px'}}> 
                <CreatableSelect
                    onChange                = {this.handleChange}
                    options                 = {colourOptions}
                    formatCreateLabel       = {this.formatCreate}
                    createOptionPosition    = {"first"}
                    ref                     = { ref => { this.SelectRef = ref }}
                />
            </div>
        );
    }
}

export default ReactSelectCellEditor

如您所见，ag-grid和弹出窗口（不在单元格中）之间的一个简单的裸骨组合实现react-select。

它的工作正常，除了默认的ag-grid导航键事件阻碍了select-select正常工作之外。

现在，我已经在编辑时键盘导航的ag-grid文档中阅读了有关此问题的解决方案

这是东西：

1. 首先，我尝试了解决方案1，该方法是停止自定义单元格编辑器的事件传播。它可以工作，但是奇怪的是，尽管我停止了事件在react-select 容器中冒泡，而不是在react-select本身中冒泡，正如从ReactSelectCellEditor.js中注释掉的脚本中可以看到的那样，以某种方式，React Select Key Event也停止执行。我不知道为什么当我停止在父元素中传播事件时，作为div子元素的react select事件停止执行。难道不是应该把事件从孩子带到父母吗？因此，第一个解决方案是不可行。

2. 至于第二种解决方案，一个奇怪的是ag-grid本身。如文档所述，ag-grid通过定义列定义中的preventKeyboardEvent函数，允许我们拦截键事件。如果未弹出编辑模式，则可以使用。但就我而言，我使用弹出模式，在弹出模式下，我发现在编辑时未触发preventKeyboardEvent，甚至根本没有调用它。

现在我陷入僵局。在第一种解决方案中，react-select行为异常，而在第二种解决方案中，ag-grid行为异常。我该如何解决？

附加发现

在互联网上搜索后，React Select似乎使用了SyntheticKeyboardEvent它，如果我没记错的话，执行AFTER事件已经经历了整个DOM树的第一个捕获/冒泡周期。因此，如果我停止传播，SyntheticKeyboardEvent则不会触发。但是，如果我不停止使用本机事件侦听器的传播ag-grid，则会触发其默认导航功能并杀死react-select组件。现在适合我吗？死胡同？

Answer 1

让我警告你这个解决方案是一种黑客和反模式。正如您所说，react select 使用 SyntheticKeyboardEvent 并且它会等待，直到本机事件经历整个 DOM 树的循环。但是有一种方法可以让您通过修改代码来调用 React select 功能，这将允许您从其他组件访问 React select 组件的方法，这就是为什么这是一个反模式解决方案。

1. suppressKeyboardEvent从 colDef 中删除

2. CreatableSelect从 node_modules/react-select/src/Creatable.js复制组件

3. 将这些行添加到复制的组件中以通过 onRef 进行访问

   componentDidMount() {
      this.props.onRef(this)
   }
   componentWillUnmount() {
      this.props.onRef(undefined)
   }
   

4. 通过在副本中定义这些来传递react select的控制方法

   focusOption(param) {
      this.select.focusOption(param);
   }
   selectOption(param) {
      this.select.selectOption(param);
   }
   

5. 然后当你渲染组件时添加onRef = { ref => { this.SelectRef = ref }}

6. 现在，您将能够在停止传播之前调用这些来模拟控制

   this.SelectRef.focusOption('up');
   this.SelectRef.focusOption('down');
   

7. 您可以通过编写这样的方法来访问反应选择的状态

   focusedOption() {
      return this.select.state.focusedOption;
   }
   

8. 参考node_modules/react-select/src/Select.js第1142行完成剩下的模拟