Add note about key prop being excluded by cloneWithProps

Whilst this is intentional behaviour (see #1274), it is not documented anywhere, so it is worth mentioning.

It would also be nice if React issued a warning to console if a cloned component loses its key (as this will silently break reconciliation?)
This commit is contained in:
Nick Williams
2014-07-18 16:14:55 +01:00
parent f3a9487619
commit f8bcc2e333

View File

@@ -12,3 +12,9 @@ In rare situations a component may want to change the props of a component that
#### `ReactComponent React.addons.cloneWithProps(ReactComponent component, object? extraProps)`
Do a shallow copy of `component` and merge any props provided by `extraProps`. Props are merged in the same manner as [`transferPropsTo()`](/react/docs/component-api.html#transferpropsto), so props like `className` will be merged intelligently.
**NOTE:** `cloneWithProps` does not transfer the `key` prop to the cloned component. If you wish to preserve the key, add it to the `extraProps` object:
```js
var clonedComponent = cloneWithProps(originalComponent, { key : originalComponent.props.key });
```