Skip to content

Commit bd7b7b5

Browse files
authored
[material_ui] Migrate M3 snackbar defaults to new gen_defaults (flutter#13009)
Work toward flutter#187899 Fixes flutter#188434 ## Pre-Review Checklist
1 parent 8a0f9fe commit bd7b7b5

6 files changed

Lines changed: 104 additions & 157 deletions

File tree

packages/material_ui/tool/gen_defaults/temporarily_excluded/generated/snackbar_defaults.g.dart renamed to packages/material_ui/lib/src/generated/snackbar_defaults_m3.g.dart

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,11 @@
22
// Use of this source code is governed by a BSD-style license that can be
33
// found in the LICENSE file.
44

5+
// Do not edit by hand. The code is generated from data in the Material
6+
// Design token database by the script:
7+
// packages/material_ui/tool/gen_defaults/bin/gen_defaults.dart.
8+
part of '../snack_bar.dart';
9+
510
class _SnackbarDefaultsM3 extends SnackBarThemeData {
611
_SnackbarDefaultsM3(this.context);
712

‎packages/material_ui/lib/src/snack_bar.dart‎

Lines changed: 2 additions & 71 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,8 @@ import 'text_button.dart';
2121
import 'text_button_theme.dart';
2222
import 'theme.dart';
2323

24+
part 'generated/snackbar_defaults_m3.g.dart';
25+
2426
// Examples can assume:
2527
// late BuildContext context;
2628

@@ -947,74 +949,3 @@ class _SnackbarDefaultsM2 extends SnackBarThemeData {
947949
@override
948950
double get actionOverflowThreshold => 0.25;
949951
}
950-
951-
// BEGIN GENERATED TOKEN PROPERTIES - Snackbar
952-
953-
// Do not edit by hand. The code between the "BEGIN GENERATED" and
954-
// "END GENERATED" comments are generated from data in the Material
955-
// Design token database by the script:
956-
// dev/tools/gen_defaults/bin/gen_defaults.dart.
957-
958-
// dart format off
959-
class _SnackbarDefaultsM3 extends SnackBarThemeData {
960-
_SnackbarDefaultsM3(this.context);
961-
962-
final BuildContext context;
963-
late final ThemeData _theme = Theme.of(context);
964-
late final ColorScheme _colors = _theme.colorScheme;
965-
966-
@override
967-
Color get backgroundColor => _colors.inverseSurface;
968-
969-
@override
970-
Color get actionTextColor => WidgetStateColor.resolveWith((Set<WidgetState> states) {
971-
if (states.contains(WidgetState.disabled)) {
972-
return _colors.inversePrimary;
973-
}
974-
if (states.contains(WidgetState.pressed)) {
975-
return _colors.inversePrimary;
976-
}
977-
if (states.contains(WidgetState.hovered)) {
978-
return _colors.inversePrimary;
979-
}
980-
if (states.contains(WidgetState.focused)) {
981-
return _colors.inversePrimary;
982-
}
983-
return _colors.inversePrimary;
984-
});
985-
986-
@override
987-
Color get disabledActionTextColor =>
988-
_colors.inversePrimary;
989-
990-
991-
@override
992-
TextStyle get contentTextStyle =>
993-
Theme.of(context).textTheme.bodyMedium!.copyWith
994-
(color: _colors.onInverseSurface,
995-
);
996-
997-
@override
998-
double get elevation => 6.0;
999-
1000-
@override
1001-
ShapeBorder get shape => const RoundedRectangleBorder(borderRadius: BorderRadius.all(Radius.circular(4.0)));
1002-
1003-
@override
1004-
SnackBarBehavior get behavior => SnackBarBehavior.fixed;
1005-
1006-
@override
1007-
EdgeInsets get insetPadding => const EdgeInsets.fromLTRB(15.0, 5.0, 15.0, 10.0);
1008-
1009-
@override
1010-
bool get showCloseIcon => false;
1011-
1012-
@override
1013-
Color? get closeIconColor => _colors.onInverseSurface;
1014-
1015-
@override
1016-
double get actionOverflowThreshold => 0.25;
1017-
}
1018-
// dart format on
1019-
1020-
// END GENERATED TOKEN PROPERTIES - Snackbar

‎packages/material_ui/tool/gen_defaults/bin/gen_defaults.dart‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,8 @@ import '../templates/list_tile_template.dart';
4848
// import '../templates/search_view_template.dart';
4949
// import '../templates/segmented_button_template.dart';
5050
// import '../templates/slider_template.dart';
51-
// import '../templates/snackbar_template.dart';
51+
import '../templates/snackbar_template.dart';
52+
5253
// import '../templates/surface_tint_template.dart';
5354
// import '../templates/switch_template.dart';
5455
// import '../templates/tabs_template.dart';
@@ -110,7 +111,7 @@ Future<void> main(List<String> args) async {
110111
// const SearchViewTemplateM3().generateFile(verbose: verbose);
111112
// const SegmentedButtonTemplateM3().generateFile(verbose: verbose);
112113
// const SliderTemplateM3().generateFile(verbose: verbose);
113-
// const SnackbarTemplateM3().generateFile(verbose: verbose);
114+
const SnackbarTemplateM3().generateFile(verbose: verbose);
114115
// const SurfaceTintTemplateM3().generateFile(verbose: verbose);
115116
// const SwitchTemplateM3().generateFile(verbose: verbose);
116117
// const TabsTemplateM3().generateFile(verbose: verbose);
Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
// Copyright 2013 The Flutter Authors
2+
// Use of this source code is governed by a BSD-style license that can be
3+
// found in the LICENSE file.
4+
5+
import '../data/snackbar.dart';
6+
import 'template.dart';
7+
8+
class SnackbarTemplateM3 extends TokenTemplateM3 {
9+
const SnackbarTemplateM3();
10+
11+
@override
12+
String get name => 'Snackbar';
13+
14+
@override
15+
String get parentFilePath => 'snack_bar.dart';
16+
17+
@override
18+
String generateContents(String className) =>
19+
'''
20+
class $className extends SnackBarThemeData {
21+
$className(this.context);
22+
23+
final BuildContext context;
24+
late final ThemeData _theme = Theme.of(context);
25+
late final ColorScheme _colors = _theme.colorScheme;
26+
27+
@override
28+
Color get backgroundColor => ${color(TokenSnackbar.containerColor)};
29+
30+
@override
31+
Color get actionTextColor => WidgetStateColor.resolveWith((Set<WidgetState> states) {
32+
if (states.contains(WidgetState.disabled)) {
33+
return ${color(TokenSnackbar.actionPressedLabelTextColor)};
34+
}
35+
if (states.contains(WidgetState.pressed)) {
36+
return ${color(TokenSnackbar.actionPressedLabelTextColor)};
37+
}
38+
if (states.contains(WidgetState.hovered)) {
39+
return ${color(TokenSnackbar.actionHoverLabelTextColor)};
40+
}
41+
if (states.contains(WidgetState.focused)) {
42+
return ${color(TokenSnackbar.actionFocusLabelTextColor)};
43+
}
44+
return ${color(TokenSnackbar.actionLabelTextColor)};
45+
});
46+
47+
@override
48+
Color get disabledActionTextColor =>
49+
${color(TokenSnackbar.actionPressedLabelTextColor)};
50+
51+
52+
@override
53+
TextStyle get contentTextStyle =>
54+
${textStyle(TokenSnackbar.supportingTextType, 'Theme.of(context).textTheme')}!.copyWith
55+
(color: ${color(TokenSnackbar.supportingTextColor)},
56+
);
57+
58+
@override
59+
double get elevation => ${TokenSnackbar.containerElevation};
60+
61+
@override
62+
ShapeBorder get shape => ${shape(TokenSnackbar.containerShape)};
63+
64+
@override
65+
SnackBarBehavior get behavior => SnackBarBehavior.fixed;
66+
67+
@override
68+
EdgeInsets get insetPadding => const EdgeInsets.fromLTRB(15.0, 5.0, 15.0, 10.0);
69+
70+
@override
71+
bool get showCloseIcon => false;
72+
73+
@override
74+
Color? get closeIconColor => ${color(TokenSnackbar.iconColor)};
75+
76+
@override
77+
double get actionOverflowThreshold => 0.25;
78+
}
79+
''';
80+
}

‎packages/material_ui/tool/gen_defaults/temporarily_excluded/templates/snackbar_template.dart‎

Lines changed: 0 additions & 81 deletions
This file was deleted.

‎packages/material_ui/tool/gen_defaults/test/gen_defaults_test.dart‎

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ import '../templates/list_tile_template.dart';
4444
// import '../templates/search_view_template.dart';
4545
// import '../templates/segmented_button_template.dart';
4646
// import '../templates/slider_template.dart';
47-
// import '../templates/snackbar_template.dart';
47+
import '../templates/snackbar_template.dart';
4848
// import '../templates/surface_tint_template.dart';
4949
// import '../templates/switch_template.dart';
5050
// import '../templates/tabs_template.dart';
@@ -776,8 +776,19 @@ void main() {
776776
});
777777

778778
test('SnackbarTemplateM3 emits M3 Snackbar defaults from tokens', () {
779-
// Intentionally empty, will be implemented during migration. See:
780-
// https://github.com/flutter/flutter/issues/187899
779+
final String contents = const SnackbarTemplateM3().generateContents('_SnackbarDefaultsM3');
780+
expect(contents, contains('class _SnackbarDefaultsM3 extends SnackBarThemeData'));
781+
expect(contents, contains('Color get backgroundColor => _colors.inverseSurface'));
782+
expect(
783+
contents,
784+
contains(
785+
'ShapeBorder get shape => const RoundedRectangleBorder(borderRadius: BorderRadius.all(Radius.circular(4.0)))',
786+
),
787+
);
788+
expect(contents, contains('double get elevation => 6.0'));
789+
expect(contents, contains('SnackBarBehavior get behavior => SnackBarBehavior.fixed'));
790+
expect(contents, contains('Color? get closeIconColor => _colors.onInverseSurface'));
791+
expect(contents, contains('double get actionOverflowThreshold => 0.25'));
781792
});
782793

783794
test('SurfaceTintTemplateM3 emits M3 SurfaceTint defaults from tokens', () {

0 commit comments

Comments
 (0)