Light

do-wa / xstate-addon Goto Github PK

View Code? Open in Web Editor NEW

20.0 2.0 5.0 2.06 MB

Storybook addon for xstate

License: MIT License

JavaScript 100.00%

storybook-addon javascript statechart

xstate-addon's Introduction

WARNING

this project is not actively maintained

based on xstate v3.2 and storybook v3.4

xstate-addon

A storybook addon project for xstate (https://github.com/davidkpiano/xstate)

The project is in an early stage. Everyone who is interested in bringing this project forward is welcome to contribute ideas, docs and code.

install

npm i storybook-addon-xstate -D

register

addons.js

import 'storybook-addon-xstate/register';

story

import { WithXStateGraph } from 'storybook-addon-xstate';

<WithXStateGraph
   machine={xstateMachine}
   onTransition={onEvent}
   currentState={currentState}
>
  <TrafficLight light={currentState} />
 </WithXStateGraph>

basic idea

xstate-addon's People

Contributors

Stargazers

Watchers

Forkers

r26d volland abejfehr

xstate-addon's Issues

Improve graph interaction

More fine grained zooming control
Re-render button

Support for parallel states

t.b.a.

npm package/storybook addon preparations

the storybook addon is built after the instructions from https://storybook.js.org/addons/writing-addons/

refactor code for npm publish

Migrate to official visualization

an official "visualization tool" is planned afaik from the linked issue. It makes sense to swap the basic implementation with the official one when available.

Roadmap to 1.0

Open discussion for cool and important features that should be part of the addon

Support for parallel States
Refactor component api to use state definition instead of full xstate machine to allow easier partial state display
Graph Interaction:
More fine grained zooming control
Re-render button
Graph Display:
Display xstate actions, conditions etc. (full xstate capabilities)

Project structure

Basic Framework for Tests (Jest?)

Add examples and install instructions

short readme installation
simple examples
complex examples

Component API refactoring

Instead of taking the complete xstate machine it should be enough to set the state definition to allow the partial display from a full statemachine

Enhance graph display

Visual representation "guideline" for specific features
http://www.inf.ed.ac.uk/teaching/courses/seoc/2005_2006/resources/statecharts.pdf

Recommend Projects

React

A declarative, efficient, and flexible JavaScript library for building user interfaces.
Vue.js

🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript

TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
TensorFlow

An Open Source Machine Learning Framework for Everyone
Django

The Web framework for perfectionists with deadlines.
Laravel

A PHP framework for web artisans
D3

Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

javascript

JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
web

Some thing interesting about web. New door for the world.
server

A server is a program made to process requests and deliver data to clients.
Machine learning

Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Visualization

Some thing interesting about visualization, use data art
Game

Some thing interesting about game, make everyone happy.

Recommend Org

Facebook

We are working to build community through open source technology. NB: members must have two-factor auth.
Microsoft

Open source projects and samples from Microsoft.
Google

Google ❤️ Open Source for everyone.
Alibaba

Alibaba Open Source for everyone
D3

Data-Driven Documents codes.
Tencent

China tencent open source team.