Clarify wrapComponent interface in Plugin API docs
This commit is contained in:
@@ -293,7 +293,7 @@ const MyWrapSelectorsPlugin = function(system) {
|
|||||||
|
|
||||||
Wrap Components allow you to override a component registered within the system.
|
Wrap Components allow you to override a component registered within the system.
|
||||||
|
|
||||||
Wrap Components are function factories with the signature `(OriginalComponent, system) => props => ReactElement`.
|
Wrap Components are function factories with the signature `(OriginalComponent, system) => props => ReactElement`. If you'd prefer to provide a React component class, `(OriginalComponent, system) => ReactClass` works as well.
|
||||||
|
|
||||||
```javascript
|
```javascript
|
||||||
const MyWrapBuiltinComponentPlugin = function(system) {
|
const MyWrapBuiltinComponentPlugin = function(system) {
|
||||||
@@ -310,9 +310,12 @@ const MyWrapBuiltinComponentPlugin = function(system) {
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
```javascript
|
Here's another example that includes a code sample of a component that will be wrapped:
|
||||||
// Overriding a component from a plugin
|
|
||||||
|
|
||||||
|
```javascript
|
||||||
|
///// Overriding a component from a plugin
|
||||||
|
|
||||||
|
// Here's our normal, unmodified component.
|
||||||
const MyNumberDisplayPlugin = function(system) {
|
const MyNumberDisplayPlugin = function(system) {
|
||||||
return {
|
return {
|
||||||
components: {
|
components: {
|
||||||
@@ -321,6 +324,7 @@ const MyNumberDisplayPlugin = function(system) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Here's a component wrapper defined as a function.
|
||||||
const MyWrapComponentPlugin = function(system) {
|
const MyWrapComponentPlugin = function(system) {
|
||||||
return {
|
return {
|
||||||
wrapComponents: {
|
wrapComponents: {
|
||||||
@@ -328,6 +332,7 @@ const MyWrapComponentPlugin = function(system) {
|
|||||||
if(props.number > 10) {
|
if(props.number > 10) {
|
||||||
return <div>
|
return <div>
|
||||||
<h3>Warning! Big number ahead.</h3>
|
<h3>Warning! Big number ahead.</h3>
|
||||||
|
<OriginalComponent {...props} />
|
||||||
</div>
|
</div>
|
||||||
} else {
|
} else {
|
||||||
return <Original {...props} />
|
return <Original {...props} />
|
||||||
@@ -336,8 +341,30 @@ const MyWrapComponentPlugin = function(system) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Alternatively, here's the same component wrapper defined as a class.
|
||||||
|
const MyWrapComponentPlugin = function(system) {
|
||||||
|
return {
|
||||||
|
wrapComponents: {
|
||||||
|
NumberDisplay: (Original, system) => class WrappedNumberDisplay extends React.component {
|
||||||
|
render() {
|
||||||
|
if(props.number > 10) {
|
||||||
|
return <div>
|
||||||
|
<h3>Warning! Big number ahead.</h3>
|
||||||
|
<OriginalComponent {...props} />
|
||||||
|
</div>
|
||||||
|
} else {
|
||||||
|
return <Original {...props} />
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
##### fn
|
##### fn
|
||||||
|
|
||||||
The fn interface allows you to add helper functions to the system for use elsewhere.
|
The fn interface allows you to add helper functions to the system for use elsewhere.
|
||||||
|
|||||||
Reference in New Issue
Block a user