-
-
Notifications
You must be signed in to change notification settings - Fork 119
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add new listener builder widget #56
Open
iamsahilsonawane
wants to merge
1
commit into
jogboms:master
Choose a base branch
from
iamsahilsonawane:master
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+153
−1
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
import 'package:flutter/material.dart'; | ||
import 'package:flutter_offline/flutter_offline.dart'; | ||
|
||
class Demo4 extends StatelessWidget { | ||
const Demo4({Key? key}) : super(key: key); | ||
|
||
@override | ||
Widget build(BuildContext context) { | ||
return OfflineListener( | ||
debounceDuration: Duration.zero, | ||
listenWhen: (c) => c == ConnectivityResult.mobile, | ||
listenerBuilder: (context, connectivity) { | ||
// for ex showing a snackbar when using mobile internet if app is downloading something big. | ||
ScaffoldMessenger.of(context).showSnackBar(const SnackBar( | ||
content: Text( | ||
'Alert: Switched to mobile internet, consider switching to wifi instead.'))); | ||
}, | ||
child: Center( | ||
child: Column( | ||
mainAxisAlignment: MainAxisAlignment.center, | ||
children: const <Widget>[ | ||
Text( | ||
'There are no bottons to push :)', | ||
), | ||
Text( | ||
'Try switching your internet to wifi and mobile data', | ||
), | ||
], | ||
), | ||
), | ||
); | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,7 @@ | ||
library flutter_offline; | ||
|
||
export 'package:connectivity_plus/connectivity_plus.dart' show ConnectivityResult; | ||
export 'package:connectivity_plus/connectivity_plus.dart' | ||
show ConnectivityResult; | ||
|
||
export 'src/main.dart'; | ||
export 'src/offline_listener.dart'; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,110 @@ | ||
import 'dart:async'; | ||
|
||
import 'package:connectivity_plus/connectivity_plus.dart'; | ||
import 'package:flutter/widgets.dart'; | ||
import 'package:flutter_offline/src/utils.dart'; | ||
import 'package:network_info_plus/network_info_plus.dart'; | ||
|
||
import 'main.dart'; | ||
|
||
typedef ListenerBuilder<T> = void Function(BuildContext context, T value); | ||
typedef ListenWhen<T> = bool Function(ConnectivityResult); | ||
|
||
class OfflineListener extends StatefulWidget { | ||
factory OfflineListener({ | ||
Key? key, | ||
required Widget child, | ||
ListenWhen? listenWhen, | ||
Duration debounceDuration = kOfflineDebounceDuration, | ||
ListenerBuilder<ConnectivityResult>? listenerBuilder, | ||
WidgetBuilder? errorBuilder, | ||
}) { | ||
return OfflineListener.initialize( | ||
key: key, | ||
connectivityService: Connectivity(), | ||
wifiInfo: NetworkInfo(), | ||
debounceDuration: debounceDuration, | ||
errorBuilder: errorBuilder, | ||
listenWhen: listenWhen, | ||
listenerBuilder: listenerBuilder, | ||
child: child, | ||
); | ||
} | ||
|
||
@visibleForTesting | ||
const OfflineListener.initialize({ | ||
Key? key, | ||
required this.connectivityService, | ||
required this.wifiInfo, | ||
required this.child, | ||
this.listenWhen, | ||
this.listenerBuilder, | ||
this.debounceDuration = kOfflineDebounceDuration, | ||
this.errorBuilder, | ||
}) : super(key: key); | ||
|
||
/// Override connectivity service used for testing | ||
final Connectivity connectivityService; | ||
|
||
/// Specify when to listen | ||
final ListenWhen? listenWhen; | ||
|
||
/// Listen to new updates on connectivity. Only notifies when listenWhen returns true. | ||
/// | ||
/// If listenWhen is null, will listen to all updates. | ||
final ListenerBuilder<ConnectivityResult>? listenerBuilder; | ||
|
||
final NetworkInfo wifiInfo; | ||
|
||
/// Debounce duration from epileptic network situations | ||
final Duration debounceDuration; | ||
|
||
/// The widget below this widget in the tree. | ||
final Widget child; | ||
|
||
/// Used for building the error widget incase of any platform errors | ||
final WidgetBuilder? errorBuilder; | ||
|
||
@override | ||
OfflineListenerState createState() => OfflineListenerState(); | ||
} | ||
|
||
class OfflineListenerState extends State<OfflineListener> { | ||
late Stream<ConnectivityResult> _connectivityStream; | ||
|
||
@override | ||
void initState() { | ||
super.initState(); | ||
|
||
_connectivityStream = | ||
Stream.fromFuture(widget.connectivityService.checkConnectivity()) | ||
.asyncExpand((data) => widget | ||
.connectivityService.onConnectivityChanged | ||
.transform(startsWith(data))) | ||
.transform(debounce(widget.debounceDuration)); | ||
|
||
_listenToChanges(); | ||
} | ||
|
||
void _listenToChanges() { | ||
_connectivityStream.listen((data) { | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Can you dispose of this subscription? |
||
if (widget.listenWhen?.call(data) ?? true) { | ||
widget.listenerBuilder?.call(context, data); | ||
} | ||
}); | ||
} | ||
|
||
@override | ||
Widget build(BuildContext context) { | ||
return widget.child; | ||
} | ||
} | ||
|
||
class OfflineListenerError extends Error { | ||
OfflineListenerError(this.error); | ||
|
||
final Object error; | ||
|
||
@override | ||
String toString() => error.toString(); | ||
} |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you add this to the README?