Skip to content
Version: XState v4

Welcome to the Stately docs

Here you can find all the documentation for the Stately Studio and XState. There are a few ways you might want to get started:

The Stately Studio is a suite of tools for building app logic, including the Studio Editor, developer tools for XState, and much more coming soon.

A dog walk machine open in Stately Studio’s editor. The dog walk machine has cute puppy images for each state, showing a dog walking and running. The speed up event is selected, and information and options for that transition is shown in an inspector panel on the right.A dog walk machine open in Stately Studio’s editor. The dog walk machine has cute puppy images for each state, showing a dog walking and running. The speed up event is selected, and information and options for that transition is shown in an inspector panel on the right.

You can use the Studio Editor to model your logic using state machines and statecharts visually; no code required! Collaborate on your machines with coworkers and friends with shared projects in teams. Use the XState VS Code extension to use the Editor with your codebase inside your code editor, or export your code from the Studio into your codebase.

Stately Studio editor​

Stately Studio’s editor supports everything you need to visually build state machines and statecharts. The editor currently has two modes; Design mode for creating your machines and Simulation mode for simulating how your machine works.

Design mode​

A dog walk machine open in Stately Studio’s editor in Design mode. The running state is selected, with the right panel showing options for a state.A dog walk machine open in Stately Studio’s editor in Design mode. The running state is selected, with the right panel showing options for a state.

Visually add, modify, and delete states, events, and transitions, as well as data, including actions, descriptions, and invoked actors.

Simulation mode​

A dog walk machine open in Stately Studio’s editor in Simulate mode. The walking state is active, with the speed up and arrive home events both highlighted showing which events could be triggered next. The right panel shows an event log of the states and events taken.A dog walk machine open in Stately Studio’s editor in Simulate mode. The walking state is active, with the speed up and arrive home events both highlighted showing which events could be triggered next. The right panel shows an event log of the states and events taken.

Run the statechart, trigger events, and see the active state nodes.

Export​

You can also export machines to JSON, JavaScript and TypeScript, ready to be used in your codebase with XState.

Projects and teams​

Stately Studio Projects page for the Voyager team, showing a list of four projects, one with public machines, two with private machines, and one with unlisted machines.Stately Studio Projects page for the Voyager team, showing a list of four projects, one with public machines, two with private machines, and one with unlisted machines.

As a Pro user, you can create and join teams in the Stately Studio to share your machines and collaborate on private team projects. Read more about Projects and Teams.

Stately Studio Team page for the Voyager team, showing Captain Janeway with the owner and Admin role, Commander Chakotay with an Admin role, Lieutenant Tuvok, Lieutenant Torres, and Lieutenant Paris with Editor roles, and Ensign Kim with a Viewer role.Stately Studio Team page for the Voyager team, showing Captain Janeway with the owner and Admin role, Commander Chakotay with an Admin role, Lieutenant Tuvok, Lieutenant Torres, and Lieutenant Paris with Editor roles, and Ensign Kim with a Viewer role.

Discover machines​

Are you seeking inspiration for your machine? Or do you want to learn from how somebody else models their machines? The Discover page lists all the public machines created with the Stately Studio. Read more about the Discover page.

Stately Studio Discover page showing the search results for “auth”, filtered by editor machines under 10 states, showing 173 results.Stately Studio Discover page showing the search results for “auth”, filtered by editor machines under 10 states, showing 173 results.

Our roadmap​

Do you want to request a feature in the Stately Studio? Check out our Canny roadmap to post your feature idea and upvote other features. Our roadmap also shows you the features we have planned and those already in progress.

You can also keep up with the Stately team’s work in progress at our regular office hour live streams.