Merge pull request #535 from joker-fu/main

support for disabling scaling. Fixes #534 #459

Merge pull request #535 from joker-fu/main
support for disabling scaling. Fixes #534 #459
Mounir Bouaiche · GitHub
Commit 3ed93135ebe41a2a340bde1189d406c48eef92a5 3ed93135 2 parents 1c355fca aeca7354
Showing 3 changed files with 47 additions and 6 deletions
README.md
lib/src/screen_util.dart
lib/src/screenutil_init.dart
--- a/README.md
View file @3ed9313
+++ b/README.md
View file @3ed9313
@@ -41,7 +41,7 @@ import 'package:flutter_screenutil/flutter_screenutil.dart';
 ### Properties
 | Property          | Type             | Default Value | Description                                                                                                                                   |
-| ----------------- | ---------------- | ------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
+| ----------------- | ---------------- | ------------- |-----------------------------------------------------------------------------------------------------------------------------------------------|
 | designSize        | Size             | Size(360,690) | The size of the device screen in the design draft, in dp                                                                                      |
 | builder           | Function         | null          | Return widget that uses the library in a property (ex: MaterialApp's theme)                                                                   |
 | child             | Widget           | null          | A part of builder that its dependencies/properties don't use the library                                                                      |
@@ -52,6 +52,8 @@ import 'package:flutter_screenutil/flutter_screenutil.dart';
 | fontSizeResolver  | Function         | _default_     | Function that specify how font size should be adapted. Default is that font size scale with width of screen.                                  |
 | responsiveWidgets | Iterable<String> | null          | List/Set of widget names that should be included in rebuilding tree. (See [How flutter_screenutil marks a widget needs build](#rebuild-list)) |
 | excludeWidgets    | Iterable<String> | null          | List/Set of widget names that should be excluded from rebuilding tree.                                                                        |
+| enableScaleWH    | Function | null          | Support enable scale width and height.                                                                                                        |
+| enableScaleText    | Function | null          | Support enable scale text.                                                                                                                    |
 **Note : You must either provide builder, child or both.**
@@ -184,6 +186,25 @@ class _HomePageState extends State<HomePage> {
 ### API
+#### Enable or disable scale
+
+```dart
+  Widget build(BuildContext context) {
+    return ScreenUtilInit(
+      enableScaleWH: ()=>false,
+      enableScaleText: ()=>false,
+      //...
+    );
+  }
+```
+
+or
+
+```dart
+ScreenUtil.enableScale(enableWH: () => false, enableText: () => false);
+```
+
+
 #### Pass the dp size of the design draft
 ```dart
--- a/lib/src/screen_util.dart
View file @3ed9313
+++ b/lib/src/screen_util.dart
View file @3ed9313
@@ -16,6 +16,10 @@ class ScreenUtil {
   static const Size defaultSize = Size(360, 690);
   static ScreenUtil _instance = ScreenUtil._();
+  static bool Function() _enableScaleWH = () => true;
+  static bool Function() _enableScaleText = () => true;
+
+
   /// UI设计中手机尺寸 , dp
   /// Size of the phone in UI Design , dp
   late Size _uiSize;
@@ -32,6 +36,16 @@ class ScreenUtil {
   factory ScreenUtil() => _instance;
+  /// Enable scale
+  ///
+  /// if the enableWH return false, the width and the height scale ratio will be 1
+  /// if the enableText return false, the text scale ratio will be 1
+  ///
+  static void enableScale({bool Function()? enableWH, bool Function()? enableText}) {
+    _enableScaleWH = enableWH ?? () => true;
+    _enableScaleText = enableText ?? () => true;
+  }
+
   /// Manually wait for window size to be initialized
   ///
   /// `Recommended` to use before you need access window size
@@ -199,15 +213,15 @@ class ScreenUtil {
   /// 实际尺寸与UI设计的比例
   /// The ratio of actual width to UI design
-  double get scaleWidth => screenWidth / _uiSize.width;
+  double get scaleWidth => !_enableScaleWH() ? 1 : screenWidth / _uiSize.width;
   /// The ratio of actual height to UI design
   double get scaleHeight =>
-      (_splitScreenMode ? max(screenHeight, 700) : screenHeight) /
+      !_enableScaleWH() ? 1 : (_splitScreenMode ? max(screenHeight, 700) : screenHeight) /
       _uiSize.height;
   double get scaleText =>
-      _minTextAdapt ? min(scaleWidth, scaleHeight) : scaleWidth;
+      !_enableScaleText() ? 1 : (_minTextAdapt ? min(scaleWidth, scaleHeight) : scaleWidth);
   /// 根据UI设计的设备宽度适配
   /// 高度也可以根据这个来做适配可以保证不变形,比如你想要一个正方形的时候.
--- a/lib/src/screenutil_init.dart
View file @3ed9313
+++ b/lib/src/screenutil_init.dart
View file @3ed9313
@@ -74,6 +74,8 @@ class ScreenUtilInit extends StatefulWidget {
     this.minTextAdapt = false,
     this.useInheritedMediaQuery = false,
     this.ensureScreenSize = false,
+    this.enableScaleWH,
+    this.enableScaleText,
     this.responsiveWidgets,
     this.excludeWidgets,
     this.fontSizeResolver = FontSizeResolvers.width,
@@ -85,6 +87,8 @@ class ScreenUtilInit extends StatefulWidget {
   final bool minTextAdapt;
   final bool useInheritedMediaQuery;
   final bool ensureScreenSize;
+  final bool Function()? enableScaleWH;
+  final bool Function()? enableScaleText;
   final RebuildFactor rebuildFactor;
   final FontSizeResolver fontSizeResolver;
@@ -97,8 +101,7 @@ class ScreenUtilInit extends StatefulWidget {
   State<ScreenUtilInit> createState() => _ScreenUtilInitState();
 }
-class _ScreenUtilInitState extends State<ScreenUtilInit>
-    with WidgetsBindingObserver {
+class _ScreenUtilInitState extends State<ScreenUtilInit> with WidgetsBindingObserver {
   final _canMarkedToBuild = HashSet<String>();
   final _excludedWidgets = HashSet<String>();
   MediaQueryData? _mediaQueryData;
@@ -110,6 +113,9 @@ class _ScreenUtilInitState extends State<ScreenUtilInit>
     if (widget.responsiveWidgets != null) {
       _canMarkedToBuild.addAll(widget.responsiveWidgets!);
     }
+
+    ScreenUtil.enableScale(enableWH: widget.enableScaleWH, enableText: widget.enableScaleText);
+
     _validateSize().then(_screenSizeCompleter.complete);
     super.initState();