flutter_flutter/dev/tools/gen_defaults/lib/icon_button_template.dart
Camille Simon 7fd228f31d
[Material] Change default mouse cursor of buttons to basic arrow instead of click (except on web) (#171796)
Changes default mouse cursor of Material buttons to basic arrow instead
of click as per updated Android guidance.

For each Material button, I did the following:

1. Changed the default mouse cursor to the basic arrow.
2. Added a way to configure the mouse cursor of the button if a method
did not exist before.
3. Added a test to ensure that the default mouse cursor is now the basic
arrow (or modified an existing one if applicable).
4. Added a test to ensure that the customization of button mouse cursors
still works (if currently untested).

The list of Material buttons I modified (supposed to be all of them):

- RawMaterialButton
- DropdownButton
- FloatingActionButton
- ToggleButtons
- ElevatedButton
- IconButton
- FilledButton
- OutlinedButton
- PopupMenuItem
- InkWell
- TextButton
- MaterialButton
- DropdownMenuItem
- DropdownButtonFormField
- BackButton
- CloseButton
- DrawerButton
- EndDrawerButton
- PopupMenuButton
- MenuItemButton
- CheckboxMenuButton
- RadioMenuButton
- MenuBar
- SubmenuButton
- SegmentedButton
- FilterChip
- ChoiceChip
- ActionChip
- InputChip

Fixes https://github.com/flutter/flutter/issues/170296.

## Pre-launch Checklist

- [x] I read the [Contributor Guide] and followed the process outlined
there for submitting PRs.
- [x] I read the [Tree Hygiene] wiki page, which explains my
responsibilities.
- [x] I read and followed the [Flutter Style Guide], including [Features
we expect every widget to implement].
- [x] I signed the [CLA].
- [x] I listed at least one issue that this PR fixes in the description
above.
- [x] I updated/added relevant documentation (doc comments with `///`).
- [x] I added new tests to check the change I am making, or this PR is
[test-exempt].
- [ ] I followed the [breaking change policy] and added [Data Driven
Fixes] where supported.
- [x] All existing and new tests are passing.

If you need help, consider asking for advice on the #hackers-new channel
on [Discord].

<!-- Links -->
[Contributor Guide]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#overview
[Tree Hygiene]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md
[test-exempt]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#tests
[Flutter Style Guide]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Style-guide-for-Flutter-repo.md
[Features we expect every widget to implement]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Style-guide-for-Flutter-repo.md#features-we-expect-every-widget-to-implement
[CLA]: https://cla.developers.google.com/
[flutter/tests]: https://github.com/flutter/tests
[breaking change policy]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#handling-breaking-changes
[Discord]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Chat.md
[Data Driven Fixes]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Data-driven-Fixes.md

---------

Co-authored-by: Tong Mu <dkwingsmt@users.noreply.github.com>
2025-10-23 22:24:00 +00:00

317 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 'template.dart';
class IconButtonTemplate extends TokenTemplate {
const IconButtonTemplate(
this.tokenGroup,
super.blockName,
super.fileName,
super.tokens, {
super.colorSchemePrefix = '_colors.',
});
final String tokenGroup;
String _backgroundColor() {
switch (tokenGroup) {
case 'md.comp.filled-icon-button':
case 'md.comp.filled-tonal-icon-button':
return '''
WidgetStateProperty.resolveWith((Set<WidgetState> states) {
if (states.contains(WidgetState.disabled)) {
return ${componentColor('$tokenGroup.disabled.container')};
}
if (states.contains(WidgetState.selected)) {
return ${componentColor('$tokenGroup.selected.container')};
}
if (toggleable) { // toggleable but unselected case
return ${componentColor('$tokenGroup.unselected.container')};
}
return ${componentColor('$tokenGroup.container')};
})''';
case 'md.comp.outlined-icon-button':
return '''
WidgetStateProperty.resolveWith((Set<WidgetState> states) {
if (states.contains(WidgetState.disabled)) {
if (states.contains(WidgetState.selected)) {
return ${componentColor('$tokenGroup.disabled.selected.container')};
}
return Colors.transparent;
}
if (states.contains(WidgetState.selected)) {
return ${componentColor('$tokenGroup.selected.container')};
}
return Colors.transparent;
})''';
}
return '''
const MaterialStatePropertyAll<Color?>(Colors.transparent)''';
}
String _foregroundColor() {
switch (tokenGroup) {
case 'md.comp.filled-icon-button':
case 'md.comp.filled-tonal-icon-button':
return '''
WidgetStateProperty.resolveWith((Set<WidgetState> states) {
if (states.contains(WidgetState.disabled)) {
return ${componentColor('$tokenGroup.disabled.icon')};
}
if (states.contains(WidgetState.selected)) {
return ${componentColor('$tokenGroup.toggle.selected.icon')};
}
if (toggleable) { // toggleable but unselected case
return ${componentColor('$tokenGroup.toggle.unselected.icon')};
}
return ${componentColor('$tokenGroup.icon')};
})''';
case 'md.comp.outlined-icon-button':
case 'md.comp.icon-button':
return '''
WidgetStateProperty.resolveWith((Set<WidgetState> states) {
if (states.contains(WidgetState.disabled)) {
return ${componentColor('$tokenGroup.disabled.icon')};
}
if (states.contains(WidgetState.selected)) {
return ${componentColor('$tokenGroup.selected.icon')};
}
return ${componentColor('$tokenGroup.unselected.icon')};
})''';
}
return '''
const MaterialStatePropertyAll<Color?>(Colors.transparent)''';
}
String _overlayColor() {
switch (tokenGroup) {
case 'md.comp.filled-icon-button':
case 'md.comp.filled-tonal-icon-button':
return '''
WidgetStateProperty.resolveWith((Set<WidgetState> states) {
if (states.contains(WidgetState.selected)) {
if (states.contains(WidgetState.pressed)) {
return ${componentColor('$tokenGroup.toggle.selected.pressed.state-layer')}.withOpacity(${opacity('$tokenGroup.pressed.state-layer.opacity')});
}
if (states.contains(WidgetState.hovered)) {
return ${componentColor('$tokenGroup.toggle.selected.hover.state-layer')}.withOpacity(${opacity('$tokenGroup.hover.state-layer.opacity')});
}
if (states.contains(WidgetState.focused)) {
return ${componentColor('$tokenGroup.toggle.selected.focus.state-layer')}.withOpacity(${opacity('$tokenGroup.focus.state-layer.opacity')});
}
}
if (toggleable) { // toggleable but unselected case
if (states.contains(WidgetState.pressed)) {
return ${componentColor('$tokenGroup.toggle.unselected.pressed.state-layer')}.withOpacity(${opacity('$tokenGroup.pressed.state-layer.opacity')});
}
if (states.contains(WidgetState.hovered)) {
return ${componentColor('$tokenGroup.toggle.unselected.hover.state-layer')}.withOpacity(${opacity('$tokenGroup.hover.state-layer.opacity')});
}
if (states.contains(WidgetState.focused)) {
return ${componentColor('$tokenGroup.toggle.unselected.focus.state-layer')}.withOpacity(${opacity('$tokenGroup.focus.state-layer.opacity')});
}
}
if (states.contains(WidgetState.pressed)) {
return ${componentColor('$tokenGroup.pressed.state-layer')};
}
if (states.contains(WidgetState.hovered)) {
return ${componentColor('$tokenGroup.hover.state-layer')};
}
if (states.contains(WidgetState.focused)) {
return ${componentColor('$tokenGroup.focus.state-layer')};
}
return Colors.transparent;
})''';
case 'md.comp.outlined-icon-button':
return '''
WidgetStateProperty.resolveWith((Set<WidgetState> states) {
if (states.contains(WidgetState.selected)) {
if (states.contains(WidgetState.pressed)) {
return ${componentColor('$tokenGroup.selected.pressed.state-layer')}.withOpacity(${opacity('$tokenGroup.pressed.state-layer.opacity')});
}
if (states.contains(WidgetState.hovered)) {
return ${componentColor('$tokenGroup.selected.hover.state-layer')}.withOpacity(${opacity('$tokenGroup.hover.state-layer.opacity')});
}
if (states.contains(WidgetState.focused)) {
return ${componentColor('$tokenGroup.selected.focus.state-layer')}.withOpacity(${opacity('$tokenGroup.focus.state-layer.opacity')});
}
}
if (states.contains(WidgetState.pressed)) {
return ${componentColor('$tokenGroup.unselected.pressed.state-layer')}.withOpacity(${opacity('$tokenGroup.pressed.state-layer.opacity')});
}
if (states.contains(WidgetState.hovered)) {
return ${componentColor('$tokenGroup.unselected.hover.state-layer')}.withOpacity(${opacity('$tokenGroup.hover.state-layer.opacity')});
}
if (states.contains(WidgetState.focused)) {
return ${componentColor('$tokenGroup.unselected.focus.state-layer')}.withOpacity(${opacity('$tokenGroup.focus.state-layer.opacity')});
}
return Colors.transparent;
})''';
case 'md.comp.icon-button':
return '''
WidgetStateProperty.resolveWith((Set<WidgetState> states) {
if (states.contains(WidgetState.selected)) {
if (states.contains(WidgetState.pressed)) {
return ${componentColor('$tokenGroup.selected.pressed.state-layer')};
}
if (states.contains(WidgetState.hovered)) {
return ${componentColor('$tokenGroup.selected.hover.state-layer')};
}
if (states.contains(WidgetState.focused)) {
return ${componentColor('$tokenGroup.selected.focus.state-layer')};
}
}
if (states.contains(WidgetState.pressed)) {
return ${componentColor('$tokenGroup.unselected.pressed.state-layer')};
}
if (states.contains(WidgetState.hovered)) {
return ${componentColor('$tokenGroup.unselected.hover.state-layer')};
}
if (states.contains(WidgetState.focused)) {
return ${componentColor('$tokenGroup.unselected.focus.state-layer')};
}
return Colors.transparent;
})''';
}
return '''
const MaterialStatePropertyAll<Color?>(Colors.transparent)''';
}
String _minimumSize() {
if (tokenAvailable('$tokenGroup.container.height') &&
tokenAvailable('$tokenGroup.container.width')) {
return '''
const MaterialStatePropertyAll<Size>(Size(${getToken('$tokenGroup.container.width')}, ${getToken('$tokenGroup.container.height')}))''';
} else {
return '''
const MaterialStatePropertyAll<Size>(Size(40.0, 40.0))''';
}
}
String _shape() {
if (tokenAvailable('$tokenGroup.container.shape')) {
return '''
const MaterialStatePropertyAll<OutlinedBorder>(${shape("$tokenGroup.container", "")})''';
} else {
return '''
const MaterialStatePropertyAll<OutlinedBorder>(${shape("$tokenGroup.state-layer", "")})''';
}
}
String _side() {
if (tokenAvailable('$tokenGroup.unselected.outline.color')) {
return '''
WidgetStateProperty.resolveWith((Set<WidgetState> states) {
if (states.contains(WidgetState.selected)) {
return null;
} else {
if (states.contains(WidgetState.disabled)) {
return BorderSide(color: ${componentColor('$tokenGroup.disabled.unselected.outline')});
}
return BorderSide(color: ${componentColor('$tokenGroup.unselected.outline')});
}
})''';
}
return ''' null''';
}
String _elevationColor(String token) {
if (tokenAvailable(token)) {
return 'MaterialStatePropertyAll<Color>(${color(token)})';
} else {
return 'const MaterialStatePropertyAll<Color>(Colors.transparent)';
}
}
@override
String generate() =>
'''
class _${blockName}DefaultsM3 extends ButtonStyle {
_${blockName}DefaultsM3(this.context, this.toggleable)
: super(
animationDuration: kThemeChangeDuration,
enableFeedback: true,
alignment: Alignment.center,
);
final BuildContext context;
final bool toggleable;
late final ColorScheme _colors = Theme.of(context).colorScheme;
// No default text style
@override
WidgetStateProperty<Color?>? get backgroundColor =>${_backgroundColor()};
@override
WidgetStateProperty<Color?>? get foregroundColor =>${_foregroundColor()};
@override
WidgetStateProperty<Color?>? get overlayColor =>${_overlayColor()};
@override
WidgetStateProperty<double>? get elevation =>
const MaterialStatePropertyAll<double>(0.0);
@override
WidgetStateProperty<Color>? get shadowColor =>
${_elevationColor("$tokenGroup.container.shadow-color")};
@override
WidgetStateProperty<Color>? get surfaceTintColor =>
${_elevationColor("$tokenGroup.container.surface-tint-layer.color")};
@override
WidgetStateProperty<EdgeInsetsGeometry>? get padding =>
const MaterialStatePropertyAll<EdgeInsetsGeometry>(EdgeInsets.all(8.0));
@override
WidgetStateProperty<Size>? get minimumSize =>${_minimumSize()};
// No default fixedSize
@override
WidgetStateProperty<Size>? get maximumSize =>
const MaterialStatePropertyAll<Size>(Size.infinite);
@override
WidgetStateProperty<double>? get iconSize =>
const MaterialStatePropertyAll<double>(${getToken("$tokenGroup.icon.size")});
@override
WidgetStateProperty<BorderSide?>? get side =>${_side()};
@override
WidgetStateProperty<OutlinedBorder>? get shape =>${_shape()};
@override
WidgetStateProperty<MouseCursor?>? get mouseCursor => WidgetStateMouseCursor.adaptiveClickable;
@override
VisualDensity? get visualDensity => VisualDensity.standard;
@override
MaterialTapTargetSize? get tapTargetSize => Theme.of(context).materialTapTargetSize;
@override
InteractiveInkFeatureFactory? get splashFactory => Theme.of(context).splashFactory;
}
''';
}