Skip to content

Lexpeartha/nuxt-xstate

Repository files navigation

Nuxt XState

GitHub package.json version npm (prod) dependency version npm (prod) dependency version npm Website GitHub Workflow Status

Nuxt XState module allows for easy integration of XState with Nuxt.js.

Features ✨

  • Nuxt Bridge & Nuxt 3 supported
  • Auto-importing of XState composables
  • Auto-importing of your own state-machines

Installation 💾

Run one of the following commands:

npx nuxi@latest module add xstate

And add it to your nuxt.config.ts:

import { defineNuxtConfig } from 'nuxt/config'

export default defineNuxtConfig({
  modules: ['nuxt-xstate']
})

Usage 🧰

👉 Check out the documentation

Work in progress 🚧

Development 💻

  • Clone repository and install dependencies with yarn install
  • Run yarn dev:prepare to generate type stubs.
  • Use yarn dev to start playground in development mode.