# state-reducer-viewer

> Create/edit/delete states using reducer functions

Latest version **4.1.0** (published 2019-01-30) · ISC license · 0 weekly downloads

## Install

```sh
npm install state-reducer-viewer
pnpm add state-reducer-viewer
yarn add state-reducer-viewer
bun add state-reducer-viewer
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 4.1.0 |
| Published | 2019-01-30 |
| First published | 2019-01-22 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Unpacked size | 1.5 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Vetrivel, Shanmugam |
| Maintainers | 376954 |

## Links

- npm: https://www.npmjs.com/package/state-reducer-viewer
- Repository: https://github.com/imvetri/state-reducer-viewer
- Homepage: https://github.com/imvetri/state-reducer-viewer#readme
- Issues: https://github.com/imvetri/state-reducer-viewer/issues
- npm.io page: https://npm.io/package/state-reducer-viewer

## Dependencies (5)

- [react](https://npm.io/package/react.md) ^16.7.0
- [react-dom](https://npm.io/package/react-dom.md) ^16.7.0
- [react-switch](https://npm.io/package/react-switch.md) ^3.0.4
- [react-inspector](https://npm.io/package/react-inspector.md) ^2.3.1
- [react-codemirror](https://npm.io/package/react-codemirror.md) ^1.0.0

## Recent versions

- 4.1.0 (latest) — 2019-01-30
- 4.0.0 — 2019-01-28
- 3.0.0 — 2019-01-28
- 2.0.0 — 2019-01-28
- 1.3.0 — 2019-01-28
- 1.2.0 — 2019-01-28
- 1.1.0 — 2019-01-28
- 1.0.0 — 2019-01-22

## README

# state-reducer-viewer

Renders a tree of state, reducers/new states. Used in UI-Editor project. [Sample Demo](https://imvetri.github.io/state-reducer-viewer/)
## Usage

    npm install "state-editor-viewer"

in index.js file


    // Libraries.
    import  React, {Component} from  "react";
    import  ReactDOM  from  "react-dom";
    import  StateReducerViewer  from  "state-reducer-viewer";
    
    // Dependencies.
    import  style  from  "./index.css";
    
    // Components.
    mport  StateReducerViewer  from  "state-reducer-viewer";
    
    class  Index  extends  Component {
	    constructor(props) {
		    super(props);
	    }
	    render(){
		    return (
			    <StateReducerViewer/>
		    );
	    }
    }
    
    ReactDOM.render(<Index/>, document.getElementById("index"));

in your html file

> <div id="index"/>

Run it, you will see below screenshot/video(future)


## Available options
No props - Runs with mock state.

    <StateReducerViewer/>


states props  - Array - Tree representation of states and reducer in below format


	let states = [
		 {
			 name:"ValidInputState",
			 data: {
				 border:"black"
			 }
		 }   
    ];

	<StateReducerViewer states={states}/>
closeFunction props - Function - optional - Helps to customise the close behaviour. FUTURE- Allow to change css. to give custom class name.
openFunction props - Function - optional - Helps to customise open behaviour.

### State object properties

data - JSON details of state.
Example: 

	let states = [
			{
				name: "ValidInputState",
				data: {
					border:"black"
				},
				states: [],
				reducers: []
			}   
	];
name - String - name of the state. First state is named "default".
states - Array of next states. Computed by running reducers agains data de here`
reducers - Array of function definitions. 

    let states = [
	    {
		    "name": "Initial State",
		    "data": {
						"status": "Anonymous"
				    },
			"reducers": [
				"state.status='LoggedIn'",
				"state.status='LoggedOut'"
			],
			"states": [
				{
					"name": "Loggedin State",
					"data": {
								"status": "LoggedIn"
							},
					"reducers": [],
					"states": []
				},
				{
					"name": "LoggedOut State",
					"data": {
								"status": "LoggedOut"
							},
					"reducers": [],
					"states": []
				}
			]
		}
	]
	<StateReducerViewer states={states}/>
Will render below viewer.
![A tree view rendered format](https://github.com/imvetri/state-reducer-viewer/blob/master/Viewer.png)


:fist:

---
_Source: https://npm.io/package/state-reducer-viewer · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
