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.
359 lines
11 KiB
Dart
359 lines
11 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 'package:flutter/material.dart';
|
|
|
|
/// Flutter code sample for [showTimePicker].
|
|
|
|
void main() {
|
|
runApp(const ShowTimePickerApp());
|
|
}
|
|
|
|
class ShowTimePickerApp extends StatefulWidget {
|
|
const ShowTimePickerApp({super.key});
|
|
|
|
@override
|
|
State<ShowTimePickerApp> createState() => _ShowTimePickerAppState();
|
|
}
|
|
|
|
class _ShowTimePickerAppState extends State<ShowTimePickerApp> {
|
|
ThemeMode themeMode = ThemeMode.dark;
|
|
bool useMaterial3 = true;
|
|
|
|
void setThemeMode(ThemeMode mode) {
|
|
setState(() {
|
|
themeMode = mode;
|
|
});
|
|
}
|
|
|
|
void setUseMaterial3(bool? value) {
|
|
setState(() {
|
|
useMaterial3 = value!;
|
|
});
|
|
}
|
|
|
|
@override
|
|
Widget build(BuildContext context) {
|
|
return MaterialApp(
|
|
theme: ThemeData.light(useMaterial3: useMaterial3),
|
|
darkTheme: ThemeData.dark(useMaterial3: useMaterial3),
|
|
themeMode: themeMode,
|
|
home: TimePickerOptions(
|
|
themeMode: themeMode,
|
|
useMaterial3: useMaterial3,
|
|
setThemeMode: setThemeMode,
|
|
setUseMaterial3: setUseMaterial3,
|
|
),
|
|
);
|
|
}
|
|
}
|
|
|
|
class TimePickerOptions extends StatefulWidget {
|
|
const TimePickerOptions({
|
|
super.key,
|
|
required this.themeMode,
|
|
required this.useMaterial3,
|
|
required this.setThemeMode,
|
|
required this.setUseMaterial3,
|
|
});
|
|
|
|
final ThemeMode themeMode;
|
|
final bool useMaterial3;
|
|
final ValueChanged<ThemeMode> setThemeMode;
|
|
final ValueChanged<bool?> setUseMaterial3;
|
|
|
|
@override
|
|
State<TimePickerOptions> createState() => _TimePickerOptionsState();
|
|
}
|
|
|
|
class _TimePickerOptionsState extends State<TimePickerOptions> {
|
|
TimeOfDay? selectedTime;
|
|
TimePickerEntryMode entryMode = TimePickerEntryMode.dial;
|
|
Orientation? orientation;
|
|
TextDirection textDirection = TextDirection.ltr;
|
|
MaterialTapTargetSize tapTargetSize = MaterialTapTargetSize.padded;
|
|
bool use24HourTime = false;
|
|
|
|
void _entryModeChanged(TimePickerEntryMode? value) {
|
|
if (value != entryMode) {
|
|
setState(() {
|
|
entryMode = value!;
|
|
});
|
|
}
|
|
}
|
|
|
|
void _orientationChanged(Orientation? value) {
|
|
if (value != orientation) {
|
|
setState(() {
|
|
orientation = value;
|
|
});
|
|
}
|
|
}
|
|
|
|
void _textDirectionChanged(TextDirection? value) {
|
|
if (value != textDirection) {
|
|
setState(() {
|
|
textDirection = value!;
|
|
});
|
|
}
|
|
}
|
|
|
|
void _tapTargetSizeChanged(MaterialTapTargetSize? value) {
|
|
if (value != tapTargetSize) {
|
|
setState(() {
|
|
tapTargetSize = value!;
|
|
});
|
|
}
|
|
}
|
|
|
|
void _use24HourTimeChanged(bool? value) {
|
|
if (value != use24HourTime) {
|
|
setState(() {
|
|
use24HourTime = value!;
|
|
});
|
|
}
|
|
}
|
|
|
|
void _themeModeChanged(ThemeMode? value) {
|
|
widget.setThemeMode(value!);
|
|
}
|
|
|
|
@override
|
|
Widget build(BuildContext context) {
|
|
return Material(
|
|
child: Column(
|
|
children: <Widget>[
|
|
Expanded(
|
|
child: GridView(
|
|
gridDelegate: SliverGridDelegateWithMaxCrossAxisExtent(
|
|
maxCrossAxisExtent: 350,
|
|
mainAxisSpacing: 4,
|
|
// ignore: deprecated_member_use, https://github.com/flutter/flutter/issues/128825
|
|
mainAxisExtent: 200 * MediaQuery.textScalerOf(context).textScaleFactor,
|
|
crossAxisSpacing: 4,
|
|
),
|
|
children: <Widget>[
|
|
EnumCard<TimePickerEntryMode>(
|
|
choices: TimePickerEntryMode.values,
|
|
value: entryMode,
|
|
onChanged: _entryModeChanged,
|
|
),
|
|
EnumCard<ThemeMode>(
|
|
choices: ThemeMode.values,
|
|
value: widget.themeMode,
|
|
onChanged: _themeModeChanged,
|
|
),
|
|
EnumCard<TextDirection>(
|
|
choices: TextDirection.values,
|
|
value: textDirection,
|
|
onChanged: _textDirectionChanged,
|
|
),
|
|
EnumCard<MaterialTapTargetSize>(
|
|
choices: MaterialTapTargetSize.values,
|
|
value: tapTargetSize,
|
|
onChanged: _tapTargetSizeChanged,
|
|
),
|
|
ChoiceCard<Orientation?>(
|
|
choices: const <Orientation?>[...Orientation.values, null],
|
|
value: orientation,
|
|
title: '$Orientation',
|
|
choiceLabels: <Orientation?, String>{
|
|
for (final Orientation choice in Orientation.values) choice: choice.name,
|
|
null: 'from MediaQuery',
|
|
},
|
|
onChanged: _orientationChanged,
|
|
),
|
|
ChoiceCard<bool>(
|
|
choices: const <bool>[false, true],
|
|
value: use24HourTime,
|
|
onChanged: _use24HourTimeChanged,
|
|
title: 'Time Mode',
|
|
choiceLabels: const <bool, String>{
|
|
false: '12-hour am/pm time',
|
|
true: '24-hour time',
|
|
},
|
|
),
|
|
ChoiceCard<bool>(
|
|
choices: const <bool>[false, true],
|
|
value: widget.useMaterial3,
|
|
onChanged: widget.setUseMaterial3,
|
|
title: 'Material Version',
|
|
choiceLabels: const <bool, String>{
|
|
false: 'Material 2',
|
|
true: 'Material 3',
|
|
},
|
|
),
|
|
],
|
|
),
|
|
),
|
|
SingleChildScrollView(
|
|
scrollDirection: Axis.horizontal,
|
|
child: Row(
|
|
mainAxisAlignment: MainAxisAlignment.center,
|
|
children: <Widget>[
|
|
Padding(
|
|
padding: const EdgeInsets.all(12.0),
|
|
child: ElevatedButton(
|
|
child: const Text('Open time picker'),
|
|
onPressed: () async {
|
|
final TimeOfDay? time = await showTimePicker(
|
|
context: context,
|
|
initialTime: selectedTime ?? TimeOfDay.now(),
|
|
initialEntryMode: entryMode,
|
|
orientation: orientation,
|
|
builder: (BuildContext context, Widget? child) {
|
|
// We just wrap these environmental changes around the
|
|
// child in this builder so that we can apply the
|
|
// options selected above. In regular usage, this is
|
|
// rarely necessary, because the default values are
|
|
// usually used as-is.
|
|
return Theme(
|
|
data: Theme.of(context).copyWith(
|
|
materialTapTargetSize: tapTargetSize,
|
|
),
|
|
child: Directionality(
|
|
textDirection: textDirection,
|
|
child: MediaQuery(
|
|
data: MediaQuery.of(context).copyWith(
|
|
alwaysUse24HourFormat: use24HourTime,
|
|
),
|
|
child: child!,
|
|
),
|
|
),
|
|
);
|
|
},
|
|
);
|
|
setState(() {
|
|
selectedTime = time;
|
|
});
|
|
},
|
|
),
|
|
),
|
|
if (selectedTime != null) Text('Selected time: ${selectedTime!.format(context)}'),
|
|
],
|
|
),
|
|
),
|
|
],
|
|
),
|
|
);
|
|
}
|
|
}
|
|
|
|
// This is a simple card that presents a set of radio buttons (inside of a
|
|
// RadioSelection, defined below) for the user to select from.
|
|
class ChoiceCard<T extends Object?> extends StatelessWidget {
|
|
const ChoiceCard({
|
|
super.key,
|
|
required this.value,
|
|
required this.choices,
|
|
required this.onChanged,
|
|
required this.choiceLabels,
|
|
required this.title,
|
|
});
|
|
|
|
final T value;
|
|
final Iterable<T> choices;
|
|
final Map<T, String> choiceLabels;
|
|
final String title;
|
|
final ValueChanged<T?> onChanged;
|
|
|
|
@override
|
|
Widget build(BuildContext context) {
|
|
return Card(
|
|
// If the card gets too small, let it scroll both directions.
|
|
child: SingleChildScrollView(
|
|
child: SingleChildScrollView(
|
|
scrollDirection: Axis.horizontal,
|
|
child: Padding(
|
|
padding: const EdgeInsets.all(8.0),
|
|
child: Column(
|
|
crossAxisAlignment: CrossAxisAlignment.start,
|
|
children: <Widget>[
|
|
Padding(
|
|
padding: const EdgeInsets.all(8.0),
|
|
child: Text(title),
|
|
),
|
|
for (final T choice in choices)
|
|
RadioSelection<T>(
|
|
value: choice,
|
|
groupValue: value,
|
|
onChanged: onChanged,
|
|
child: Text(choiceLabels[choice]!),
|
|
),
|
|
],
|
|
),
|
|
),
|
|
),
|
|
),
|
|
);
|
|
}
|
|
}
|
|
|
|
// This aggregates a ChoiceCard so that it presents a set of radio buttons for
|
|
// the allowed enum values for the user to select from.
|
|
class EnumCard<T extends Enum> extends StatelessWidget {
|
|
const EnumCard({
|
|
super.key,
|
|
required this.value,
|
|
required this.choices,
|
|
required this.onChanged,
|
|
});
|
|
|
|
final T value;
|
|
final Iterable<T> choices;
|
|
final ValueChanged<T?> onChanged;
|
|
|
|
@override
|
|
Widget build(BuildContext context) {
|
|
return ChoiceCard<T>(
|
|
value: value,
|
|
choices: choices,
|
|
onChanged: onChanged,
|
|
choiceLabels: <T, String>{
|
|
for (final T choice in choices) choice: choice.name,
|
|
},
|
|
title: value.runtimeType.toString());
|
|
}
|
|
}
|
|
|
|
// A button that has a radio button on one side and a label child. Tapping on
|
|
// the label or the radio button selects the item.
|
|
class RadioSelection<T extends Object?> extends StatefulWidget {
|
|
const RadioSelection({
|
|
super.key,
|
|
required this.value,
|
|
required this.groupValue,
|
|
required this.onChanged,
|
|
required this.child,
|
|
});
|
|
|
|
final T value;
|
|
final T? groupValue;
|
|
final ValueChanged<T?> onChanged;
|
|
final Widget child;
|
|
|
|
@override
|
|
State<RadioSelection<T>> createState() => _RadioSelectionState<T>();
|
|
}
|
|
|
|
class _RadioSelectionState<T extends Object?> extends State<RadioSelection<T>> {
|
|
@override
|
|
Widget build(BuildContext context) {
|
|
return Row(
|
|
mainAxisSize: MainAxisSize.min,
|
|
children: <Widget>[
|
|
Padding(
|
|
padding: const EdgeInsetsDirectional.only(end: 8),
|
|
child: Radio<T>(
|
|
groupValue: widget.groupValue,
|
|
value: widget.value,
|
|
onChanged: widget.onChanged,
|
|
),
|
|
),
|
|
GestureDetector(onTap: () => widget.onChanged(widget.value), child: widget.child),
|
|
],
|
|
);
|
|
}
|
|
}
|