-
-
Notifications
You must be signed in to change notification settings - Fork 235
/
auto_size_text.dart
458 lines (401 loc) · 14.6 KB
/
auto_size_text.dart
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
part of auto_size_text;
/// Flutter widget that automatically resizes text to fit perfectly within its
/// bounds.
///
/// All size constraints as well as maxLines are taken into account. If the text
/// overflows anyway, you should check if the parent widget actually constraints
/// the size of this widget.
class AutoSizeText extends StatefulWidget {
/// Creates a [AutoSizeText] widget.
///
/// If the [style] argument is null, the text will use the style from the
/// closest enclosing [DefaultTextStyle].
const AutoSizeText(
String this.data, {
Key? key,
this.textKey,
this.style,
this.strutStyle,
this.minFontSize = 12,
this.maxFontSize = double.infinity,
this.stepGranularity = 1,
this.presetFontSizes,
this.group,
this.textAlign,
this.textDirection,
this.locale,
this.softWrap,
this.wrapWords = true,
this.overflow,
this.overflowReplacement,
this.textScaleFactor,
this.maxLines,
this.semanticsLabel,
}) : textSpan = null,
super(key: key);
/// Creates a [AutoSizeText] widget with a [TextSpan].
const AutoSizeText.rich(
TextSpan this.textSpan, {
Key? key,
this.textKey,
this.style,
this.strutStyle,
this.minFontSize = 12,
this.maxFontSize = double.infinity,
this.stepGranularity = 1,
this.presetFontSizes,
this.group,
this.textAlign,
this.textDirection,
this.locale,
this.softWrap,
this.wrapWords = true,
this.overflow,
this.overflowReplacement,
this.textScaleFactor,
this.maxLines,
this.semanticsLabel,
}) : data = null,
super(key: key);
/// Sets the key for the resulting [Text] widget.
///
/// This allows you to find the actual `Text` widget built by `AutoSizeText`.
final Key? textKey;
/// The text to display.
///
/// This will be null if a [textSpan] is provided instead.
final String? data;
/// The text to display as a [TextSpan].
///
/// This will be null if [data] is provided instead.
final TextSpan? textSpan;
/// If non-null, the style to use for this text.
///
/// If the style's "inherit" property is true, the style will be merged with
/// the closest enclosing [DefaultTextStyle]. Otherwise, the style will
/// replace the closest enclosing [DefaultTextStyle].
final TextStyle? style;
// The default font size if none is specified.
static const double _defaultFontSize = 14;
/// The strut style to use. Strut style defines the strut, which sets minimum
/// vertical layout metrics.
///
/// Omitting or providing null will disable strut.
///
/// Omitting or providing null for any properties of [StrutStyle] will result
/// in default values being used. It is highly recommended to at least specify
/// a font size.
///
/// See [StrutStyle] for details.
final StrutStyle? strutStyle;
/// The minimum text size constraint to be used when auto-sizing text.
///
/// Is being ignored if [presetFontSizes] is set.
final double minFontSize;
/// The maximum text size constraint to be used when auto-sizing text.
///
/// Is being ignored if [presetFontSizes] is set.
final double maxFontSize;
/// The step size in which the font size is being adapted to constraints.
///
/// The Text scales uniformly in a range between [minFontSize] and
/// [maxFontSize].
/// Each increment occurs as per the step size set in stepGranularity.
///
/// Most of the time you don't want a stepGranularity below 1.0.
///
/// Is being ignored if [presetFontSizes] is set.
final double stepGranularity;
/// Predefines all the possible font sizes.
///
/// **Important:** PresetFontSizes have to be in descending order.
final List<double>? presetFontSizes;
/// Synchronizes the size of multiple [AutoSizeText]s.
///
/// If you want multiple [AutoSizeText]s to have the same text size, give all
/// of them the same [AutoSizeGroup] instance. All of them will have the
/// size of the smallest [AutoSizeText]
final AutoSizeGroup? group;
/// How the text should be aligned horizontally.
final TextAlign? textAlign;
/// The directionality of the text.
///
/// This decides how [textAlign] values like [TextAlign.start] and
/// [TextAlign.end] are interpreted.
///
/// This is also used to disambiguate how to render bidirectional text. For
/// example, if the [data] is an English phrase followed by a Hebrew phrase,
/// in a [TextDirection.ltr] context the English phrase will be on the left
/// and the Hebrew phrase to its right, while in a [TextDirection.rtl]
/// context, the English phrase will be on the right and the Hebrew phrase on
/// its left.
///
/// Defaults to the ambient [Directionality], if any.
final TextDirection? textDirection;
/// Used to select a font when the same Unicode character can
/// be rendered differently, depending on the locale.
///
/// It's rarely necessary to set this property. By default its value
/// is inherited from the enclosing app with `Localizations.localeOf(context)`.
final Locale? locale;
/// Whether the text should break at soft line breaks.
///
/// If false, the glyphs in the text will be positioned as if there was
/// unlimited horizontal space.
final bool? softWrap;
/// Whether words which don't fit in one line should be wrapped.
///
/// If false, the fontSize is lowered as far as possible until all words fit
/// into a single line.
final bool wrapWords;
/// How visual overflow should be handled.
///
/// Defaults to retrieving the value from the nearest [DefaultTextStyle] ancestor.
final TextOverflow? overflow;
/// If the text is overflowing and does not fit its bounds, this widget is
/// displayed instead.
final Widget? overflowReplacement;
/// The number of font pixels for each logical pixel.
///
/// For example, if the text scale factor is 1.5, text will be 50% larger than
/// the specified font size.
///
/// This property also affects [minFontSize], [maxFontSize] and [presetFontSizes].
///
/// The value given to the constructor as textScaleFactor. If null, will
/// use the [MediaQueryData.textScaleFactor] obtained from the ambient
/// [MediaQuery], or 1.0 if there is no [MediaQuery] in scope.
final double? textScaleFactor;
/// An optional maximum number of lines for the text to span, wrapping if necessary.
/// If the text exceeds the given number of lines, it will be resized according
/// to the specified bounds and if necessary truncated according to [overflow].
///
/// If this is 1, text will not wrap. Otherwise, text will be wrapped at the
/// edge of the box.
///
/// If this is null, but there is an ambient [DefaultTextStyle] that specifies
/// an explicit number for its [DefaultTextStyle.maxLines], then the
/// [DefaultTextStyle] value will take precedence. You can use a [RichText]
/// widget directly to entirely override the [DefaultTextStyle].
final int? maxLines;
/// An alternative semantics label for this text.
///
/// If present, the semantics of this widget will contain this value instead
/// of the actual text. This will overwrite any of the semantics labels applied
/// directly to the [TextSpan]s.
///
/// This is useful for replacing abbreviations or shorthands with the full
/// text value:
///
/// ```dart
/// AutoSizeText(r'$$', semanticsLabel: 'Double dollars')
/// ```
final String? semanticsLabel;
@override
_AutoSizeTextState createState() => _AutoSizeTextState();
}
class _AutoSizeTextState extends State<AutoSizeText> {
@override
void initState() {
super.initState();
widget.group?._register(this);
}
@override
void didUpdateWidget(AutoSizeText oldWidget) {
super.didUpdateWidget(oldWidget);
if (oldWidget.group != widget.group) {
oldWidget.group?._remove(this);
widget.group?._register(this);
}
}
@override
Widget build(BuildContext context) {
return LayoutBuilder(builder: (context, size) {
final defaultTextStyle = DefaultTextStyle.of(context);
var style = widget.style;
if (widget.style == null || widget.style!.inherit) {
style = defaultTextStyle.style.merge(widget.style);
}
if (style!.fontSize == null) {
style = style.copyWith(fontSize: AutoSizeText._defaultFontSize);
}
final maxLines = widget.maxLines ?? defaultTextStyle.maxLines;
_validateProperties(style, maxLines);
final result = _calculateFontSize(size, style, maxLines);
final fontSize = result[0] as double;
final textFits = result[1] as bool;
Widget text;
if (widget.group != null) {
widget.group!._updateFontSize(this, fontSize);
text = _buildText(widget.group!._fontSize, style, maxLines);
} else {
text = _buildText(fontSize, style, maxLines);
}
if (widget.overflowReplacement != null && !textFits) {
return widget.overflowReplacement!;
} else {
return text;
}
});
}
void _validateProperties(TextStyle style, int? maxLines) {
assert(widget.overflow == null || widget.overflowReplacement == null,
'Either overflow or overflowReplacement must be null.');
assert(maxLines == null || maxLines > 0,
'MaxLines must be greater than or equal to 1.');
assert(widget.key == null || widget.key != widget.textKey,
'Key and textKey must not be equal.');
if (widget.presetFontSizes == null) {
assert(
widget.stepGranularity >= 0.1,
'StepGranularity must be greater than or equal to 0.1. It is not a '
'good idea to resize the font with a higher accuracy.');
assert(widget.minFontSize >= 0,
'MinFontSize must be greater than or equal to 0.');
assert(widget.maxFontSize > 0, 'MaxFontSize has to be greater than 0.');
assert(widget.minFontSize <= widget.maxFontSize,
'MinFontSize must be smaller or equal than maxFontSize.');
assert(widget.minFontSize / widget.stepGranularity % 1 == 0,
'MinFontSize must be a multiple of stepGranularity.');
if (widget.maxFontSize != double.infinity) {
assert(widget.maxFontSize / widget.stepGranularity % 1 == 0,
'MaxFontSize must be a multiple of stepGranularity.');
}
} else {
assert(widget.presetFontSizes!.isNotEmpty,
'PresetFontSizes must not be empty.');
}
}
List _calculateFontSize(
BoxConstraints size, TextStyle? style, int? maxLines) {
final span = TextSpan(
style: widget.textSpan?.style ?? style,
text: widget.textSpan?.text ?? widget.data,
children: widget.textSpan?.children,
recognizer: widget.textSpan?.recognizer,
);
final userScale =
widget.textScaleFactor ?? MediaQuery.textScaleFactorOf(context);
int left;
int right;
final presetFontSizes = widget.presetFontSizes?.reversed.toList();
if (presetFontSizes == null) {
final num defaultFontSize =
style!.fontSize!.clamp(widget.minFontSize, widget.maxFontSize);
final defaultScale = defaultFontSize * userScale / style.fontSize!;
if (_checkTextFits(span, defaultScale, maxLines, size)) {
return <Object>[defaultFontSize * userScale, true];
}
left = (widget.minFontSize / widget.stepGranularity).floor();
right = (defaultFontSize / widget.stepGranularity).ceil();
} else {
left = 0;
right = presetFontSizes.length - 1;
}
var lastValueFits = false;
while (left <= right) {
final mid = (left + (right - left) / 2).floor();
double scale;
if (presetFontSizes == null) {
scale = mid * userScale * widget.stepGranularity / style!.fontSize!;
} else {
scale = presetFontSizes[mid] * userScale / style!.fontSize!;
}
if (_checkTextFits(span, scale, maxLines, size)) {
left = mid + 1;
lastValueFits = true;
} else {
right = mid - 1;
}
}
if (!lastValueFits) {
right += 1;
}
double fontSize;
if (presetFontSizes == null) {
fontSize = right * userScale * widget.stepGranularity;
} else {
fontSize = presetFontSizes[right] * userScale;
}
return <Object>[fontSize, lastValueFits];
}
bool _checkTextFits(
TextSpan text, double scale, int? maxLines, BoxConstraints constraints) {
if (!widget.wrapWords) {
final words = text.toPlainText().split(RegExp('\\s+'));
final wordWrapTextPainter = TextPainter(
text: TextSpan(
style: text.style,
text: words.join('\n'),
),
textAlign: widget.textAlign ?? TextAlign.left,
textDirection: widget.textDirection ?? TextDirection.ltr,
textScaleFactor: scale,
maxLines: words.length,
locale: widget.locale,
strutStyle: widget.strutStyle,
);
wordWrapTextPainter.layout(maxWidth: constraints.maxWidth);
if (wordWrapTextPainter.didExceedMaxLines ||
wordWrapTextPainter.width > constraints.maxWidth) {
return false;
}
}
final textPainter = TextPainter(
text: text,
textAlign: widget.textAlign ?? TextAlign.left,
textDirection: widget.textDirection ?? TextDirection.ltr,
textScaleFactor: scale,
maxLines: maxLines,
locale: widget.locale,
strutStyle: widget.strutStyle,
);
textPainter.layout(maxWidth: constraints.maxWidth);
return !(textPainter.didExceedMaxLines ||
textPainter.height > constraints.maxHeight ||
textPainter.width > constraints.maxWidth);
}
Widget _buildText(double fontSize, TextStyle style, int? maxLines) {
if (widget.data != null) {
return Text(
widget.data!,
key: widget.textKey,
style: style.copyWith(fontSize: fontSize),
strutStyle: widget.strutStyle,
textAlign: widget.textAlign,
textDirection: widget.textDirection,
locale: widget.locale,
softWrap: widget.softWrap,
overflow: widget.overflow,
textScaleFactor: 1,
maxLines: maxLines,
semanticsLabel: widget.semanticsLabel,
);
} else {
return Text.rich(
widget.textSpan!,
key: widget.textKey,
style: style,
strutStyle: widget.strutStyle,
textAlign: widget.textAlign,
textDirection: widget.textDirection,
locale: widget.locale,
softWrap: widget.softWrap,
overflow: widget.overflow,
textScaleFactor: fontSize / style.fontSize!,
maxLines: maxLines,
semanticsLabel: widget.semanticsLabel,
);
}
}
void _notifySync() {
setState(() {});
}
@override
void dispose() {
if (widget.group != null) {
widget.group!._remove(this);
}
super.dispose();
}
}