Installation
Set up Vyuh Node Flow in your Flutter project
Installation
Get Vyuh Node Flow running in your Flutter project in under 5 minutes.
Requirements
| Requirement | Minimum Version |
|---|---|
| Flutter | 3.32.0+ |
| Dart SDK | 3.9.0+ |
Setup
Add the Dependency
Add vyuh_node_flow to your pubspec.yaml:
dependencies:
vyuh_node_flow: ^0.8.0dependencies:
vyuh_node_flow:
git:
url: https://github.com/vyuh-tech/vyuh_node_flow.git
path: packages/vyuh_node_flowImport the Library
Add the import to your Dart files:
import 'package:vyuh_node_flow/vyuh_node_flow.dart';Verify Installation
Create a minimal test to confirm everything works:
import 'package:flutter/material.dart';
import 'package:vyuh_node_flow/vyuh_node_flow.dart';
void main() {
runApp(const MyApp());
}
class MyApp extends StatelessWidget {
const MyApp({super.key});
@override
Widget build(BuildContext context) {
return MaterialApp(
home: Scaffold(
body: Builder(
builder: (context) {
// If this compiles, the package is installed correctly
final controller = NodeFlowController<String>();
return Center(
child: Text('Vyuh Node Flow v0.8.0 installed!'),
);
},
),
),
);
}
}Run the app. If it compiles and runs without errors, you're ready to go.
Under the Hood: Vyuh Node Flow uses MobX for reactive state management. The package handles all MobX setup internally - no additional configuration needed.
What's Included
The vyuh_node_flow package exports everything you need:
| Export | Purpose |
|---|---|
NodeFlowEditor | The main interactive editor widget |
NodeFlowViewer | Read-only display widget |
NodeFlowController | State management and operations |
Node, Port, Connection | Core data models |
NodeFlowTheme | Complete theming system |
| Shapes, Styles, Effects | Visual customization classes |