FlowState Documentation

📚 Full documentation: https://sps014.github.io/FlowState/

A high-performance node editor for Blazor. Build visual programming tools, node-based workflows, and interactive graph editors with complete styling control.

Quick Links

• 📦 Installation - Get started with Blazor Server or WebAssembly
• 🚀 Getting Started - Your first node graph
• 🎨 Styling Guide - Complete CSS customization
• 🔧 Custom Nodes - Build your own nodes
• 📖 API Reference - Complete component documentation

Features

• ✅ Full customization - Style everything with regular HTML/CSS
• ✅ High performance - Handles hundreds of nodes smoothly
• ✅ Custom nodes - Create any node type using Blazor components
• ✅ Type safety - Automatic type checking with custom conversion
• ✅ Execution engine - Built-in graph execution with visual feedback
• ✅ Group nodes - Resizable container nodes
• ✅ Undo/Redo - Command pattern with unlimited history
• ✅ Serialization - Save and restore complete graph state
• ✅ Read-only mode - Lock graphs for presentation
• ✅ Touch support - Works on desktop and mobile

For detailed installation instructions, see the Installation Guide.

Documentation Structure

This documentation is built with Jekyll and hosted on GitHub Pages.

Contributing

To contribute to the documentation:

1. Edit the relevant .md file in the docs/ directory
2. Test locally with bundle exec jekyll serve
3. Submit a pull request

Links

• 🌐 Live Documentation: https://sps014.github.io/FlowState/
• 📦 NuGet Package: https://www.nuget.org/packages/FlowState
• 💻 GitHub Repository: https://github.com/sps014/FlowState