ReactJS - 向组件添加自定义事件侦听器

IT技术 reactjs
2021-04-07 01:36:29

在普通的旧 HTML 中，我有 DIV

<div class="movie" id="my_movie">

和以下javascript代码

var myMovie = document.getElementById('my_movie');
myMovie.addEventListener('nv-enter', function (event) {
     console.log('change scope');
});

现在我有一个 React 组件，在这个组件内部，在 render 方法中，我正在返回我的 div。如何为我的自定义事件添加事件侦听器？（我将此库用于电视应用程序 -导航）

import React, { Component } from 'react';

class MovieItem extends Component {

  render() {

    if(this.props.index === 0) {
      return (
        <div aria-nv-el aria-nv-el-current className="menu_item nv-default">
            <div className="indicator selected"></div>
            <div className="category">
                <span className="title">{this.props.movieItem.caption.toUpperCase()}</span>
            </div>
        </div>
      );
    }
    else {
      return (
        <div aria-nv-el className="menu_item nv-default">
            <div className="indicator selected"></div>
            <div className="category">
                <span className="title">{this.props.movieItem.caption.toUpperCase()}</span>
            </div>
        </div>
      );
    }
  }

}

export default MovieItem;

更新 #1：

在此处输入图片说明

我应用了答案中提供的所有想法。我将导航库设置为调试模式，并且我只能根据键盘在我的菜单项上导航（如您在屏幕截图中看到的那样，我能够导航到电影 4）但是当我聚焦菜单中的一个项目时或按 Enter，我在控制台中没有看到任何内容。

import React, { Component } from 'react';
import ReactDOM from 'react-dom';

class MenuItem extends Component {

  constructor(props) {
    super(props);
    // Pre-bind your event handler, or define it as a fat arrow in ES7/TS
    this.handleNVFocus = this.handleNVFocus.bind(this);
    this.handleNVEnter = this.handleNVEnter.bind(this);
    this.handleNVRight = this.handleNVRight.bind(this);
  }

  handleNVFocus = event => {
      console.log('Focused: ' + this.props.menuItem.caption.toUpperCase());
  }

  handleNVEnter = event => {
      console.log('Enter: ' + this.props.menuItem.caption.toUpperCase());
  }

  handleNVRight = event => {
      console.log('Right: ' + this.props.menuItem.caption.toUpperCase());
  }

  componentDidMount() {
    ReactDOM.findDOMNode(this).addEventListener('nv-focus', this.handleNVFocus);
    ReactDOM.findDOMNode(this).addEventListener('nv-enter', this.handleNVEnter);
    ReactDOM.findDOMNode(this).addEventListener('nv-right', this.handleNVEnter);
    //this.refs.nv.addEventListener('nv-focus', this.handleNVFocus);
    //this.refs.nv.addEventListener('nv-enter', this.handleNVEnter);
    //this.refs.nv.addEventListener('nv-right', this.handleNVEnter);
  }

  componentWillUnmount() {
    ReactDOM.findDOMNode(this).removeEventListener('nv-focus', this.handleNVFocus);
    ReactDOM.findDOMNode(this).removeEventListener('nv-enter', this.handleNVEnter);
    ReactDOM.findDOMNode(this).removeEventListener('nv-right', this.handleNVRight);
    //this.refs.nv.removeEventListener('nv-focus', this.handleNVFocus);
    //this.refs.nv.removeEventListener('nv-enter', this.handleNVEnter);
    //this.refs.nv.removeEventListener('nv-right', this.handleNVEnter);
  }

  render() {
    var attrs = this.props.index === 0 ? {"aria-nv-el-current": true} : {};
    return (
      <div ref="nv" aria-nv-el {...attrs} className="menu_item nv-default">
          <div className="indicator selected"></div>
          <div className="category">
              <span className="title">{this.props.menuItem.caption.toUpperCase()}</span>
          </div>
      </div>
    )
  }

}

export default MenuItem;

我留下了一些注释行，因为在这两种情况下我都无法记录控制台行。

更新 #2：这个导航库不能很好地与带有原始 Html 标签的 React 一起使用，所以我必须设置选项并重命名标签以使用 aria-* 以便它不会影响 React。

navigation.setOption('prefix','aria-nv-el');
navigation.setOption('attrScope','aria-nv-scope');
navigation.setOption('attrScopeFOV','aria-nv-scope-fov');
navigation.setOption('attrScopeCurrent','aria-nv-scope-current');
navigation.setOption('attrElement','aria-nv-el');
navigation.setOption('attrElementFOV','aria-nv-el-fov');
navigation.setOption('attrElementCurrent','aria-nv-el-current');
4个回答

如果您需要处理 React 尚未提供的 DOM 事件，则必须在安装组件后添加 DOM 侦听器：

