mirror of
https://github.com/flutter/flutter.git
synced 2025-06-03 00:51:18 +00:00

Deprecate `textScaleFactor` in favor of `textScaler`, in preparation for Android 14 [Non-linear font scaling to 200%](https://developer.android.com/about/versions/14/features#non-linear-font-scaling). The `TextScaler` class can be moved to `dart:ui` in the future, if we decide to use the Android platform API or AndroidX to get the scaling curve instead of hard coding the curve in the framework. I haven't put the Flutter version in the deprecation message so the analyzer checks are failing. Will do so after I finish the migration guide. **Why `TextScaler.textScaleFactor`** The author of a `TextScaler` subclass should provide a fallback `textScaleFactor`. By making `TextScaler` also contain the `textScaleFactor` information it also makes it easier to migrate: if a widget overrides `MediaQueryData.textScaler` in the tree, for unmigrated widgets in the subtree it would also have to override `MediaQueryData.textScaleFactor`, and that makes it difficult to remove `MediaQueryData.textScaleFactor` in the future. ## A full list of affected APIs in this PR Deprecated: The method/getter/setter/argument is annotated with a `@Deprecated()` annotation in this PR, and the caller should replace it with `textScaler` instead. Unless otherwise specified there will be a Flutter fix available to help with migration but it's still recommended to migrate case-by-case. **Replaced**: The method this `textScaleFactor` argument belongs to is rarely called directly by user code and is not overridden by any of the registered custom tests, so the argument is directly replaced by `TextScaler`. **To Be Deprecated**: The method/getter/setter/argument can't be deprecated in this PR because a registered customer test depends on it and a Flutter fix isn't available (or the test was run without applying flutter fixes first). This method/getter/setter/argument will be deprecated in a followup PR once the registered test is migrated. ### `Painting` Library | Affected API | State of `textScaleFactor` | Comment | | --- | --- | --- | | `InlineSpan.build({ double textScaleFactor = 1.0 })` argument | **Replaced** | | | `TextStyle.getParagraphStyle({ double TextScaleFactor = 1.0 })` argument | **Replaced** | | | `TextStyle.getTextStyle({ double TextScaleFactor = 1.0 })` argument| Deprecated | Can't replace:c47fd38dca/super_editor/lib/src/infrastructure/super_textfield/desktop/desktop_textfield.dart (L1903-L1905)
| | `TextPainter({ double TextScaleFactor = 1.0 })` constructor argument | Deprecated | | | `TextPainter.textScaleFactor` getter and setter | Deprecated | No Flutter Fix, not expressible yet | | `TextPainter.computeWidth({ double TextScaleFactor = 1.0 })` argument | Deprecated | | | `TextPainter.computeMaxIntrinsicWidth({ double TextScaleFactor = 1.0 })` argument | Deprecated | | ### `Rendering` Library | Affected API | State of `textScaleFactor` | Comment | | --- | --- | --- | | `RenderEditable({ double TextScaleFactor = 1.0 })` constructor argument | Deprecated | | | `RenderEditable.textScaleFactor` getter and setter | Deprecated | No Flutter Fix, not expressible yet | | `RenderParagraph({ double TextScaleFactor = 1.0 })` constructor argument | Deprecated | | | `RenderParagraph.textScaleFactor` getter and setter | Deprecated | No Flutter Fix, not expressible yet | ### `Widgets` Library | Affected API | State of `textScaleFactor` | Comment | | --- | --- | --- | | `MediaQueryData({ double TextScaleFactor = 1.0 })` constructor argument | **To Be Deprecated** |cd7b93532e/packages/flutter_markdown/test/text_scale_factor_test.dart (LL39C21-L39C35)
| | `MediaQueryData.textScaleFactor` getter | Deprecated | | | `MediaQueryData.copyWith({ double? TextScaleFactor })` argument | Deprecated | | | `MediaQuery.maybeTextScaleFactorOf(BuildContext context)` static method | Deprecated | No Flutter Fix, not expressible yet | | `MediaQuery.textScaleFactorOf(BuildContext context)` static method | **To Be Deprecated** |cd7b93532e/packages/flutter_markdown/lib/src/_functions_io.dart (L68-L70)
, No Flutter Fix, not expressible yet | | `RichText({ double TextScaleFactor = 1.0 })` constructor argument | **To Be Deprecated** |cd7b93532e/packages/flutter_markdown/lib/src/builder.dart (L829-L843)
| | `RichText.textScaleFactor` getter | **To Be Deprecated** | A constructor argument can't be deprecated right away| | `Text({ double? TextScaleFactor = 1.0 })` constructor argument | **To Be Deprecated** |914d120da1/packages/rfw/lib/src/flutter/core_widgets.dart (L647)
, No Flutter Fix because of https://github.com/dart-lang/sdk/issues/52664 | | `Text.rich({ double? TextScaleFactor = 1.0 })` constructor argument | **To Be Deprecated** | The default constructor has an argument that can't be deprecated right away. No Flutter Fix because of https://github.com/dart-lang/sdk/issues/52664 | | `Text.textScaleFactor` getter | **To Be Deprecated** | A constructor argument can't be deprecated right away | | `EditableText({ double? TextScaleFactor = 1.0 })` constructor argument | Deprecated | No Flutter Fix because of https://github.com/dart-lang/sdk/issues/52664 | | `EditableText.textScaleFactor` getter | Deprecated | | ### `Material` Library | Affected API | State of `textScaleFactor` | Comment | | --- | --- | --- | | `SelectableText({ double? TextScaleFactor = 1.0 })` constructor argument | **To Be Deprecated** |cd7b93532e/packages/flutter_markdown/lib/src/builder.dart (L829-L843)
, No Flutter Fix because of https://github.com/dart-lang/sdk/issues/52664 | | `SelectableText.rich({ double? TextScaleFactor = 1.0 })` constructor argument | **To Be Deprecated** | The default constructor has an argument that can't be deprecated right away. No Flutter Fix because of https://github.com/dart-lang/sdk/issues/52664 | | `SelectableText.textScaleFactor` getter | **To Be Deprecated** | A constructor argument can't be deprecated right away | A lot of material widgets (`Slider`, `RangeSlider`, `TimePicker`, and different types of buttons) also change their layout based on `textScaleFactor`. These need to be handled in a case-by-case fashion and will be migrated in follow-up PRs.
177 lines
5.9 KiB
Dart
177 lines
5.9 KiB
Dart
// Copyright 2014 The Flutter Authors. All rights reserved.
|
|
// Use of this source code is governed by a BSD-style license that can be
|
|
// found in the LICENSE file.
|
|
|
|
import 'dart:async';
|
|
|
|
import 'package:flutter/cupertino.dart';
|
|
import 'package:flutter/foundation.dart' show defaultTargetPlatform;
|
|
import 'package:flutter/material.dart';
|
|
import 'package:flutter/scheduler.dart' show timeDilation;
|
|
import 'package:scoped_model/scoped_model.dart';
|
|
import 'package:url_launcher/url_launcher.dart';
|
|
|
|
import '../demo/shrine/model/app_state_model.dart';
|
|
import 'demos.dart';
|
|
import 'home.dart';
|
|
import 'options.dart';
|
|
import 'scales.dart';
|
|
import 'themes.dart';
|
|
import 'updater.dart';
|
|
|
|
class GalleryApp extends StatefulWidget {
|
|
const GalleryApp({
|
|
super.key,
|
|
this.updateUrlFetcher,
|
|
this.enablePerformanceOverlay = true,
|
|
this.enableRasterCacheImagesCheckerboard = true,
|
|
this.enableOffscreenLayersCheckerboard = true,
|
|
this.onSendFeedback,
|
|
this.testMode = false,
|
|
});
|
|
|
|
final UpdateUrlFetcher? updateUrlFetcher;
|
|
final bool enablePerformanceOverlay;
|
|
final bool enableRasterCacheImagesCheckerboard;
|
|
final bool enableOffscreenLayersCheckerboard;
|
|
final VoidCallback? onSendFeedback;
|
|
final bool testMode;
|
|
|
|
@override
|
|
State<GalleryApp> createState() => _GalleryAppState();
|
|
}
|
|
|
|
class _GalleryAppState extends State<GalleryApp> {
|
|
GalleryOptions? _options;
|
|
Timer? _timeDilationTimer;
|
|
late final AppStateModel model = AppStateModel()..loadProducts();
|
|
|
|
Map<String, WidgetBuilder> _buildRoutes() {
|
|
// For a different example of how to set up an application routing table
|
|
// using named routes, consider the example in the Navigator class documentation:
|
|
// https://api.flutter.dev/flutter/widgets/Navigator-class.html
|
|
return <String, WidgetBuilder>{
|
|
for (final GalleryDemo demo in kAllGalleryDemos) demo.routeName: demo.buildRoute,
|
|
};
|
|
}
|
|
|
|
@override
|
|
void initState() {
|
|
super.initState();
|
|
_options = GalleryOptions(
|
|
themeMode: ThemeMode.system,
|
|
textScaleFactor: kAllGalleryTextScaleValues[0],
|
|
visualDensity: kAllGalleryVisualDensityValues[0],
|
|
timeDilation: timeDilation,
|
|
platform: defaultTargetPlatform,
|
|
);
|
|
}
|
|
|
|
@override
|
|
void reassemble() {
|
|
_options = _options!.copyWith(platform: defaultTargetPlatform);
|
|
super.reassemble();
|
|
}
|
|
|
|
@override
|
|
void dispose() {
|
|
_timeDilationTimer?.cancel();
|
|
_timeDilationTimer = null;
|
|
super.dispose();
|
|
}
|
|
|
|
void _handleOptionsChanged(GalleryOptions newOptions) {
|
|
setState(() {
|
|
if (_options!.timeDilation != newOptions.timeDilation) {
|
|
_timeDilationTimer?.cancel();
|
|
_timeDilationTimer = null;
|
|
if (newOptions.timeDilation > 1.0) {
|
|
// We delay the time dilation change long enough that the user can see
|
|
// that UI has started reacting and then we slam on the brakes so that
|
|
// they see that the time is in fact now dilated.
|
|
_timeDilationTimer = Timer(const Duration(milliseconds: 150), () {
|
|
timeDilation = newOptions.timeDilation;
|
|
});
|
|
} else {
|
|
timeDilation = newOptions.timeDilation;
|
|
}
|
|
}
|
|
|
|
_options = newOptions;
|
|
});
|
|
}
|
|
|
|
Widget _applyTextScaleFactor(Widget child) {
|
|
return Builder(
|
|
builder: (BuildContext context) {
|
|
final double? textScaleFactor = _options!.textScaleFactor!.scale;
|
|
return MediaQuery.withClampedTextScaling(
|
|
minScaleFactor: textScaleFactor ?? 0.0,
|
|
maxScaleFactor: textScaleFactor ?? double.infinity,
|
|
child: child,
|
|
);
|
|
},
|
|
);
|
|
}
|
|
|
|
@override
|
|
Widget build(BuildContext context) {
|
|
Widget home = GalleryHome(
|
|
testMode: widget.testMode,
|
|
optionsPage: GalleryOptionsPage(
|
|
options: _options,
|
|
onOptionsChanged: _handleOptionsChanged,
|
|
onSendFeedback: widget.onSendFeedback ?? () {
|
|
launchUrl(Uri.parse('https://github.com/flutter/flutter/issues/new/choose'), mode: LaunchMode.externalApplication);
|
|
},
|
|
),
|
|
);
|
|
|
|
if (widget.updateUrlFetcher != null) {
|
|
home = Updater(
|
|
updateUrlFetcher: widget.updateUrlFetcher!,
|
|
child: home,
|
|
);
|
|
}
|
|
|
|
return ScopedModel<AppStateModel>(
|
|
model: model,
|
|
child: MaterialApp(
|
|
// The automatically applied scrollbars on desktop can cause a crash for
|
|
// demos where many scrollables are all attached to the same
|
|
// PrimaryScrollController. The gallery needs to be migrated before
|
|
// enabling this. https://github.com/flutter/gallery/issues/523
|
|
scrollBehavior: const MaterialScrollBehavior().copyWith(scrollbars: false),
|
|
theme: kLightGalleryTheme.copyWith(platform: _options!.platform, visualDensity: _options!.visualDensity!.visualDensity),
|
|
darkTheme: kDarkGalleryTheme.copyWith(platform: _options!.platform, visualDensity: _options!.visualDensity!.visualDensity),
|
|
themeMode: _options!.themeMode,
|
|
title: 'Flutter Gallery',
|
|
color: Colors.grey,
|
|
showPerformanceOverlay: _options!.showPerformanceOverlay,
|
|
checkerboardOffscreenLayers: _options!.showOffscreenLayersCheckerboard,
|
|
checkerboardRasterCacheImages: _options!.showRasterCacheImagesCheckerboard,
|
|
routes: _buildRoutes(),
|
|
builder: (BuildContext context, Widget? child) {
|
|
return Directionality(
|
|
textDirection: _options!.textDirection,
|
|
child: _applyTextScaleFactor(
|
|
// Specifically use a blank Cupertino theme here and do not transfer
|
|
// over the Material primary color etc except the brightness to
|
|
// showcase standard iOS looks.
|
|
Builder(builder: (BuildContext context) {
|
|
return CupertinoTheme(
|
|
data: CupertinoThemeData(
|
|
brightness: Theme.of(context).brightness,
|
|
),
|
|
child: child!,
|
|
);
|
|
}),
|
|
),
|
|
);
|
|
},
|
|
home: home,
|
|
),
|
|
);
|
|
}
|
|
}
|