Skip to content
Version: XState v5

Descriptions

You can add descriptions to state and event nodes to describe their purpose and share related notes with your team. Descriptions support markdown formatting, including links and images.

The machine object will include your descriptions in the state or event's description when you export your statecharts to JSON.

The machine object will include your descriptions in the state or event's description when you export your statecharts to JSON.

In the video player above, the text “The video player should be in full-screen mode” is a description of the Opened event.

Add a description to a state​

  1. Select the state.
  2. Open the State details panel from the right tool menu.
  3. Write your state’s description in the Description text area.

Add a description to an event​

  1. Select the event.
  2. Open the Transition details panel from the right tool menu.
  3. Write your event’s description in the Description text area.