Skip to content

Commit

Permalink
rename -> flutter_preact_signals
Browse files Browse the repository at this point in the history
  • Loading branch information
rodydavis committed Nov 21, 2023
1 parent f09d6ac commit c2362a5
Show file tree
Hide file tree
Showing 8 changed files with 101 additions and 41 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ Reacting to signal changes can be done with one extension method: `watch(context

```dart
import 'package:flutter/material.dart';
import 'package:preact_signals_flutter/preact_signals_flutter.dart';
import 'package:flutter_preact_signals/flutter_preact_signals.dart';
void main() {
runApp(const MyApp());
Expand Down Expand Up @@ -135,4 +135,4 @@ class MyHomePage extends StatelessWidget {
);
}
}
```
```
116 changes: 88 additions & 28 deletions packages/flutter_preact_signals/README.md
Original file line number Diff line number Diff line change
@@ -1,39 +1,99 @@
<!--
This README describes the package. If you publish this package to pub.dev,
this README's contents appear on the landing page for your package.
## Example

For information about how to write a good package README, see the guide for
[writing package pages](https://dart.dev/guides/libraries/writing-package-pages).
Reacting to signal changes can be done with one extension method: `watch(context)`:

For general information about developing packages, see the Dart guide for
[creating packages](https://dart.dev/guides/libraries/create-library-packages)
and the Flutter guide for
[developing packages and plugins](https://flutter.dev/developing-packages).
-->
```dart
import 'package:flutter/material.dart';
import 'package:flutter_preact_signals/flutter_preact_signals.dart';
TODO: Put a short description of the package here that helps potential users
know whether this package might be useful for them.
void main() {
runApp(const MyApp());
}
## Features
final brightness = signal(Brightness.light);
final counter = signal(0);
TODO: List what your package can do. Maybe include images, gifs, or videos.
class MyApp extends StatelessWidget {
const MyApp({super.key});
## Getting started
@override
Widget build(BuildContext context) {
return MaterialApp(
title: 'Flutter Demo',
debugShowCheckedModeBanner: false,
theme: ThemeData(
colorScheme: ColorScheme.fromSeed(
seedColor: Colors.deepPurple,
brightness: Brightness.light,
),
brightness: Brightness.light,
useMaterial3: true,
),
darkTheme: ThemeData(
colorScheme: ColorScheme.fromSeed(
seedColor: Colors.deepPurple,
brightness: Brightness.dark,
),
brightness: Brightness.dark,
useMaterial3: true,
),
themeMode: brightness.watch(context) == Brightness.dark
? ThemeMode.dark
: ThemeMode.light,
home: const MyHomePage(title: 'Flutter Demo Home Page'),
);
}
}
TODO: List prerequisites and provide or point to information on how to
start using the package.
class MyHomePage extends StatelessWidget {
const MyHomePage({super.key, required this.title});
## Usage
final String title;
TODO: Include short and useful examples for package users. Add longer examples
to `/example` folder.
void _incrementCounter() {
counter.value++;
}
```dart
const like = 'sample';
@override
Widget build(BuildContext context) {
return Scaffold(
appBar: AppBar(
title: Text(title),
actions: [
IconButton(
onPressed: () {
brightness.value = brightness() == Brightness.dark
? Brightness.light
: Brightness.dark;
},
icon: Icon(brightness() == Brightness.dark
? Icons.light_mode
: Icons.dark_mode),
),
],
),
body: Center(
child: Column(
mainAxisAlignment: MainAxisAlignment.center,
children: <Widget>[
const Text(
'You have pushed the button this many times:',
),
Text(
'${counter.watch(context)}',
style: Theme.of(context).textTheme.headlineMedium!.copyWith(
color: Theme.of(context).colorScheme.onSurface,
),
),
],
),
),
floatingActionButton: FloatingActionButton(
onPressed: _incrementCounter,
tooltip: 'Increment',
child: const Icon(Icons.add),
),
);
}
}
```

## Additional information

TODO: Tell users more about the package: where to find more information, how to
contribute to the package, how to file issues, what response they can expect
from the package authors, and more.
2 changes: 1 addition & 1 deletion packages/flutter_preact_signals/example/lib/main.dart
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import 'package:flutter/material.dart';
import 'package:preact_signals_flutter/preact_signals_flutter.dart';
import 'package:flutter_preact_signals/flutter_preact_signals.dart';

void main() {
runApp(const MyApp());
Expand Down
14 changes: 7 additions & 7 deletions packages/flutter_preact_signals/example/pubspec.lock
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,13 @@ packages:
url: "https://pub.dev"
source: hosted
version: "2.0.3"
flutter_preact_signals:
dependency: "direct main"
description:
path: ".."
relative: true
source: path
version: "0.0.1"
flutter_test:
dependency: "direct dev"
description: flutter
Expand Down Expand Up @@ -122,13 +129,6 @@ packages:
relative: true
source: path
version: "0.0.1"
preact_signals_flutter:
dependency: "direct main"
description:
path: ".."
relative: true
source: path
version: "0.0.1"
sky_engine:
dependency: transitive
description: flutter
Expand Down
2 changes: 1 addition & 1 deletion packages/flutter_preact_signals/example/pubspec.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ dependencies:
flutter:
sdk: flutter
cupertino_icons: ^1.0.2
preact_signals_flutter:
flutter_preact_signals:
path: ..

dev_dependencies:
Expand Down
2 changes: 1 addition & 1 deletion packages/flutter_preact_signals/lib/src/watch.dart
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import 'package:flutter/material.dart';
import 'package:preact_signals_flutter/preact_signals_flutter.dart';
import 'package:preact_signals/preact_signals.dart';

extension SignalUtils<T> on ReadonlySignal<T> {
T watch(BuildContext context) {
Expand Down
2 changes: 1 addition & 1 deletion packages/flutter_preact_signals/pubspec.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: preact_signals_flutter
name: flutter_preact_signals
description: Preact signals in flutter with widget helpers
version: 0.0.1

Expand Down

0 comments on commit c2362a5

Please sign in to comment.