更新：在 React 13、14 和 15 之间，对影响我的答案的 API 进行了更改。下面是使用 React 15 和 ES7 的最新方法。查看旧版本的回答历史。

class MovieItem extends React.Component {

  componentDidMount() {
    // When the component is mounted, add your DOM listener to the "nv" elem.
    // (The "nv" elem is assigned in the render function.)
    this.nv.addEventListener("nv-enter", this.handleNvEnter);
  }

  componentWillUnmount() {
    // Make sure to remove the DOM listener when the component is unmounted.
    this.nv.removeEventListener("nv-enter", this.handleNvEnter);
  }

  // Use a class arrow function (ES7) for the handler. In ES6 you could bind()
  // a handler in the constructor.
  handleNvEnter = (event) => {
    console.log("Nv Enter:", event);
  }

  render() {
    // Here we render a single <div> and toggle the "aria-nv-el-current" attribute
    // using the attribute spread operator. This way only a single <div>
    // is ever mounted and we don't have to worry about adding/removing
    // a DOM listener every time the current index changes. The attrs 
    // are "spread" onto the <div> in the render function: {...attrs}
    const attrs = this.props.index === 0 ? {"aria-nv-el-current": true} : {};

    // Finally, render the div using a "ref" callback which assigns the mounted 
    // elem to a class property "nv" used to add the DOM listener to.
    return (
      <div ref={elem => this.nv = elem} aria-nv-el {...attrs} className="menu_item nv-default">
        ...
      </div>
    );
  }

}

Codepen.io 上的示例

你在滥用findDOMNode. 在你的情况下var elem = this.refs.nv;就足够了。
2021-06-03 01:36:29
@Pavlo 嗯，你是对的，这似乎在 v.14 中发生了变化（返回 DOM 元素而不是 v.13 中的 React 元素，这就是我正在使用的）。谢谢。
2021-06-09 01:36:29
@NicolasS.Xu React 不提供任何自定义事件调度 API，因为您应该使用回调道具（请参阅此答案），但nv.dispatchEvent()如果需要，您可以使用标准 DOM 。
2021-06-15 01:36:29
为什么我需要“确保在卸载组件时删除 DOM 侦听器”？是否有任何来源会造成泄漏？
2021-06-18 01:36:29
@levininja 单击edited Aug 19 at 6:19帖子下方的文本，您将转到修订历史记录。
2021-06-18 01:36:29

您可以使用componentDidMount和componentWillUnmount方法：

import React, { Component } from 'react';
import ReactDOM from 'react-dom';

class MovieItem extends Component
{
    _handleNVEvent = event => {
        ...
    };

    componentDidMount() {
        ReactDOM.findDOMNode(this).addEventListener('nv-event', this._handleNVEvent);
    }

    componentWillUnmount() {
        ReactDOM.findDOMNode(this).removeEventListener('nv-event', this._handleNVEvent);
    }

    [...]

}

export default MovieItem;
嗨@vbarbarosh，我用更多细节更新了问题
2021-05-23 01:36:29

首先，自定义事件在原生 React 组件中表现不佳。所以你不能只<div onMyCustomEvent={something}>在渲染函数中说，而必须考虑问题。

其次，在查看您正在使用的库的文档后，该事件实际上是在 上触发的document.body，因此即使它确实有效，您的事件处理程序也永远不会触发。

相反，在componentDidMount应用程序的某个地方，您可以通过添加来收听 nv-enter

document.body.addEventListener('nv-enter', function (event) {
    // logic
});

然后，在回调函数中，点击一个改变组件状态的函数，或者你想做的任何事情。

您能否详细说明“自定义事件与 React 组件本身无法很好地配合”的原因？
2021-05-29 01:36:29
@codeful.element，这个网站有一些信息：custom-elements-everywhere.com/#react
2021-06-04 01:36:29

我建议使用React.createRef()和ref=this.elementRef来获取 DOM 元素引用而不是ReactDOM.findDOMNode(this). 通过这种方式，您可以获得对 DOM 元素的引用作为实例变量。

import React, { Component } from 'react';
import ReactDOM from 'react-dom';

class MenuItem extends Component {

  constructor(props) {
    super(props);

    this.elementRef = React.createRef();
  }

  handleNVFocus = event => {
      console.log('Focused: ' + this.props.menuItem.caption.toUpperCase());
  }
    
  componentDidMount() {
    this.elementRef.addEventListener('nv-focus', this.handleNVFocus);
  }

  componentWillUnmount() {
    this.elementRef.removeEventListener('nv-focus', this.handleNVFocus);
  }

  render() {
    return (
      <element ref={this.elementRef} />
    )
  }

}

export default MenuItem;
其它你可能感兴趣的问题
上一篇无法加载脚本。请确保您正在运行 Metro 服务器或您的包“index.android.bundle”已正确打包以供发布 下一篇使用异步 componentDidMount() 好吗？