Keyed Fragments

In most cases, you can use the key prop to specify keys on the elements you’re returning from render. However, this breaks down in one situation: if you have two sets of children that you need to reorder, there’s no way to put a key on each set without adding a wrapper element.

That is, if you have a component such as:

  1. var Swapper = React.createClass({
  2.   propTypes: {
  3.     // `leftChildren` and `rightChildren` can be a string, element, array, etc.
  4.     leftChildren: React.PropTypes.node,
  5.     rightChildren: React.PropTypes.node,
  7.     swapped: React.PropTypes.bool
  8.   },
  9.   render: function() {
  10.     var children;
  11.     if (this.props.swapped) {
  12.       children = [this.props.rightChildren, this.props.leftChildren];
  13.     } else {
  14.       children = [this.props.leftChildren, this.props.rightChildren];
  15.     }
  16.     return <div>{children}</div>;
  17.   }
  18. });

The children will unmount and remount as you change the swapped prop because there aren’t any keys marked on the two sets of children.

To solve this problem, you can use the createFragment add-on to give keys to the sets of children.

Array<ReactNode> createFragment(object children)

Instead of creating arrays, we write:

  1. var createFragment = require('react-addons-create-fragment');
  3. if (this.props.swapped) {
  4.   children = createFragment({
  5.     right: this.props.rightChildren,
  6.     left: this.props.leftChildren
  7.   });
  8. } else {
  9.   children = createFragment({
  10.     left: this.props.leftChildren,
  11.     right: this.props.rightChildren
  12.   });
  13. }

The keys of the passed object (that is, left and right) are used as keys for the entire set of children, and the order of the object’s keys is used to determine the order of the rendered children. With this change, the two sets of children will be properly reordered in the DOM without unmounting.

The return value of createFragment should be treated as an opaque object; you can use the React.Children helpers to loop through a fragment but should not access it directly. Note also that we’re relying on the JavaScript engine preserving object enumeration order here, which is not guaranteed by the spec but is implemented by all major browsers and VMs for objects with non-numeric keys.

Note:

In the future, createFragment may be replaced by an API such as

  1. return (
  2.   <div>
  3.     <x:frag key="right">{this.props.rightChildren}</x:frag>,
  4.     <x:frag key="left">{this.props.leftChildren}</x:frag>
  5.   </div>
  6. );

allowing you to assign keys directly in JSX without adding wrapper elements.