├── .babelrc
├── .gitignore
├── .travis.yml
├── LICENSE
├── README.md
├── diagram.png
├── dist
└── index.js
├── lib
└── index.js
├── package.json
└── test
├── __snapshots__
└── react-states-machine.test.js.snap
└── react-states-machine.test.js
/.babelrc:
--------------------------------------------------------------------------------
1 | {
2 | "presets": ["env", "es2015", "react"],
3 | "plugins": ["transform-object-rest-spread"]
4 | }
5 |
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | # Logs
2 | logs
3 | *.log
4 | npm-debug.log*
5 | yarn-debug.log*
6 | yarn-error.log*
7 |
8 | # Runtime data
9 | pids
10 | *.pid
11 | *.seed
12 | *.pid.lock
13 |
14 | # Directory for instrumented libs generated by jscoverage/JSCover
15 | lib-cov
16 |
17 | # Coverage directory used by tools like istanbul
18 | coverage
19 |
20 | # nyc test coverage
21 | .nyc_output
22 |
23 | # Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
24 | .grunt
25 |
26 | # Bower dependency directory (https://bower.io/)
27 | bower_components
28 |
29 | # node-waf configuration
30 | .lock-wscript
31 |
32 | # Compiled binary addons (http://nodejs.org/api/addons.html)
33 | build/Release
34 |
35 | # Dependency directories
36 | node_modules/
37 | jspm_packages/
38 |
39 | # Typescript v1 declaration files
40 | typings/
41 |
42 | # Optional npm cache directory
43 | .npm
44 |
45 | # Optional eslint cache
46 | .eslintcache
47 |
48 | # Optional REPL history
49 | .node_repl_history
50 |
51 | # Output of 'npm pack'
52 | *.tgz
53 |
54 | # Yarn Integrity file
55 | .yarn-integrity
56 |
57 | # dotenv environment variables file
58 | .env
59 |
60 |
--------------------------------------------------------------------------------
/.travis.yml:
--------------------------------------------------------------------------------
1 | language: node_js
2 | node_js:
3 | - "6.0"
4 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | MIT License
2 |
3 | Copyright (c) 2018 Olivier Wietrich
4 |
5 | Permission is hereby granted, free of charge, to any person obtaining a copy
6 | of this software and associated documentation files (the "Software"), to deal
7 | in the Software without restriction, including without limitation the rights
8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 |
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 |
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
22 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # React State Machine
2 |
3 | [](https://www.npmjs.com/package/react-states-machine)
4 | [](http://npm-stat.com/charts.html?package=react-states-machine)
5 | [](https://github.com/bredele/contributing-guide/blob/master/community.md)
6 |
7 | Inspired by [mood](https://github.com/bredele/mood) this module is using the well known [finite state machine](https://en.wikipedia.org/wiki/Finite-state_machine) pattern to alleviate some of the issues that crop up in complex React applications by strictly separating the management of states from your components. This module stay true to the original intent behind React:
8 | - Describe states as static components only (dynamic relationships within a component are expressed outside of the component itself)
9 | - Describe the logic for handling changes/updates as simple functions (called transitions).
10 | - Describe changes as plain objects to pass well defined and thought props.
11 |
12 | [Try online!](https://codesandbox.io/s/7jn717on4x)
13 |
14 |
15 | In addition, this module makes easy to:
16 | - develop stateless components (easier to understand and maintain)
17 | - develop components in isolation (easier to reuse and scale)
18 | - test components (dynamic relationships between components are tested separately)
19 | - manage asynchronous changes (props can be resolved by promises)
20 |
21 | 
22 |
23 | ## Usage
24 |
25 | A state is made of a component as well as a set of actions to be executed (called transitions). Those actions are called through transitions events and either update the current state or display a new state. A transition manages changes by passing props to the wanted state. Here's a simple example of navigation flow using react-states-machine:
26 |
27 |
28 | ```js
29 | import machine from 'react-states-machine'
30 |
31 | function NavigationFlow (attrs) {
32 | return (
33 |
34 | {
35 | machine({
36 | // welcome state
37 | 'welcome': [
38 | props => ,
39 | {
40 | // click event transition from welcome state to next state with a new message prop
41 | 'click': [() => ({message: 'Hello you!'}), 'next']
42 | }
43 | ],
44 | // next state
45 | 'next': [
46 | props => {
47 | return (
48 |
49 |
50 | {props.message}
51 |
52 |
53 | )
54 | },
55 | {
56 | // update event update next state with new message prop after 1 second
57 | 'update': [() => new Promise(resolve => setTimeout(() => resolve({ message: 'This is awesome!' }), 1000))]
58 | }
59 | ]
60 | }, attrs)
61 | }
62 |
63 | )
64 | }
65 | ```
66 |
67 | ## Getting started
68 |
69 | A state machine is an object describing your application/component states.
70 |
71 | ```js
72 | machine({
73 | state: [
74 | component,
75 | transitions
76 | ]
77 | })
78 | ```
79 |
80 | A state is composed of a component as well as an optional object containing transitions to mutate this component. Here's an example that shows how to style an input when empty using a transition called `validity`:
81 |
82 | ```js
83 | machine({
84 | 'inputState': [
85 | props => props.transition('validity', e.target.value)}/>,
86 | {
87 | 'validity': [(prev, value) => {
88 | return {
89 | invalid: !value
90 | }
91 | }]
92 | }
93 | ]
94 | })
95 | ```
96 |
97 | A transition is a function used to pass props to your component and update it. This function can return any types as well as promises (transition is resolved with the promise).
98 |
99 | A transition is also useful to describe the passage to an other state. Here's an example:
100 |
101 | ```js
102 | machine({
103 | 'formEmail': [
104 | props => {
105 | return (
106 |