docs(connectivity_plus): document in README, example app, and the hasConnectivity extension getter

Author: EchoEllet

packages/connectivity_plus/connectivity_plus/README.md

@@ -40,6 +40,11 @@ import 'package:connectivity_plus/connectivity_plus.dart';
 
 final List<ConnectivityResult> connectivityResult = await (Connectivity().checkConnectivity());
 
+// Determines whether any active network connection exists.
+if (connectivityResult.hasConnectivity) {
+  // Connectivity available (regardless of the underlying transport).
+}
+
 // This condition is for demo purposes only to explain every connection type.
 // Use conditions which work for your requirements.
 if (connectivityResult.contains(ConnectivityResult.mobile)) {

packages/connectivity_plus/connectivity_plus/example/lib/main.dart

@@ -101,6 +101,10 @@ class _MyHomePageState extends State<MyHomePage> {
         mainAxisSize: MainAxisSize.min,
         children: [
           const Spacer(flex: 2),
+          Text(_connectionStatus.hasConnectivity
+              ? 'Connectivity available'
+              : 'No connectivity'),
+          const Spacer(flex: 2),
           Text(
             'Active connection types:',
             style: Theme.of(context).textTheme.headlineMedium,

packages/connectivity_plus/connectivity_plus/lib/connectivity_plus.dart

@@ -41,20 +41,10 @@ class Connectivity {
   /// status changes, this is a known issue that only affects simulators.
   /// For details see https://github.com/fluttercommunity/plus_plugins/issues/479.
   ///
-  /// The emitted list is never empty.
-  /// {@template no_connectivity_case}
-  /// In case of no connectivity, the list contains
+  /// The emitted list is never empty. In case of no connectivity, the list contains
   /// a single element of [ConnectivityResult.none]. Note also that this is the only
   /// case where [ConnectivityResult.none] is present.
   ///
-  /// Use `hasConnectivity` to determine whether any active network connection exists:
-  ///
-  /// ```dart
-  /// final result = await checkConnectivity();
-  /// print(result.hasConnectivity);
-  /// ```
-  /// {@endtemplate}
-  ///
   /// This method applies [Stream.distinct] over the received events to ensure
   /// only emitting when connectivity changes.
   Stream<List<ConnectivityResult>> get onConnectivityChanged {
@@ -67,8 +57,9 @@ class Connectivity {
   /// make a network request, it only gives you the radio status. Instead, listen
   /// for connectivity changes via [onConnectivityChanged] stream.
   ///
-  /// The returned list is never empty.
-  /// {@macro no_connectivity_case}
+  /// The returned list is never empty. In case of no connectivity, the list contains
+  /// a single element of [ConnectivityResult.none]. Note also that this is the only
+  /// case where [ConnectivityResult.none] is present.
   Future<List<ConnectivityResult>> checkConnectivity() {
     return _platform.checkConnectivity();
   }

packages/connectivity_plus/connectivity_plus_platform_interface/lib/src/enums.dart

@@ -38,6 +38,7 @@ enum ConnectivityResult {
 }
 
 extension ConnectivityResultListX on List<ConnectivityResult> {
+  /// Returns whether any active network connection exists.
   bool get hasConnectivity =>
       !(length == 1 && first == ConnectivityResult.none);
 }