Skip to content

Commit afe954a

Browse files
authored
[material_ui] Default gen_defaults color helper prefix (flutter#12848)
Work toward flutter#187899. Follow-up to flutter/packages#12846. While migrating the M3 templates, I noticed that existing templates use `_colors` as the prefix passed to `color` and `colorWithOpacity`. This PR makes `_colors` the default value for the `prefix` argument and removes the now-redundant explicit arguments from existing templates. Explicit custom prefixes remain supported, and regenerating the enabled templates produces no changes to the checked-in generated defaults. ## Pre-Review Checklist **Note**: The Flutter team is currently trialing the use of [Gemini Code Assist for GitHub](https://developers.google.com/gemini-code-assist/docs/review-github-code). Comments from the `gemini-code-assist` bot should not be taken as authoritative feedback from the Flutter team. If you find its comments useful you can update your code accordingly, but if you are unsure or disagree with the feedback, please feel free to wait for a Flutter team member's review for guidance on which automated comments should be addressed. [^1]: Regular contributors who have demonstrated familiarity with the repository guidelines only need to comment if the PR is not auto-exempted by repo tooling.
1 parent 9b86d89 commit afe954a

10 files changed

Lines changed: 61 additions & 64 deletions

File tree

‎packages/material_ui/tool/gen_defaults/templates/action_chip_template.dart‎

Lines changed: 10 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,6 @@ class ActionChipTemplateM3 extends TokenTemplateM3 {
1313
@override
1414
String get parentFilePath => 'action_chip.dart';
1515

16-
String get _colorSchemePrefix => '_colors';
17-
1816
String get _textThemePrefix => '_textTheme';
1917

2018
@override
@@ -30,7 +28,7 @@ class $className extends ChipThemeData {
3028
final BuildContext context;
3129
final bool isEnabled;
3230
final _ChipVariant _chipVariant;
33-
late final ColorScheme $_colorSchemePrefix = Theme.of(context).colorScheme;
31+
late final ColorScheme _colors = Theme.of(context).colorScheme;
3432
late final TextTheme $_textThemePrefix = Theme.of(context).textTheme;
3533
3634
@override
@@ -44,8 +42,8 @@ class $className extends ChipThemeData {
4442
@override
4543
TextStyle? get labelStyle => ${textStyle(TokenAssistChip.labelTextType, _textThemePrefix)}?.copyWith(
4644
color: isEnabled
47-
? ${color(TokenAssistChip.labelTextColor, _colorSchemePrefix)}
48-
: ${color(TokenAssistChip.disabledLabelTextColor, _colorSchemePrefix)},
45+
? ${color(TokenAssistChip.labelTextColor)}
46+
: ${color(TokenAssistChip.disabledLabelTextColor)},
4947
);
5048
5149
@override
@@ -54,17 +52,17 @@ class $className extends ChipThemeData {
5452
if (states.contains(WidgetState.disabled)) {
5553
return _chipVariant == _ChipVariant.flat
5654
? null
57-
: ${colorWithOpacity(TokenAssistChip.elevatedDisabledContainerColor, TokenAssistChip.elevatedDisabledContainerOpacity, _colorSchemePrefix)};
55+
: ${colorWithOpacity(TokenAssistChip.elevatedDisabledContainerColor, TokenAssistChip.elevatedDisabledContainerOpacity)};
5856
}
5957
return _chipVariant == _ChipVariant.flat
6058
? null
61-
: ${color(TokenAssistChip.elevatedContainerColor, _colorSchemePrefix)};
59+
: ${color(TokenAssistChip.elevatedContainerColor)};
6260
});
6361
6462
@override
6563
Color? get shadowColor => _chipVariant == _ChipVariant.flat
6664
? Colors.transparent
67-
: ${color(TokenAssistChip.elevatedContainerShadowColor, _colorSchemePrefix)};
65+
: ${color(TokenAssistChip.elevatedContainerShadowColor)};
6866
6967
@override
7068
Color? get surfaceTintColor => Colors.transparent;
@@ -78,15 +76,15 @@ class $className extends ChipThemeData {
7876
@override
7977
BorderSide? get side => _chipVariant == _ChipVariant.flat
8078
? isEnabled
81-
? ${border(color(TokenAssistChip.flatOutlineColor, _colorSchemePrefix), width: TokenAssistChip.flatOutlineWidth)}
82-
: ${border(colorWithOpacity(TokenAssistChip.flatDisabledOutlineColor, TokenAssistChip.flatDisabledOutlineOpacity, _colorSchemePrefix))}
79+
? ${border(color(TokenAssistChip.flatOutlineColor), width: TokenAssistChip.flatOutlineWidth)}
80+
: ${border(colorWithOpacity(TokenAssistChip.flatDisabledOutlineColor, TokenAssistChip.flatDisabledOutlineOpacity))}
8381
: const BorderSide(color: Colors.transparent);
8482
8583
@override
8684
IconThemeData? get iconTheme => IconThemeData(
8785
color: isEnabled
88-
? ${color(TokenAssistChip.withIconIconColor, _colorSchemePrefix)}
89-
: ${color(TokenAssistChip.withIconDisabledIconColor, _colorSchemePrefix)},
86+
? ${color(TokenAssistChip.withIconIconColor)}
87+
: ${color(TokenAssistChip.withIconDisabledIconColor)},
9088
size: ${TokenAssistChip.withIconIconSize},
9189
);
9290

‎packages/material_ui/tool/gen_defaults/templates/app_bar_template.dart‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -35,10 +35,10 @@ class $className extends AppBarThemeData {
3535
late final TextTheme _textTheme = _theme.textTheme;
3636
3737
@override
38-
Color? get backgroundColor => ${color(TokenAppBar.containerColor, '_colors')};
38+
Color? get backgroundColor => ${color(TokenAppBar.containerColor)};
3939
4040
@override
41-
Color? get foregroundColor => ${color(TokenAppBar.titleColor, '_colors')};
41+
Color? get foregroundColor => ${color(TokenAppBar.titleColor)};
4242
4343
@override
4444
Color? get shadowColor => Colors.transparent;
@@ -48,13 +48,13 @@ class $className extends AppBarThemeData {
4848
4949
@override
5050
IconThemeData? get iconTheme => IconThemeData(
51-
color: ${color(TokenAppBar.leadingIconColor, '_colors')},
51+
color: ${color(TokenAppBar.leadingIconColor)},
5252
size: ${number(TokenAppBar.iconSize)},
5353
);
5454
5555
@override
5656
IconThemeData? get actionsIconTheme => IconThemeData(
57-
color: ${color(TokenAppBar.trailingIconColor, '_colors')},
57+
color: ${color(TokenAppBar.trailingIconColor)},
5858
size: ${number(TokenAppBar.iconSize)},
5959
);
6060
@@ -85,11 +85,11 @@ class _MediumScrollUnderFlexibleConfig with _ScrollUnderFlexibleConfig {
8585
8686
@override
8787
TextStyle? get collapsedTextStyle =>
88-
_textTheme.titleLarge?.apply(color: ${color(TokenAppBar.titleColor, '_colors')});
88+
_textTheme.titleLarge?.apply(color: ${color(TokenAppBar.titleColor)});
8989
9090
@override
9191
TextStyle? get expandedTextStyle =>
92-
_textTheme.headlineSmall?.apply(color: ${color(TokenAppBar.titleColor, '_colors')});
92+
_textTheme.headlineSmall?.apply(color: ${color(TokenAppBar.titleColor)});
9393
9494
@override
9595
EdgeInsetsGeometry get expandedTitlePadding => const EdgeInsets.fromLTRB(16, 0, 16, 20);
@@ -108,11 +108,11 @@ class _LargeScrollUnderFlexibleConfig with _ScrollUnderFlexibleConfig {
108108
109109
@override
110110
TextStyle? get collapsedTextStyle =>
111-
_textTheme.titleLarge?.apply(color: ${color(TokenAppBar.titleColor, '_colors')});
111+
_textTheme.titleLarge?.apply(color: ${color(TokenAppBar.titleColor)});
112112
113113
@override
114114
TextStyle? get expandedTextStyle =>
115-
_textTheme.headlineMedium?.apply(color: ${color(TokenAppBar.titleColor, '_colors')});
115+
_textTheme.headlineMedium?.apply(color: ${color(TokenAppBar.titleColor)});
116116
117117
@override
118118
EdgeInsetsGeometry get expandedTitlePadding => const EdgeInsets.fromLTRB(16, 0, 16, 28);

‎packages/material_ui/tool/gen_defaults/templates/badge_template.dart‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,10 +30,10 @@ class $className extends BadgeThemeData {
3030
late final ColorScheme _colors = _theme.colorScheme;
3131
3232
@override
33-
Color? get backgroundColor => ${color(TokenBadge.color, '_colors')};
33+
Color? get backgroundColor => ${color(TokenBadge.color)};
3434
3535
@override
36-
Color? get textColor => ${color(TokenBadge.largeLabelTextColor, '_colors')};
36+
Color? get textColor => ${color(TokenBadge.largeLabelTextColor)};
3737
3838
@override
3939
TextStyle? get textStyle => ${textStyle(TokenBadge.largeLabelTextType, 'Theme.of(context).textTheme')};

‎packages/material_ui/tool/gen_defaults/templates/banner_template.dart‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,13 +27,13 @@ class $className extends MaterialBannerThemeData {
2727
late final TextTheme _textTheme = Theme.of(context).textTheme;
2828
2929
@override
30-
Color? get backgroundColor => ${color(TokenBanner.containerColor, '_colors')};
30+
Color? get backgroundColor => ${color(TokenBanner.containerColor)};
3131
3232
@override
3333
Color? get surfaceTintColor => Colors.transparent;
3434
3535
@override
36-
Color? get dividerColor => ${color(TokenDivider.color, '_colors')};
36+
Color? get dividerColor => ${color(TokenDivider.color)};
3737
3838
@override
3939
TextStyle? get contentTextStyle => ${textStyle(TokenBanner.supportingTextType, '_textTheme')};

‎packages/material_ui/tool/gen_defaults/templates/bottom_sheet_template.dart‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ class $className extends BottomSheetThemeData {
3030
late final ColorScheme _colors = Theme.of(context).colorScheme;
3131
3232
@override
33-
Color? get backgroundColor => ${color(TokenSheetBottom.dockedContainerColor, '_colors')};
33+
Color? get backgroundColor => ${color(TokenSheetBottom.dockedContainerColor)};
3434
3535
@override
3636
Color? get surfaceTintColor => Colors.transparent;
@@ -39,7 +39,7 @@ class $className extends BottomSheetThemeData {
3939
Color? get shadowColor => Colors.transparent;
4040
4141
@override
42-
Color? get dragHandleColor => ${color(TokenSheetBottom.dockedDragHandleColor, '_colors')};
42+
Color? get dragHandleColor => ${color(TokenSheetBottom.dockedDragHandleColor)};
4343
4444
@override
4545
Size? get dragHandleSize => const Size(${number(TokenSheetBottom.dockedDragHandleWidth)}, ${number(TokenSheetBottom.dockedDragHandleHeight)});

‎packages/material_ui/tool/gen_defaults/templates/button_template.dart‎

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -146,20 +146,20 @@ class ButtonTemplateM3 extends TokenTemplateM3 {
146146
return '''
147147
WidgetStateProperty.resolveWith((Set<WidgetState> states) {
148148
if (states.contains(WidgetState.disabled)) {
149-
return ${colorWithOpacity(TokenButton.disabledContainerColor, _legacyDisabledContainerOpacity, '_colors')};
149+
return ${colorWithOpacity(TokenButton.disabledContainerColor, _legacyDisabledContainerOpacity)};
150150
}
151-
return ${color(containerColor, '_colors')};
151+
return ${color(containerColor)};
152152
})''';
153153
}
154154

155155
String get _shadowColor {
156156
return switch (_variant) {
157157
_ButtonVariant.elevated =>
158-
'MaterialStatePropertyAll<Color>(${color(TokenButtonElevated.containerShadowColor, '_colors')})',
158+
'MaterialStatePropertyAll<Color>(${color(TokenButtonElevated.containerShadowColor)})',
159159
_ButtonVariant.filled =>
160-
'MaterialStatePropertyAll<Color>(${color(TokenButtonFilled.containerShadowColor, '_colors')})',
160+
'MaterialStatePropertyAll<Color>(${color(TokenButtonFilled.containerShadowColor)})',
161161
_ButtonVariant.filledTonal =>
162-
'MaterialStatePropertyAll<Color>(${color(TokenButtonTonal.containerShadowColor, '_colors')})',
162+
'MaterialStatePropertyAll<Color>(${color(TokenButtonTonal.containerShadowColor)})',
163163
_ButtonVariant.outlined ||
164164
_ButtonVariant.text => 'const MaterialStatePropertyAll<Color>(Colors.transparent)',
165165
};
@@ -196,12 +196,12 @@ WidgetStateProperty.resolveWith((Set<WidgetState> states) {
196196
WidgetStateProperty<BorderSide>? get side =>
197197
WidgetStateProperty.resolveWith((Set<WidgetState> states) {
198198
if (states.contains(WidgetState.disabled)) {
199-
return BorderSide(color: ${colorWithOpacity(TokenButton.disabledContainerColor, _legacyDisabledContainerOpacity, '_colors')});
199+
return BorderSide(color: ${colorWithOpacity(TokenButton.disabledContainerColor, _legacyDisabledContainerOpacity)});
200200
}
201201
if (states.contains(WidgetState.focused)) {
202-
return BorderSide(color: ${color(TokenColorRole.primary, '_colors')});
202+
return BorderSide(color: ${color(TokenColorRole.primary)});
203203
}
204-
return BorderSide(color: ${color(TokenColorRole.outline, '_colors')});
204+
return BorderSide(color: ${color(TokenColorRole.outline)});
205205
});''';
206206
}
207207

@@ -230,22 +230,22 @@ class $className extends ButtonStyle {
230230
WidgetStateProperty<Color?>? get foregroundColor =>
231231
WidgetStateProperty.resolveWith((Set<WidgetState> states) {
232232
if (states.contains(WidgetState.disabled)) {
233-
return ${colorWithOpacity(TokenButton.disabledLabelTextColor, TokenButton.disabledLabelTextOpacity, '_colors')};
233+
return ${colorWithOpacity(TokenButton.disabledLabelTextColor, TokenButton.disabledLabelTextOpacity)};
234234
}
235-
return ${color(_labelTextColor, '_colors')};
235+
return ${color(_labelTextColor)};
236236
});
237237
238238
@override
239239
WidgetStateProperty<Color?>? get overlayColor =>
240240
WidgetStateProperty.resolveWith((Set<WidgetState> states) {
241241
if (states.contains(WidgetState.pressed)) {
242-
return ${colorWithOpacity(_stateLayerColor, _pressedStateLayerOpacity, '_colors')};
242+
return ${colorWithOpacity(_stateLayerColor, _pressedStateLayerOpacity)};
243243
}
244244
if (states.contains(WidgetState.hovered)) {
245-
return ${colorWithOpacity(_stateLayerColor, _hoveredStateLayerOpacity, '_colors')};
245+
return ${colorWithOpacity(_stateLayerColor, _hoveredStateLayerOpacity)};
246246
}
247247
if (states.contains(WidgetState.focused)) {
248-
return ${colorWithOpacity(_stateLayerColor, _focusedStateLayerOpacity, '_colors')};
248+
return ${colorWithOpacity(_stateLayerColor, _focusedStateLayerOpacity)};
249249
}
250250
return null;
251251
});
@@ -277,18 +277,18 @@ class $className extends ButtonStyle {
277277
WidgetStateProperty<Color>? get iconColor {
278278
return WidgetStateProperty.resolveWith((Set<WidgetState> states) {
279279
if (states.contains(WidgetState.disabled)) {
280-
return ${colorWithOpacity(TokenButton.disabledIconColor, TokenButton.disabledIconOpacity, '_colors')};
280+
return ${colorWithOpacity(TokenButton.disabledIconColor, TokenButton.disabledIconOpacity)};
281281
}
282282
if (states.contains(WidgetState.pressed)) {
283-
return ${color(_iconColor, '_colors')};
283+
return ${color(_iconColor)};
284284
}
285285
if (states.contains(WidgetState.hovered)) {
286-
return ${color(_iconColor, '_colors')};
286+
return ${color(_iconColor)};
287287
}
288288
if (states.contains(WidgetState.focused)) {
289-
return ${color(_iconColor, '_colors')};
289+
return ${color(_iconColor)};
290290
}
291-
return ${color(_iconColor, '_colors')};
291+
return ${color(_iconColor)};
292292
});
293293
}
294294

‎packages/material_ui/tool/gen_defaults/templates/card_template.dart‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ class CardTemplateM3 extends TokenTemplateM3 {
5858
}
5959
return '''
6060
$cardShape.copyWith(
61-
side: ${border(color(TokenOutlinedCard.outlineColor, '_colors'))},
61+
side: ${border(color(TokenOutlinedCard.outlineColor))},
6262
)''';
6363
}
6464

@@ -77,10 +77,10 @@ class $className extends CardThemeData {
7777
late final ColorScheme _colors = Theme.of(context).colorScheme;
7878
7979
@override
80-
Color? get color => ${color(_containerColor, '_colors')};
80+
Color? get color => ${color(_containerColor)};
8181
8282
@override
83-
Color? get shadowColor => ${color(_containerShadowColor, '_colors')};
83+
Color? get shadowColor => ${color(_containerShadowColor)};
8484
8585
@override
8686
Color? get surfaceTintColor => Colors.transparent;

‎packages/material_ui/tool/gen_defaults/templates/template.dart‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ abstract class TokenTemplate {
102102
String number(num value) => value.toString();
103103

104104
/// Generates a [ColorScheme] color expression for the given token.
105-
String color(TokenColorRole role, String prefix) {
105+
String color(TokenColorRole role, [String prefix = '_colors']) {
106106
final String colorName = switch (role) {
107107
TokenColorRole.inverseOnSurface => 'onInverseSurface',
108108
_ => role.name,
@@ -111,7 +111,7 @@ abstract class TokenTemplate {
111111
}
112112

113113
/// Generates a color expression with opacity applied.
114-
String colorWithOpacity(TokenColorRole role, double opacity, String prefix) {
114+
String colorWithOpacity(TokenColorRole role, double opacity, [String prefix = '_colors']) {
115115
final String colorExpression = color(role, prefix);
116116
if (opacity == 1.0) {
117117
return colorExpression;

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

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -114,11 +114,9 @@ void main() {
114114

115115
test('color generates color expression', () {
116116
final template = IconButtonTemplateM3(testPath());
117-
expect(template.color(TokenColorRole.onSurface, '_colors'), '_colors.onSurface');
118-
expect(
119-
template.color(TokenColorRole.inverseOnSurface, '_colors'),
120-
'_colors.onInverseSurface',
121-
);
117+
expect(template.color(TokenColorRole.onSurface), '_colors.onSurface');
118+
expect(template.color(TokenColorRole.inverseOnSurface), '_colors.onInverseSurface');
119+
expect(template.color(TokenColorRole.onSurface, '_customColors'), '_customColors.onSurface');
122120
});
123121

124122
test('textStyle generates text name', () {
@@ -138,31 +136,32 @@ void main() {
138136
test('M3 colorWithOpacity generates color expression with opacity', () {
139137
final template = IconButtonTemplateM3(testPath());
140138
expect(
141-
template.colorWithOpacity(TokenColorRole.onSurface, 0.12, '_colors'),
139+
template.colorWithOpacity(TokenColorRole.onSurface, 0.12),
142140
'_colors.onSurface.withOpacity(0.12)',
143141
);
144142
expect(
145-
template.colorWithOpacity(TokenColorRole.inverseOnSurface, 0.12, '_colors'),
143+
template.colorWithOpacity(TokenColorRole.inverseOnSurface, 0.12),
146144
'_colors.onInverseSurface.withOpacity(0.12)',
147145
);
146+
expect(template.colorWithOpacity(TokenColorRole.onSurface, 1.0), '_colors.onSurface');
148147
expect(
149-
template.colorWithOpacity(TokenColorRole.onSurface, 1.0, '_colors'),
150-
'_colors.onSurface',
148+
template.colorWithOpacity(TokenColorRole.onSurface, 0.12, '_customColors'),
149+
'_customColors.onSurface.withOpacity(0.12)',
151150
);
152151
});
153152

154153
test('M3E colorWithOpacity uses withValues', () {
155154
final template = IconButtonTemplateM3E(testPath());
156155
expect(
157-
template.colorWithOpacity(TokenColorRole.onSurface, 0.12, '_colors'),
156+
template.colorWithOpacity(TokenColorRole.onSurface, 0.12),
158157
'_colors.onSurface.withValues(alpha: 0.12)',
159158
);
160159
expect(
161-
template.colorWithOpacity(TokenColorRole.inverseOnSurface, 0.12, '_colors'),
160+
template.colorWithOpacity(TokenColorRole.inverseOnSurface, 0.12),
162161
'_colors.onInverseSurface.withValues(alpha: 0.12)',
163162
);
164163
expect(
165-
template.colorWithOpacity(TokenColorRole.inverseOnSurface, 1.0, '_colors'),
164+
template.colorWithOpacity(TokenColorRole.inverseOnSurface, 1.0),
166165
'_colors.onInverseSurface',
167166
);
168167
});

‎packages/material_ui/tool/gen_defaults/test/test_fixtures/test_templates.dart‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -55,11 +55,11 @@ class $className {
5555
5656
static const double height = ${TokenIconButton.height};
5757
static const double borderRadius = ${TokenIconButton.borderRadius};
58-
Color get iconColor => ${color(TokenIconButton.iconColor, '_colors')};
58+
Color get iconColor => ${color(TokenIconButton.iconColor)};
5959
Color get disabledIconColor =>
60-
${colorWithOpacity(TokenIconButton.disabledIconColor, TokenIconButton.disabledIconOpacity, '_colors')};
60+
${colorWithOpacity(TokenIconButton.disabledIconColor, TokenIconButton.disabledIconOpacity)};
6161
Color get hoveredStateLayerColor =>
62-
${colorWithOpacity(TokenIconButton.hoveredStateLayerColor, TokenIconButton.hoveredStateLayerOpacity, '_colors')};
62+
${colorWithOpacity(TokenIconButton.hoveredStateLayerColor, TokenIconButton.hoveredStateLayerOpacity)};
6363
OutlinedBorder get shape => ${shape(TokenIconButton.pressedContainerShape)};
6464
}
6565
''';

0 commit comments

Comments
 (0)