updating docs

rodydavis · Apr 9, 2024 · adb4c20 · adb4c20
1 parent c5ade80
commit adb4c20
Show file tree

Hide file tree

Showing 5 changed files with 11 additions and 57 deletions.
diff --git a/packages/signals_flutter/lib/src/signals/core/computed.dart b/packages/signals_flutter/lib/src/signals/core/computed.dart
@@ -6,9 +6,9 @@ import '../../../signals_flutter.dart';
 ///
 /// ```dart
 /// class State extends ... {
-///  late final count = createSignal(this, 0);
+///  late final count = createSignal(context, 0);
 ///  late final isEven = computed(() => count().isEven);
-///  late final even = bindComputed(this, isEven);
+///  late final even = bindComputed(context, isEven);
 ///
 ///  @override
 ///  Widget build(BuildContext context) {
@@ -38,9 +38,9 @@ Computed<T> bindComputed<T>(
 ///
 /// ```dart
 /// class State extends ... {
-///  late final count = createSignal(this, 0);
-///  late final isEven = createComputed(this, () => count().isEven);
-///  late final isOdd = createComputed(this, () => count().isOdd);
+///  late final count = createSignal(context, 0);
+///  late final isEven = createComputed(context, () => count().isEven);
+///  late final isOdd = createComputed(context, () => count().isOdd);
 ///
 ///  @override
 ///  Widget build(BuildContext context) {

diff --git a/packages/signals_flutter/lib/src/signals/core/signal.dart b/packages/signals_flutter/lib/src/signals/core/signal.dart
@@ -7,7 +7,7 @@ import '../../../signals_flutter.dart';
 /// ```dart
 /// class State extends ... {
 ///  final source = signal(0);
-///  late final count = bindSignal(this, source);
+///  late final count = bindSignal(context, source);
 ///
 ///  @override
 ///  Widget build(BuildContext context) {
@@ -38,7 +38,7 @@ S bindSignal<T, S extends ReadonlySignal<T>>(
 ///
 /// ```dart
 /// class State extends ... {
-///  late final count = createSignal(this, 0);
+///  late final count = createSignal(context, 0);
 ///
 ///  @override
 ///  Widget build(BuildContext context) {

diff --git a/website/src/content/docs/core/computed.md b/website/src/content/docs/core/computed.md
@@ -102,9 +102,9 @@ class CounterWidget extends StatefulWidget {
 }
 
 class _CounterWidgetState extends State<CounterWidget> with SignalsAutoDisposeMixin {
-  late final counter = createSignal(this, 0);
-  late final isEven = createComputed(this, () => counter.value.isEven);
-  late final isOdd = createComputed(this, () => counter.value.isOdd);
+  late final counter = createSignal(context, 0);
+  late final isEven = createComputed(context, () => counter.value.isEven);
+  late final isOdd = createComputed(context, () => counter.value.isOdd);
 
   @override
   Widget build(BuildContext context) {

diff --git a/website/src/content/docs/core/effect.md b/website/src/content/docs/core/effect.md
@@ -97,49 +97,3 @@ Future<void> main() async {
   await completer.future;
 }
 ```
-
-## Flutter
-
-In Flutter if you want to create an effect that automatically disposes itself when the widget is removed from the widget tree, you can use the `createEffect` inside a stateful widget.
-
-```dart
-import 'package:flutter/material.dart';
-import 'package:signals/signals_flutter.dart';
-
-class CounterWidget extends StatefulWidget {
-  @override
-  _CounterWidgetState createState() => _CounterWidgetState();
-}
-
-class _CounterWidgetState extends State<CounterWidget> with SignalsAutoDisposeMixin {
-  late final counter = createSignal(this, 0);
-  
-  @override
-  void initState() {
-    super.initState();
-    createEffect(this, () {
-      print('Counter: ${counter.value}');
-    });
-  }
-
-  @override
-  Widget build(BuildContext context) {
-    return Scaffold(
-      body: Center(
-        child: Column(
-          mainAxisAlignment: MainAxisAlignment.center,
-          children: [
-            Text('Counter: $counter'),
-            ElevatedButton(
-              onPressed: () => counter.value++,
-              child: Text('Increment'),
-            ),
-          ],
-        ),
-      ),
-    );
-  }
-}
-```
-
-The `SignalsAutoDisposeMixin` is a mixin that automatically disposes all signals created in the state when the widget is removed from the widget tree.
diff --git a/website/src/content/docs/core/signal.md b/website/src/content/docs/core/signal.md
@@ -141,7 +141,7 @@ class CounterWidget extends StatefulWidget {
 }
 
 class _CounterWidgetState extends State<CounterWidget> with SignalsAutoDisposeMixin {
-  late final counter = createSignal(this, 0);
+  late final counter = createSignal(context, 0);
 
   @override
   Widget build(BuildContext context) {