-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
fix(release): Update docs and dependencies
- Loading branch information
Showing
4 changed files
with
93 additions
and
78 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
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,2 +1,77 @@ | ||
| # react-thrux | ||
| Thrux implementation for React components | ||
|
|
||
| [](https://travis-ci.org/Thram/react-thrux) | ||
| [](https://www.npmjs.com/package/react-thrux) | ||
| [](https://www.npmjs.com/package/react-thrux) | ||
| [](https://opensource.org/licenses/MIT) | ||
|
|
||
| Connect Thrux state to a React component. | ||
|
|
||
| ## API | ||
|
|
||
| #### connect(stateKey, ReactComponent) | ||
|
|
||
| Register your dictionaries. | ||
|
|
||
| ***returns:*** React Component[Object] | ||
|
|
||
| Param | Type | Description | ||
| ----- | ---- | ----------- | ||
| stateKey | String | Name of the state you want to connect your component with | ||
| ReactComponent | [Object] / [Class] | React Component object | ||
|
|
||
| ```javascript | ||
| import React, {Component} from "react"; | ||
| import {dispatch} from "thrux"; | ||
| import {connect} from "react-thrux"; | ||
|
|
||
|
|
||
| class Example extends Component { | ||
| state = { | ||
| counter: 0 | ||
| }; | ||
|
|
||
| onIncrease = () => dispatch('counter:INCREASE'); | ||
| onDecrease = () => dispatch('counter:DECREASE'); | ||
| onReset = () => dispatch('counter:RESET'); | ||
|
|
||
| render() { | ||
| return ( | ||
| <div style={styles.container}> | ||
| <div style={styles.column}> | ||
| <div id="click-area" style={styles.clickArea} onClick={this.onIncrease}> | ||
| Click Area | ||
| </div> | ||
| <button id="decrease" onClick={this.onDecrease}>Decrease</button> | ||
| <button id="reset" onClick={this.onReset}>Reset</button> | ||
| </div> | ||
| <div style={styles.column}> | ||
| Clicks: <span>{this.state.counter}</span> | ||
| </div> | ||
| </div> | ||
| ) | ||
| } | ||
| } | ||
|
|
||
| const styles = { | ||
| container: { | ||
| fontFamily: "Helvetica, Arial, sans-serif" | ||
| }, | ||
|
|
||
| clickArea: { | ||
| padding : '20px', | ||
| width : '200px', | ||
| height : '200px', | ||
| border : '1px solid black', | ||
| background: 'teal' | ||
| }, | ||
| column : { | ||
| padding: '20px', | ||
| display: 'inline-block', | ||
| float : 'left' | ||
| } | ||
| }; | ||
|
|
||
| export default connect('counter', Example); | ||
|
|
||
| ``` |
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
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