Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/haidar0096/fconnectivity
Connectivity package that contains useful utilities for checking if device is connected to the internet.
https://github.com/haidar0096/fconnectivity
Last synced: 14 days ago
JSON representation
Connectivity package that contains useful utilities for checking if device is connected to the internet.
- Host: GitHub
- URL: https://github.com/haidar0096/fconnectivity
- Owner: Haidar0096
- License: mit
- Created: 2024-10-13T09:41:22.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-10-13T10:07:43.000Z (3 months ago)
- Last Synced: 2024-10-13T13:37:55.797Z (3 months ago)
- Language: C++
- Size: 265 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# fconnectivity
A Flutter package that provides utilities for checking internet connectivity status. It allows developers to easily manage and respond to changes in internet access state within their applications.
## Usage
### Listening to internet access state changes
You can use either the `InternetAccessConsumer` widget or the `InternetAccessListener` class to listen to internet access state changes.
For example:
```dart
// This widget will rebuild whenever the internet access state changes, it will also trigger the onInternetAccessGained and onInternetAccessLost callbacks.
@override
Widget build(BuildContext context) {
return InternetAccessConsumer(
onInternetAccessGained: (context) => print('Internet access gained'),
onInternetAccessLost: (context) => print('Internet access lost'),
// this builder will be called when the internet access state changes
builder: (context, hasInternetAccess) => Text(
'Internet access state: ${hasInternetAccess ? 'Available' : 'Not Available'}',
),
);
}
```
or
```dart
// This widget will not rebuild if the internet access state changes, it will only trigger the onInternetAccessGained and onInternetAccessLost callbacks.
@override
Widget build(BuildContext context) {
return InternetAccessListener(
onInternetAccessGained: (context) => print('Internet access gained'),
onInternetAccessLost: (context) => print('Internet access lost'),
// this widget will not rebuild if the internet access state changes
child: YourWidget(),
);
}
```
or
```dart
// This widget will rebuild whenever the internet access state changes.
@override
Widget build(BuildContext context) {
return InternetAccessBuilder(
// this builder will be called when the internet access state changes
builder: (context, hasInternetAccess) => Text(
'Internet access state: ${hasInternetAccess ? 'Available' : 'Not Available'}',
),
);
}
```
### Configuring the internet access checking process
You can configure the internet access checking process by using the `InternetAccessChecker` class.
For example:
```dart
// Manually trigger an internet access check and notify listeners about the result.
InternetAccessChecker.instance.triggerInternetAccessCheck();
// Set a new interval for periodic internet access checks.
InternetAccessChecker.instance.setInternetAccessCheckInterval(Duration(seconds: 10));
// Set the delay for the internet access check after a connectivity change occurs.
InternetAccessChecker.instance.setPostConnectivityChangeCheckDelay(Duration(seconds: 1));
```
### Disposing resources
If you don't want to use the internet access checking anymore, dispose the resources this way:
```dart
// Dispose the resources used by the service.
InternetAccessChecker.instance.dispose();
```
- You cannot use the package after calling `InternetAccessChecker.instance.dispose();`
### Notes
- No resources will be used by the package until you start listening to internet access state changes by using one of the listener widgets (`InternetAccessConsumer` or `InternetAccessListener`).
## Support Me
If you like my work and would like to support me, consider buying me a coffee:
[](https://www.buymeacoffee.com/haidarmehsen)