Browse Source

Replace transferPropsTo with transferring props patterns

main
Sebastian Markbage 10 years ago
committed by Paul O’Shannessy
parent
commit
4202fcd9c5
  1. 2
      docs/02.2-jsx-spread.md
  2. 2
      docs/05-reusable-components.md
  3. 159
      docs/06-transferring-props.md
  4. 2
      docs/07-forms.md
  5. 0
      docs/08-working-with-the-browser.md
  6. 0
      docs/08.1-more-about-refs.md
  7. 0
      docs/09-tooling-integration.md
  8. 0
      docs/10-addons.md
  9. 0
      docs/10.1-animation.md
  10. 0
      docs/10.2-form-input-binding-sugar.md
  11. 0
      docs/10.3-class-name-manipulation.md
  12. 0
      docs/10.4-test-utils.md
  13. 0
      docs/10.5-clone-with-props.md
  14. 0
      docs/10.6-update.md
  15. 0
      docs/10.7-pure-render-mixin.md
  16. 0
      docs/10.8-perf.md
  17. 27
      docs/ref-02-component-api.md

2
docs/02.2-jsx-spread.md

@ -68,4 +68,4 @@ Merging two objects can be expressed as:
> Note:
>
> Activate experimental syntax by using the [JSX command-line tool](http://npmjs.org/package/react-tools) with the `--harmony` flag.
> Use the [JSX command-line tool](http://npmjs.org/package/react-tools) with the `--harmony` flag to activate the experimental ES7 syntax.

2
docs/05-reusable-components.md

@ -3,7 +3,7 @@ id: reusable-components
title: Reusable Components
permalink: reusable-components.html
prev: multiple-components.html
next: forms.html
next: transferring-props.html
---
When designing interfaces, break down the common design elements (buttons, form fields, layout components, etc) into reusable components with well-defined interfaces. That way, the next time you need to build some UI you can write much less code, which means faster development time, fewer bugs, and fewer bytes down the wire.

159
docs/06-transferring-props.md

@ -0,0 +1,159 @@
---
id: transferring-props
title: Transferring Props
permalink: transferring-props.html
prev: reusable-components.html
next: forms.html
---
It's a common pattern in React to wrap a component in an abstraction. The outer component exposes a simple property to do something that might have more complex implementation details.
You can use [JSX spread attributes](/react/docs/jsx-spread.html) to merge the old props with additional values:
```javascript
return <Component {...this.props} more="values" />;
```
If you don't use JSX, you can use any object helper such as ES6 `Object.assign` or Underscore `_.extend`:
```javascript
return Component(Object.assign({}, this.props, { more: 'values' }));
```
The rest of this tutorial explains best practices. It uses JSX and experimental ES7 syntax.
## Manual Transfer
Most of the time you should explicitly pass the properties down. That ensures that you only exposes a subset of the inner API, one that you know will work.
```javascript
var FancyCheckbox = React.createClass({
render: function() {
var fancyClass = this.props.checked ? 'FancyChecked' : 'FancyUnchecked';
return (
<div className={fancyClass} onClick={this.props.onClick}>
{this.props.children}
</div>
);
}
});
React.renderComponent(
<FancyCheckbox checked={true} onClick={console.log}>
Hello world!
</FancyCheckbox>,
document.body
);
```
But what about the `name` prop? Or the `title` prop? Or `onMouseOver`?
## Transferring with `...` in JSX
Sometimes it's fragile and tedious to pass every property along. In that case you can use [destructuring assignment](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Destructuring_assignment) with rest properties to extract a set of unknown properties.
List out all the properties that you would like to consume, followed by `...other`.
```javascript
var { checked, ...other } = this.props;
```
This ensures that you pass down all the props EXCEPT the ones you're consuming yourself.
```javascript
var FancyCheckbox = React.createClass({
render: function() {
var { checked, ...other } = this.props;
var fancyClass = checked ? 'FancyChecked' : 'FancyUnchecked';
// `other` contains { onClick: console.log } but not the checked property
return (
<div {...other} className={fancyClass} />
);
}
});
React.renderComponent(
<FancyCheckbox checked={true} onClick={console.log}>
Hello world!
</FancyCheckbox>,
document.body
);
```
> NOTE:
>
> In the example above, the `checked` prop is also a valid DOM attribute. If you didn't use destructuring in this way you might inadvertently pass it along.
Always use the destructuring pattern when transferring unknown `other` props.
```javascript
var FancyCheckbox = React.createClass({
render: function() {
var fancyClass = this.props.checked ? 'FancyChecked' : 'FancyUnchecked';
// ANTI-PATTERN: `checked` would be passed down to the inner component
return (
<div {...this.props} className={fancyClass} />
);
}
});
```
## Consuming and Transferring the Same Prop
If your component wants to consume a property but also pass it along, you can repass it explicitly `checked={checked}`. This is preferable to passing the full `this.props` object since it's easier to refactor and lint.
```javascript
var FancyCheckbox = React.createClass({
render: function() {
var { checked, title, ...other } = this.props;
var fancyClass = checked ? 'FancyChecked' : 'FancyUnchecked';
var fancyTitle = checked ? 'X ' + title : 'O ' + title;
return (
<label>
<input {...other}
checked={checked}
className={fancyClass}
type="checkbox"
/>
{fancyTitle}
</label>
);
}
});
```
> NOTE:
>
> Order matters. By putting the `{...other}` before your JSX props you ensure that the consumer of your component can't override them. In the example above we have guaranteed that the input will be of type `"checkbox"`.
## Rest and Spread Properties `...`
Rest properties allow you to extract the remaining properties from an object into a new object. It excludes every other property listed in the destructuring pattern.
This is an experimental implementation of an [ES7 proposal](https://github.com/sebmarkbage/ecmascript-rest-spread).
```javascript
var { x, y, ...z } = { x: 1, y: 2, a: 3, b: 4 };
x; // 1
y; // 2
z; // { a: 3, b: 4 }
```
> Note:
>
> Use the [JSX command-line tool](http://npmjs.org/package/react-tools) with the `--harmony` flag to activate the experimental ES7 syntax.
## Transferring with Underscore
If you don't use JSX, you can use a library to achieve the same pattern. Underscore supports `_.omit` to filter out properties and `_.extend` to copy properties onto a new object.
```javascript
var FancyCheckbox = React.createClass({
render: function() {
var checked = this.props.checked;
var other = _.omit(this.props, 'checked');
var fancyClass = checked ? 'FancyChecked' : 'FancyUnchecked';
return (
React.DOM.div(_.extend({}, other, { className: fancyClass }))
);
}
});
```

2
docs/06-forms.md → docs/07-forms.md

@ -2,7 +2,7 @@
id: forms
title: Forms
permalink: forms.html
prev: reusable-components.html
prev: transferring-props.html
next: working-with-the-browser.html
---

0
docs/07-working-with-the-browser.md → docs/08-working-with-the-browser.md

0
docs/07.1-more-about-refs.md → docs/08.1-more-about-refs.md

0
docs/08-tooling-integration.md → docs/09-tooling-integration.md

0
docs/09-addons.md → docs/10-addons.md

0
docs/09.1-animation.md → docs/10.1-animation.md

0
docs/09.2-form-input-binding-sugar.md → docs/10.2-form-input-binding-sugar.md

0
docs/09.3-class-name-manipulation.md → docs/10.3-class-name-manipulation.md

0
docs/09.4-test-utils.md → docs/10.4-test-utils.md

0
docs/09.5-clone-with-props.md → docs/10.5-clone-with-props.md

0
docs/09.6-update.md → docs/10.6-update.md

0
docs/09.7-pure-render-mixin.md → docs/10.7-pure-render-mixin.md

0
docs/09.8-perf.md → docs/10.8-perf.md

27
docs/ref-02-component-api.md

@ -70,33 +70,6 @@ bool isMounted()
`isMounted()` returns true if the component is rendered into the DOM, false otherwise. You can use this method to guard asynchronous calls to `setState()` or `forceUpdate()`.
### transferPropsTo
```javascript
ReactComponent transferPropsTo(ReactComponent targetComponent)
```
Transfer properties from this component to a target component that have not already been set on the target component. After the props are updated, `targetComponent` is returned as a convenience. This function is useful when creating simple HTML-like components:
```javascript
var Avatar = React.createClass({
render: function() {
return this.transferPropsTo(
<img src={"/avatars/" + this.props.userId + ".png"} userId={null} />
);
}
});
// <Avatar userId={17} width={200} height={200} />
```
Properties that are specified directly on the target component instance (such as `src` and `userId` in the above example) will not be overwritten by `transferPropsTo`.
> Note:
>
> Use `transferPropsTo` with caution; it encourages tight coupling and makes it easy to accidentally introduce implicit dependencies between components. When in doubt, it's safer to explicitly copy the properties that you need onto the child component.
### setProps
```javascript

Loading…
Cancel
Save