forked from facebook/react
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Fix a doc. cloneWithProps clones a ReactElement.
- Loading branch information
Showing
2 changed files
with
7 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,23 +1,23 @@ | ||
--- | ||
id: clone-with-props | ||
title: Cloning Components | ||
title: Cloning ReactElement | ||
permalink: clone-with-props.html | ||
prev: test-utils.html | ||
next: update.html | ||
--- | ||
|
||
In rare situations a component may want to change the props of a component that it doesn't own (like changing the `className` of a component passed as `this.props.children`). Other times it may want to make multiple copies of a component passed to it. `cloneWithProps()` makes this possible. | ||
In rare situations a element may want to change the props of a element that it doesn't own (like changing the `className` of a element passed as `this.props.children`). Other times it may want to make multiple copies of a element passed to it. `cloneWithProps()` makes this possible. | ||
|
||
#### `ReactComponent React.addons.cloneWithProps(ReactComponent component, object? extraProps)` | ||
#### `ReactElement React.addons.cloneWithProps(ReactElement element, object? extraProps)` | ||
|
||
Do a shallow copy of `component` and merge any props provided by `extraProps`. The `className` and `style` props will be merged intelligently. | ||
Do a shallow copy of `element` and merge any props provided by `extraProps`. The `className` and `style` props will be merged intelligently. | ||
|
||
> Note: | ||
> | ||
> `cloneWithProps` does not transfer `key` to the cloned component. If you wish to preserve the key, add it to the `extraProps` object: | ||
> `cloneWithProps` does not transfer `key` to the cloned element. If you wish to preserve the key, add it to the `extraProps` object: | ||
> | ||
> ```js | ||
> var clonedComponent = cloneWithProps(originalComponent, { key : originalComponent.key }); | ||
> var clonedElement = cloneWithProps(originalElement, { key : originalElement.key }); | ||
> ``` | ||
> | ||
> `ref` is similarly not preserved. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters