Skip to content

Commit

Permalink
updating readme
Browse files Browse the repository at this point in the history
  • Loading branch information
@rodydavis
rodydavis committed Nov 21, 2023
1 parent e07fc2a commit 3217162
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 4 deletions.
8 changes: 6 additions & 2 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -224,7 +224,7 @@ final signal = stream.toSignal(); // or streamToSignal(stream)
To create a `ReadonlySignal` from `ValueListenable`:

```dart
import 'package:preact_signals/preact_signals.dart';
import 'package:flutter_preact_signals/flutter_preact_signals.dart';
import 'package:flutter/material.dart';
final ValueListenable listenable = ValueNotifier(10);
Expand All @@ -236,7 +236,7 @@ final signal = listenable.toSignal(); // or valueListenableToSignal(listenable)
To create a `MutableSignal` from `ValueNotifier`:

```dart
import 'package:preact_signals/preact_signals.dart';
import 'package:flutter_preact_signals/flutter_preact_signals.dart';
import 'package:flutter/material.dart';
final notifier = ValueNotifier(10);
Expand All @@ -249,6 +249,8 @@ final signal = notifier.toSignal(); // or valueNotifierToSignal(notifier)
`StatefulWidget` and `StatelessWidget` widgets can both react to changes on a signal by adding a `watch`` command:

```dart
import 'package:flutter_preact_signals/flutter_preact_signals.dart';
Text(
'${counter.watch(context)}',
style: Theme.of(context).textTheme.headlineMedium!,
Expand All @@ -258,6 +260,8 @@ Text(
or with `watchSignal`:

```dart
import 'package:flutter_preact_signals/flutter_preact_signals.dart';
Text(
'${watchSignal(context, counter)}',
style: Theme.of(context).textTheme.headlineMedium!,
Expand Down
8 changes: 6 additions & 2 deletions packages/flutter_preact_signals/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -224,7 +224,7 @@ final signal = stream.toSignal(); // or streamToSignal(stream)
To create a `ReadonlySignal` from `ValueListenable`:

```dart
import 'package:preact_signals/preact_signals.dart';
import 'package:flutter_preact_signals/flutter_preact_signals.dart';
import 'package:flutter/material.dart';
final ValueListenable listenable = ValueNotifier(10);
Expand All @@ -236,7 +236,7 @@ final signal = listenable.toSignal(); // or valueListenableToSignal(listenable)
To create a `MutableSignal` from `ValueNotifier`:

```dart
import 'package:preact_signals/preact_signals.dart';
import 'package:flutter_preact_signals/flutter_preact_signals.dart';
import 'package:flutter/material.dart';
final notifier = ValueNotifier(10);
Expand All @@ -249,6 +249,8 @@ final signal = notifier.toSignal(); // or valueNotifierToSignal(notifier)
`StatefulWidget` and `StatelessWidget` widgets can both react to changes on a signal by adding a `watch`` command:

```dart
import 'package:flutter_preact_signals/flutter_preact_signals.dart';
Text(
'${counter.watch(context)}',
style: Theme.of(context).textTheme.headlineMedium!,
Expand All @@ -258,6 +260,8 @@ Text(
or with `watchSignal`:

```dart
import 'package:flutter_preact_signals/flutter_preact_signals.dart';
Text(
'${watchSignal(context, counter)}',
style: Theme.of(context).textTheme.headlineMedium!,
Expand Down

0 comments on commit 3217162

Please sign in to comment.