@yantrix/react

Yantrix is a (mostly) TypeScript framework and a DSL, that make up a full instrumental chain to implement robust and self-documented functional applications by code generation in multiple programming languages.

React integration for the Yantrix framework. This package provides hooks and utilities to use finite state machines implemented with @yantrix/automata within React applications, allowing for declarative state management through the useFSM hook.

📖 Usage

Install the primary package using your prefered package manager. All the secondary dependencies will be installed automatically. However, you will need @yantrix/automata at least for types. Most likely, you will also need @yantrix/cli to build diagrams into code.

# Via NPM
$ npm install @yantrix/react @yantrix/automata @yantrix/cli

# Via Yarn
$ yarn add @yantrix/react @yantrix/automata @yantrix/cli

# Via PNPM
$ pnpm install @yantrix/react @yantrix/automata @yantrix/cli

# ✨ Auto-detection
$ npx nypm install @yantrix/react @yantrix/automata @yantrix/cli

We suggest using pnpm

Then, see the docs:

• React Integration
• Example: React
• More Examples

🌱 Contributing

📜 License

Made with 💜. Published under MIT License.