jolt_flutter 1.1.3
jolt_flutter: ^1.1.3 copied to clipboard
Flutter library for jolt reactive signals library that builds reactive widgets from signals, automatically updating UI when signals change.
Jolt Flutter #
A Flutter integration package for Jolt reactive state management.
Jolt Flutter provides Flutter-specific widgets and utilities for working with Jolt signals, computed values, and reactive state. It includes widgets like JoltBuilder for reactive UI updates and seamless integration with Flutter's ValueNotifier system.
Documentation #
Features #
- 🎯 Reactive Widgets:
JoltBuilderandJoltSelectorfor automatic UI updates - 🔄 ValueNotifier Integration: Seamless bridge between Jolt signals and Flutter's ValueNotifier
- ⚡ Performance Optimized: Fine-grained rebuilds with selector-based updates
- 🎨 Flutter Native: Works with all Flutter widgets and animations
- 🛠️ Resource Management: Automatic cleanup and disposal
- 📦 Collection Support: Reactive List, Map, Set widgets
- 🔄 Async Support: Built-in async state handling
For full API reference and detailed usage examples, check the inline comments in the source code and the Documentation.
Quick Start #
import 'package:flutter/material.dart';
import 'package:jolt_flutter/jolt_flutter.dart';
void main() {
runApp(MyApp());
}
class MyApp extends StatelessWidget {
final counter = Signal(0);
@override
Widget build(BuildContext context) {
return MaterialApp(
home: Scaffold(
body: JoltBuilder(
builder: (context) => Text('Count: ${counter.value}'),
),
floatingActionButton: FloatingActionButton(
onPressed: () => counter.value++,
child: Icon(Icons.add),
),
),
);
}
}
Core Widgets #
JoltBuilder #
Automatically rebuilds when any signal accessed in its builder changes:
final counter = Signal(0);
final name = Signal('Flutter');
JoltBuilder(
builder: (context) => Column(
children: [
Text('Hello ${name.value}'),
Text('Count: ${counter.value}'),
ElevatedButton(
onPressed: () => counter.value++,
child: Text('Increment'),
),
],
),
)
JoltSelector #
Rebuilds only when a specific selector function's result changes:
final user = Signal(User(name: 'John', age: 30));
// Only rebuilds when the user's name changes, not age
JoltSelector(
selector: (prev) => user.value.name,
builder: (context, name) => Text('Hello $name'),
)
The selector function receives the previous selected value (or null on first run) and returns the new value to watch. Rebuilds occur only when the returned value changes.
JoltProvider #
A widget that provides resources with lifecycle management:
class CounterStore extends JoltState {
final counter = Signal(0);
Timer? _timer;
@override
void onMount(BuildContext context) {
_timer = Timer.periodic(Duration(seconds: 1), (_) {
counter.value++;
});
}
@override
void onUnmount(BuildContext context) {
_timer?.cancel();
}
}
JoltProvider<CounterStore>(
create: (context) => CounterStore(),
builder: (context, store) => Text('Count: ${store.counter.value}'),
)
Access the resource from descendant widgets:
Builder(
builder: (context) {
final store = JoltProvider.of<CounterStore>(context);
return Text('Count: ${store.counter.value}');
},
)
ValueNotifier Integration #
Converting Jolt Signals to ValueNotifier #
Bridge Jolt signals with Flutter's ValueNotifier system using the extension:
final counter = Signal(0);
final notifier = counter.notifier; // Returns JoltValueNotifier
// Use with AnimatedBuilder
AnimatedBuilder(
animation: notifier,
builder: (context, child) => Text('Count: ${notifier.value}'),
)
// Use with ValueListenableBuilder
ValueListenableBuilder<int>(
valueListenable: notifier,
builder: (context, value, child) => Text('Count: $value'),
)
Converting ValueNotifier to Jolt Signal #
Convert Flutter's ValueNotifier to Jolt signals for bidirectional sync:
final notifier = ValueNotifier(0);
final signal = notifier.toNotifierSignal();
// Changes sync bidirectionally
notifier.value = 1; // signal.value becomes 1
signal.value = 2; // notifier.value becomes 2
Automatic Synchronization #
ValueNotifier automatically syncs with Jolt signal changes:
final signal = Signal(0);
final notifier = signal.notifier;
// Changes to signal automatically update notifier
signal.value = 42; // notifier.value is now 42
Flutter Integration Examples #
With Async Operations #
final userSignal = AsyncSignal.fromFuture(fetchUser());
JoltBuilder(
builder: (context) {
final state = userSignal.value;
if (state.isLoading) return CircularProgressIndicator();
if (state.isError) return Text('Error: ${state.error}');
return Text('User: ${state.data}');
},
)
With Collections #
final items = ListSignal(['apple', 'banana']);
JoltBuilder(
builder: (context) => ListView.builder(
itemCount: items.length,
itemBuilder: (context, index) => ListTile(
title: Text(items[index]),
),
),
)
Performance Tips #
Use JoltSelector for Fine-Grained Updates #
final user = Signal(User(name: 'John', age: 30));
// Only rebuilds when name changes
JoltSelector(
selector: (prev) => user.value.name,
builder: (context, name) => Text('Hello $name'),
)
Batch Updates #
Batch multiple signal updates to avoid unnecessary rebuilds:
batch(() {
counter.value++;
name.value = 'New Name';
// Only one rebuild occurs
});
Important Notes #
Widget Lifecycle #
JoltBuilderautomatically tracks signal dependencies- Widgets rebuild only when tracked signals change
- Use
JoltSelectorfor performance optimization
Memory Management #
- Signals are automatically disposed when widgets are disposed
JoltProvidermanages resource lifecycle withJoltState- ValueNotifier integration handles cleanup automatically
Performance Tips #
- Use
JoltSelectorfor fine-grained updates - Batch multiple signal updates with
batch() - Avoid accessing signals in widget constructors
- Use
JoltProviderfor resources that need lifecycle management
Related Packages #
Jolt Flutter is part of the Jolt ecosystem. Explore these related packages:
| Package | Description |
|---|---|
| jolt | Core library providing Signals, Computed, Effects, and reactive collections |
| jolt_hooks | Hooks API: useSignal, useComputed, useJoltEffect, useJoltWidget |
| jolt_surge | Signal-powered Cubit pattern: Surge, SurgeProvider, SurgeConsumer |
License #
This project is licensed under the MIT License - see the LICENSE file for details.