3.Refs and the DOM

React版本:15.4.2
**翻译:xiyoki **

在典型的React数据流中,props是父组件与其children交互的唯一方式。要修改child,你需使用新的props重新渲染父组件。但是,在一些情况下,你需要在典型的数据流之外强制修改child。要修改的child可以是React组件的实例,也可以是DOM元素。对于这两种情况,React提供了一个 escape hatch(安全舱口; 逃口)。

When to Use Refs

几个好的refs使用案例:

  • 管理焦点、文本选择框或媒体重放。
  • 触发命令式动画。
  • 与第三方DOM库集成。

避免在可声明的事物上使用refs。
例如,不在Dialog组件上暴露open()close()方法,而是向它传递isOpen属性。

Adding a Ref to a DOM Element

React支持你附加一个特殊的属性到任何组件。该ref属性接收一个回调函数作为参数,在组件被mounted或unmounted后,该回调就被立即执行。
当在HTML元素上使用ref属性时,ref回调接收基础DOM元素作为参数。例如,此代码使用ref回调来储存对DOM节点的引用:

class CustomTextInput extends React.Component {
  constructor(props) {
    super(props);
    this.focus = this.focus.bind(this);
  }

  focus() {
    // Explicitly focus the text input using the raw DOM API
    this.textInput.focus();
  }

  render() {
    // Use the `ref` callback to store a reference to the text input DOM
    // element in an instance field (for example, this.textInput).
    return (
      <div>
        <input
          type="text"
          ref={(input) => { this.textInput = input; }} />
        <input
          type="button"
          value="Focus the text input"
          onClick={this.focus}
        />
      </div>
    );
  }
}

当组件mounts时,React会调用ref回调,并向其传入DOM元素。当组件unmounts时,React会调用ref回调,并向其传入null。
使用ref回调为类设置一个属性,是访问DOM元素的常见模式。首选方法是在ref回调中设置属性,就像上面的例子。甚至有一个简便的书写方式:ref={input => this.textInput = input}

Adding a Ref to a Class Component

ref属性被用在自定义类组件上时,ref回调接收已mounted的组件实例作为参数。例如,如果我们想在CustomTextInput上包裹一圈,模拟组件mounting后,它直接被点击:

class AutoFocusTextInput extends React.Component {
  componentDidMount() {
    this.textInput.focus();
  }

  render() {
    return (
      <CustomTextInput
        ref={(input) => { this.textInput = input; }} />
    );
  }
}

注意,只有CustomTextInput被声明为类时才有效:

class CustomTextInput extends React.Component {
  // ...
}

Refs and Functional Components

你不能(在引用功能组件时)在功能组件上使用ref属性,因为功能组件没有实例:

function MyFunctionalComponent() {
  return <input />;
}

class Parent extends React.Component {
  render() {
    // This will *not* work!
    return (
      <MyFunctionalComponent
        ref={(input) => { this.textInput = input; }} />
    );
  }
}

如果你需要一个ref,你应该将组件转换为一个类,就像你需要声明周期方法或状态时一样。
但你可以在功能组件内部使用ref属性,只要是涉及DOM元素或类组件:

function CustomTextInput(props) {
  // textInput must be declared here so the ref callback can refer to it
  let textInput = null;

  function handleClick() {
    textInput.focus();
  }

  return (
    <div>
      <input
        type="text"
        ref={(input) => { textInput = input; }} />
      <input
        type="button"
        value="Focus the text input"
        onClick={handleClick}
      />
    </div>
  );  
}

Don't Overuse Refs(不要过度使用Refs)

你使用refs的第一个倾向可能是让事情在你的应用程序中发生。如果是这种情况,请花一点时间,着重考虑状态应该在组件层次结构的什么位置。通常,拥有该状态的适当位置在组件层次结构中的层级更高。

Legacy API: String Refs(旧版API:字符串Refs)

如果你之前使用过React,你可能会熟悉一个较旧的API,其中ref属性是一个字符串,如像"textInput",DOM节点被这样访问this.refs.textInput。我们建议不这样使用。因为字符串引用有一些被认为是遗留的问题,并且可能在未来的一个版本中被删除。如果你目前正在使用this.refs.textInput访问refs,我们建议你使用回调模式。

Caveats(注意)

如果ref回调被定义为内联函数,它将在更新期间被调用两次,第一次调用传入null,第二次调用传入DOM 元素。这是因为函数的新实例是通过每次渲染创建的,因此React需要清除旧的引用并设置新的引用。你可以通过将ref回调定义为类上的绑定方法来避免这种情况,但请注意,在大多数情况下它不重要。

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

推荐阅读更多精彩内容

  • 深入JSX date:20170412笔记原文其实JSX是React.createElement(componen...
    gaoer1938阅读 8,055评论 2 35
  • It's a common pattern in React to wrap a component in an ...
    jplyue阅读 3,262评论 0 2
  • 以下内容是我在学习和研究React时,对React的特性、重点和注意事项的提取、精练和总结,可以做为React特性...
    科研者阅读 8,224评论 2 21
  • 转载自:前端外刊评论-知乎专栏——《深入 React 技术栈》章节试读 《深入 React 技术栈》尽管并不是一本...
    晓松阅读 3,838评论 0 10
  • 黑衣,黑裤,三儿走在山林里不起眼的小路上。烟花三月,阳光正好。 突兀的,在树林交错中看不真切,但那炊烟确实实实在在...
    割晓阅读 306评论 0 1