Added *ensureInitialized* method, Added *mounted* check, Updated *display_metrics_ios*

Author: nukeolay

display_metrics/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 1.1.0
+* Added *ensureInitialized* method
+* Added *mounted* check
+* Updated *display_metrics_ios* dependency (added Spring 2025 iOS devices support: iPhone 16e, iPad Air M3 (7th gen) 11", 13", iPad A16 (11th gen) 11")
+
 ## 1.0.0
 * Added **Linux** platform support
 

display_metrics/README.md

@@ -13,7 +13,7 @@ In the `pubspec.yaml` of your flutter project, add the following dependency:
 
 ```yaml
 dependencies:
-  display_metrics: ^1.0.0
+  display_metrics: ^1.1.0
 ```
 
 In your library add the following import:
@@ -52,7 +52,7 @@ class ExampleApp extends StatelessWidget {
 
 ### DisplayMetricsData
 
-To access DisplayMetricsData you can call 
+To access `DisplayMetricsData` you can call 
 ```dart
 final metrics = DisplayMetrics.maybeOf(context);
 // or
@@ -80,6 +80,8 @@ metrics.inchesToLogicalPixelRatio => double
 metrics.devicePixelRatio => double 
 ```
 
+You can await for `DisplayMetrics.ensureInitialized(context)` to ensure that `DisplayMetricsData` is available.
+
 ### Convert units
 To convert inches and millimeters into Flutter logical pixels and vice versa you can call one of BuildContext extension methods:
 ```dart

display_metrics/coverage/lcov.info

@@ -1,4 +1,4 @@
-SF:lib\src\data.dart
+SF:lib/src/data.dart
 DA:9,6
 DA:22,2
 DA:23,10
@@ -14,9 +14,9 @@ DA:49,1
 DA:50,2
 DA:51,2
 DA:55,3
-DA:58,2
-DA:59,6
-DA:60,6
+DA:58,3
+DA:59,9
+DA:60,9
 DA:61,3
 DA:62,3
 DA:64,1
@@ -29,44 +29,83 @@ DA:71,4
 LF:27
 LH:27
 end_of_record
-SF:lib\src\display_metrics.dart
-DA:7,3
-DA:17,3
-DA:18,6
-DA:22,3
-DA:23,3
-DA:24,3
-DA:25,3
-DA:26,3
-DA:30,2
+SF:lib/src/display_metrics.dart
+DA:9,3
+DA:22,2
+DA:24,2
+DA:25,2
+DA:26,2
+DA:27,2
+DA:31,3
 DA:32,6
-LF:10
-LH:10
+DA:36,3
+DA:37,3
+DA:38,3
+DA:39,3
+DA:40,3
+DA:44,2
+DA:46,6
+LF:15
+LH:15
 end_of_record
-SF:lib\src\display_metrics_widget.dart
-DA:11,1
-DA:23,1
-DA:24,1
-DA:30,1
-DA:32,1
+SF:lib/src/display_metrics_widget.dart
+DA:11,2
+DA:23,2
+DA:24,2
 DA:33,2
-DA:35,1
-DA:37,2
-DA:38,5
-DA:42,1
-DA:46,2
-DA:47,2
+DA:35,2
+DA:36,4
+DA:37,6
+DA:40,2
+DA:42,2
+DA:44,4
+DA:46,8
 DA:49,1
-DA:50,1
-DA:51,1
-DA:56,1
-DA:58,1
-DA:59,1
-DA:60,2
-LF:19
-LH:19
+DA:53,2
+DA:54,2
+DA:55,4
+DA:59,2
+DA:60,3
+DA:61,2
+DA:65,1
+DA:66,1
+DA:67,1
+DA:68,1
+DA:69,1
+DA:73,2
+DA:78,2
+DA:81,1
+DA:82,1
+DA:83,1
+DA:88,2
+DA:90,6
+DA:92,4
+DA:94,4
+DA:96,2
+DA:100,1
+DA:104,1
+DA:109,1
+DA:111,1
+DA:112,3
+DA:114,0
+DA:118,2
+DA:122,4
+DA:123,4
+DA:125,2
+DA:126,2
+DA:127,2
+DA:132,1
+DA:133,2
+DA:134,2
+DA:137,2
+DA:139,2
+DA:140,2
+DA:141,2
+DA:142,4
+LF:53
+LH:52
 end_of_record
-SF:lib\src\extension.dart
+SF:lib/src/extension.dart
 DA:7,1
 DA:8,2
 DA:9,1
@@ -83,11 +122,11 @@ DA:33,1
 DA:34,2
 DA:37,1
 DA:41,2
-DA:48,2
-DA:51,1
-DA:52,3
-DA:53,1
-DA:54,3
+DA:48,3
+DA:51,3
+DA:52,6
+DA:53,3
+DA:54,9
 LF:21
 LH:21
 end_of_record

display_metrics/example/ios/Podfile.lock

@@ -1,5 +1,5 @@
 PODS:
-  - display_metrics_ios (1.0.0):
+  - display_metrics_ios (1.0.3):
     - Flutter
   - Flutter (1.0.0)
 
@@ -14,9 +14,9 @@ EXTERNAL SOURCES:
     :path: Flutter
 
 SPEC CHECKSUMS:
-  display_metrics_ios: 73e907f9d5c3eaa2452cd01e8df878b0e9f9e79d
+  display_metrics_ios: 8cb6c613d3cda282e41488a7139398a1675f27da
   Flutter: e0871f40cf51350855a761d2e70bf5af5b9b5de7
 
 PODFILE CHECKSUM: 10b75cae8b0e4f0acb86c1bf5bf0f50a9a144c71
 
-COCOAPODS: 1.15.2
+COCOAPODS: 1.16.2

display_metrics/example/lib/screens/metrics.dart

@@ -1,19 +1,46 @@
 import 'package:display_metrics/display_metrics.dart';
 import 'package:flutter/material.dart';
 
-class MetricsScreen extends StatelessWidget {
+class MetricsScreen extends StatefulWidget {
   const MetricsScreen({super.key});
 
+  @override
+  State<MetricsScreen> createState() => _MetricsScreenState();
+}
+
+class _MetricsScreenState extends State<MetricsScreen> {
+  bool _isInitializing = true;
+
+  @override
+  void didChangeDependencies() {
+    super.didChangeDependencies();
+    // call DisplayMetrics.ensureInitialized(context) to ensure
+    // DisplayMetricsData has been loaded
+    DisplayMetrics.ensureInitialized(context)?.then((data) {
+      if (_isInitializing) {
+        debugPrint('DisplayMetrics initialized with data [$data]');
+        setState(() {
+          _isInitializing = false;
+        });
+      }
+    });
+  }
+
   @override
   Widget build(BuildContext context) {
-    // call DisplayMetrics.maybeOf(context) or DisplayMetrics.of(context)
-    // to get DisplayMetricsData
-    final metrics = DisplayMetrics.maybeOf(context);
-    if (metrics == null) {
+    // if you want, you can show loading widget
+    // while DisplayMetrics is initializing
+    if (_isInitializing) {
       return const Center(
         child: CircularProgressIndicator(),
       );
     }
+
+    // call DisplayMetrics.maybeOf(context)
+    // or DisplayMetrics.of(context)
+    // to get DisplayMetricsData
+    final metrics = DisplayMetrics.of(context);
+
     return Scaffold(
       appBar: AppBar(
         title: const Text('Display metrics example app'),
@@ -53,7 +80,7 @@ class DisplayInfoWidget extends StatelessWidget {
     super.key,
   });
 
-  final DisplayMetricsData? metrics;
+  final DisplayMetricsData metrics;
 
   @override
   Widget build(BuildContext context) {
@@ -66,29 +93,29 @@ class DisplayInfoWidget extends StatelessWidget {
           children: [
             MetricsLabel(
               title: 'ppi',
-              value: '${metrics?.ppi.toStringAsFixed(0)}',
+              value: metrics.ppi.toStringAsFixed(0),
             ),
             MetricsLabel(
               title: 'devicePixelRatio',
-              value: '${metrics?.devicePixelRatio.toStringAsFixed(0)}',
+              value: metrics.devicePixelRatio.toStringAsFixed(0),
             ),
             MetricsLabel(
               title: 'inchesToLogicalPixelRatio',
-              value: '${metrics?.inchesToLogicalPixelRatio.toStringAsFixed(0)}',
+              value: metrics.inchesToLogicalPixelRatio.toStringAsFixed(0),
             ),
             MetricsLabel(
               title: 'diagonal (inches)',
-              value: '${metrics?.diagonal.toStringAsFixed(2)}',
+              value: metrics.diagonal.toStringAsFixed(2),
             ),
             MetricsLabel(
               title: 'physicalSize (inches)',
-              value: '${metrics?.physicalSize.width.toStringAsFixed(2)} (w) x '
-                  '${metrics?.physicalSize.height.toStringAsFixed(2)} (h)',
+              value: '${metrics.physicalSize.width.toStringAsFixed(2)} (w) x '
+                  '${metrics.physicalSize.height.toStringAsFixed(2)} (h)',
             ),
             MetricsLabel(
               title: 'resolution (pixels)',
-              value: '${metrics?.resolution.width.toStringAsFixed(0)} (w) x '
-                  '${metrics?.resolution.height.toStringAsFixed(0)} (h)',
+              value: '${metrics.resolution.width.toStringAsFixed(0)} (w) x '
+                  '${metrics.resolution.height.toStringAsFixed(0)} (h)',
             ),
           ],
         ),

display_metrics/lib/src/display_metrics.dart

@@ -1,3 +1,5 @@
+import 'dart:async';
+
 import 'package:flutter/widgets.dart';
 import 'package:display_metrics/display_metrics.dart';
 
@@ -7,18 +9,30 @@ class DisplayMetrics extends InheritedWidget {
   const DisplayMetrics({
     required this.data,
     required super.child,
+    Future<DisplayMetricsData>? loadFuture,
     super.key,
-  });
+  }) : _loadFuture = loadFuture;
 
   /// data that contains display metrics
   final DisplayMetricsData? data;
 
-  /// method to get DisplayMetricsData
+  final Future<DisplayMetricsData>? _loadFuture;
+
+  /// method to ensure [DisplayMetricsData] has been loaded
+  static Future<DisplayMetricsData>? ensureInitialized(BuildContext context) {
+    final metrics =
+        context.dependOnInheritedWidgetOfExactType<DisplayMetrics>();
+    final data = metrics?.data;
+    if (data != null) return Future.value(data);
+    return metrics?._loadFuture;
+  }
+
+  /// method to get [DisplayMetricsData]
   static DisplayMetricsData? maybeOf(BuildContext context) {
     return context.dependOnInheritedWidgetOfExactType<DisplayMetrics>()?.data;
   }
 
-  /// method to get DisplayMetricsData
+  /// method to get [DisplayMetricsData]
   static DisplayMetricsData of(BuildContext context) {
     final widget = context.dependOnInheritedWidgetOfExactType<DisplayMetrics>();
     assert(widget != null, 'No DisplayMetrics found in context');