Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/silentcatd/night_reader
Package for implementing night reader feature in Flutter app. Suitable for book apps, blogs apps,... or any app of sort that need this feature.
https://github.com/silentcatd/night_reader
Last synced: 8 days ago
JSON representation
Package for implementing night reader feature in Flutter app. Suitable for book apps, blogs apps,... or any app of sort that need this feature.
- Host: GitHub
- URL: https://github.com/silentcatd/night_reader
- Owner: SilentCatD
- License: other
- Created: 2023-01-23T19:45:38.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-01-24T00:20:12.000Z (almost 2 years ago)
- Last Synced: 2023-08-09T13:59:35.508Z (over 1 year ago)
- Language: Dart
- Homepage:
- Size: 9.35 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://pub.dev/packages/night_reader)
Package that implement the Night Light/ Night Reader effect in Flutter. Suitable for apps that need
this feature. ex: book apps, blog apps, ...
Do note that this package has nothing (yet) to do with the OS/native's nightlight. It's simply make
it's subtree under the effect of night reader.
## Features
* Apply controllable night reader effect on this widget subtree.
* There can be many instance of this widget in the tree, each with their own night reader effect
color, animation, parameters,...
## Getting started
- First import it:
```dart
import 'package:night_reader/night_reader.dart';
```
## Usage
To make the whole app under the effect, one can simply wrap this widget around `MaterialApp` and
control the `value` parameter and the whole app will be affected.
```dart
@override
Widget build(BuildContext context) {
return AnimatedNightReader(
value: 1,
duration: const Duration(seconds: 2),
child: MaterialApp(
title: 'Flutter Demo',
theme: ThemeData(primarySwatch: Colors.blue),
home: const MyHomePage(title: 'Flutter Demo Home Page'),
),
);
}
```
To only apply the effect to a particular subtree, one can wrap this widget where needed.
```dart
@override
Widget build(BuildContext context) {
return Scaffold(
appBar: AppBar(),
body: Center(
child: Column(
crossAxisAlignment: CrossAxisAlignment.center,
children: [
AnimatedNightReader(
tint: Colors.blue,
value: value1,
duration: const Duration(seconds: 2),
child: Container(
height: 300,
width: 300,
color: Colors.white,
alignment: Alignment.center,
child: const Text("Sub tree 1"),
),
),
AnimatedNightReader(
value: value2,
tint: Colors.red,
duration: const Duration(seconds: 2),
child: Container(
height: 300,
width: 300,
color: Colors.white,
alignment: Alignment.center,
child: const Text("Sub tree 2"),
),
),
],
),
),
);
}
```
This package come with `AnimatedNightReader`, which will automatically animate between value `[0-1]`
when changing the properties, other property animation is also supported.
But if one's needs arisen. They can control the not-animated version of this widget: `NightReader`,
through any method that trigger a `rebuild`.
For more information on each property, please do see the document.