subspace-docs/react.md

83 lines
2.5 KiB
Markdown
Raw Normal View History

# React
We provide a higher-order component to connect to enhance presentational components to react to any observable (not limited to those generated by Phoenix).
2019-09-03 14:40:19 -04:00
### Usage
```js
import { observe } from 'phoenix/react';
const ObserverComponent = observe(WrappedComponent);
```
This enhanced component will subscribe to any observable property it receives when the component is mounted and automatically unsubscribe when the component is unmounted.
### Example
2019-09-06 09:28:26 -04:00
::: tip
2019-09-04 21:41:25 -04:00
This example is available in [Github](https://github.com/status-im/phoenix/tree/master/examples/react)
2019-09-06 09:28:26 -04:00
:::
#### MyComponentObserver.js
2019-09-03 14:40:19 -04:00
```js
import React from "react";
import ReactDOM from 'react-dom';
import {observe} from "phoenix/react";
const MyComponent = ({eventData}) => {
// Handle initial state when no data is available
if (!eventData) {
2019-09-04 15:54:23 -04:00
return <p>No data</p>;
}
2019-09-03 14:40:19 -04:00
return <p>{eventData.someReturnedValue}</p>
};
// MyComponent will now observe any observable prop it receives
// and update its state whenever the observable emits an event
export default observe(MyComponent);
```
2019-09-03 14:40:19 -04:00
#### App.js
```js
import React, {Component} from 'react';
import ReactDOM from 'react-dom';
import Phoenix from 'phoenix';
import MyComponentObserver from './MyComponentObserver';
2019-09-03 14:40:19 -04:00
class App extends Component {
2019-09-03 14:40:19 -04:00
state = {
myEventObservable$: null
2019-09-03 14:40:19 -04:00
}
2019-09-04 15:54:23 -04:00
async componentDidMount() {
const MyContractInstance = ...; // TODO: obtain a web3.eth.contract instance
2019-09-04 21:41:25 -04:00
const eventSyncer = new Phoenix("wss://localhost:8545"); // Use a valid websocket provider (geth, parity, infura...)
2019-09-04 15:54:23 -04:00
await eventSyncer.init()
const myEventObservable$ = eventSyncer.trackEvent(MyContractInstance, "MyEvent", {filter: {}, fromBlock: 1 });
this.setState({ myEventObservable$ });
2019-09-03 14:40:19 -04:00
}
render() {
return <MyComponentObserver eventData={this.state.myEventObservable$} />;
2019-09-03 14:40:19 -04:00
}
}
export default App;
2019-09-03 14:40:19 -04:00
```
2019-09-04 21:41:25 -04:00
::: warning Handling Contract Objects
2019-09-04 15:54:23 -04:00
The variable `MyContractInstance` is a `web3.eth.Contract` object pointing to a deployed contract address. You can use a DApp framework like [Embark](https://embark.status.im/docs/contracts_javascript.html) to easily import that contract instance: `import { MyContract } from './embarkArtifacts/contracts';`, or use web3.js directly (just like in the example [source code](https://github.com/status-im/phoenix/blob/master/examples/react/src/MyContract.js#L36-L42))
2019-09-04 21:41:25 -04:00
:::
2019-09-04 15:54:23 -04:00
#### index.js
```js
import React from 'react';
import ReactDOM from 'react-dom';
import App from './App';
ReactDOM.render(<App />, document.getElementById('root'));
2019-09-06 09:28:26 -04:00
```