Description

Resolve overlay color for pressed/active/inactive states in selection controls (Checkbox, Radio and Switch) and their corresponding themes (CheckboxThemeData, RadioThemeData and SwitchThemeData).

This allows you to set the overlayColor for the selection control and its themes, to for example have a different pressed overlay color when a Checkbox is selected or not:

Screenshot

Code

bool? _value = false; Checkbox( value: _value, tristate: true, onChanged: (bool? value) { setState(() { _value = value; }); }, overlayColor: MaterialStateProperty.resolveWith((Set<MaterialState> states) { if (states.contains(MaterialState.pressed)) { if (states.contains(MaterialState.selected)) { return Theme.of(context).colorScheme.primary.withOpacity(0.12); } return Colors.grey.withOpacity(0.12); } }), )

Related Issues

Closes #70828

Tests

I added the following tests:

• Checkbox overlay color resolves in active/pressed/focused/hovered states
• Checkbox theme overlay color resolves in active/pressed states
• Tristate Checkbox overlay color resolves in pressed active/inactive states
• Radio overlay color resolves in active/pressed/focused/hovered states
• Radio theme overlay color resolves in active/pressed states
• Switch overlay color resolves in active/pressed/focused/hovered states
• Switch theme overlay color resolves in active/pressed states

Checklist

Before you create this PR, confirm that it meets all requirements listed below by checking the relevant checkboxes ([x]). This will ensure a smooth and quick review process.

• I read the Contributor Guide and followed the process outlined there for submitting PRs.
• I signed the CLA.
• I read and followed the Flutter Style Guide, including Features we expect every widget to implement.
• I read the Tree Hygiene wiki page, which explains my responsibilities.
• I updated/added relevant documentation (doc comments with ///).
• All existing and new tests are passing.
• The analyzer (flutter analyze --flutter-repo) does not report any problems on my PR.
• I am willing to follow-up on review comments in a timely manner.

Breaking Change

Did any tests fail when you ran them? Please read Handling breaking changes.

• No, no existing tests failed, so this is not a breaking change.
• Yes, this is a breaking change.