// MIT License
//
// Copyright (c) 2023 Mike Rydstrom
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.
import 'package:flutter/foundation.dart';
import 'package:flutter/material.dart';
// A seed color for the M3 ColorScheme.
const Color seedColor = Color(0xFF6750A4);
// Make M3 ColorSchemes from a seed color.
final ColorScheme schemeLight = ColorScheme.fromSeed(
brightness: Brightness.light,
seedColor: seedColor,
);
final ColorScheme schemeDark = ColorScheme.fromSeed(
brightness: Brightness.dark,
seedColor: seedColor,
);
// Example theme
ThemeData theme(ThemeMode mode, ThemeSettings settings) {
final ColorScheme colorScheme =
mode == ThemeMode.light ? schemeLight : schemeDark;
return ThemeData(
colorScheme: colorScheme,
useMaterial3: settings.useMaterial3,
visualDensity: VisualDensity.standard,
menuTheme: settings.useCustomMenu
? MenuThemeData(
style: MenuStyle(
backgroundColor:
MaterialStatePropertyAll<Color?>(colorScheme.errorContainer),
padding: const MaterialStatePropertyAll<EdgeInsetsGeometry?>(
EdgeInsets.all(8),
),
),
)
: null,
menuButtonTheme: settings.useCustomMenu
? MenuButtonThemeData(
style: ButtonStyle(
backgroundColor: MaterialStateProperty.resolveWith(
(Set<MaterialState> states) {
if (states.contains(MaterialState.pressed)) {
return colorScheme.primary;
}
if (states.contains(MaterialState.hovered)) {
return colorScheme.primary;
}
if (states.contains(MaterialState.focused)) {
return colorScheme.primaryContainer;
}
return Colors.transparent;
}),
foregroundColor: MaterialStateProperty.resolveWith(
(Set<MaterialState> states) {
if (states.contains(MaterialState.disabled)) {
return colorScheme.onSurface.withOpacity(0.38);
}
if (states.contains(MaterialState.pressed)) {
return colorScheme.onPrimary;
}
if (states.contains(MaterialState.hovered)) {
return colorScheme.onPrimary;
}
if (states.contains(MaterialState.focused)) {
return colorScheme.onPrimaryContainer;
}
return colorScheme.onSurface;
}),
iconColor: MaterialStateProperty.resolveWith(
(Set<MaterialState> states) {
if (states.contains(MaterialState.disabled)) {
return colorScheme.onSurface.withOpacity(0.38);
}
if (states.contains(MaterialState.pressed)) {
return colorScheme.onPrimary;
}
if (states.contains(MaterialState.hovered)) {
return colorScheme.onPrimary;
}
if (states.contains(MaterialState.focused)) {
return colorScheme.onPrimaryContainer;
}
return colorScheme.onSurfaceVariant;
}),
overlayColor: MaterialStateProperty.resolveWith(
(Set<MaterialState> states) {
if (states.contains(MaterialState.pressed)) {
return colorScheme.onPrimary.withOpacity(0.12);
}
if (states.contains(MaterialState.hovered)) {
return colorScheme.onPrimary.withOpacity(0.08);
}
if (states.contains(MaterialState.focused)) {
return colorScheme.onPrimaryContainer.withOpacity(0.12);
}
return Colors.transparent;
}),
shape: ButtonStyleButton.allOrNull<OutlinedBorder>(
const RoundedRectangleBorder(
borderRadius: BorderRadius.all(
Radius.circular(10),
),
),
),
),
)
: null,
);
}
void main() {
runApp(const IssueDemoApp());
}
class IssueDemoApp extends StatefulWidget {
const IssueDemoApp({super.key});
@override
State<IssueDemoApp> createState() => _IssueDemoAppState();
}
class _IssueDemoAppState extends State<IssueDemoApp> {
ThemeMode themeMode = ThemeMode.light;
bool longLabel = false;
TextDirection textDirection = TextDirection.ltr;
ThemeSettings settings = const ThemeSettings(
useMaterial3: true,
useCustomMenu: true,
);
@override
Widget build(BuildContext context) {
return MaterialApp(
debugShowCheckedModeBanner: false,
themeMode: themeMode,
theme: theme(ThemeMode.light, settings),
darkTheme: theme(ThemeMode.dark, settings),
home: Directionality(
textDirection: textDirection,
child: Scaffold(
appBar: AppBar(
title: const Text('DropdownMenu Issue'),
actions: [
IconButton(
icon: settings.useMaterial3
? const Icon(Icons.filter_3)
: const Icon(Icons.filter_2),
onPressed: () {
setState(() {
settings =
settings.copyWith(useMaterial3: !settings.useMaterial3);
});
},
tooltip: "Switch to Material ${settings.useMaterial3 ? 2 : 3}",
),
IconButton(
icon: themeMode == ThemeMode.dark
? const Icon(Icons.wb_sunny_outlined)
: const Icon(Icons.wb_sunny),
onPressed: () {
setState(() {
if (themeMode == ThemeMode.light) {
themeMode = ThemeMode.dark;
} else {
themeMode = ThemeMode.light;
}
});
},
tooltip: "Toggle brightness",
),
],
),
body: HomePage(
settings: settings,
onSettings: (ThemeSettings value) {
setState(() {
settings = value;
});
},
longLabel: longLabel,
onLongLabel: (bool value) {
setState(() {
longLabel = value;
});
},
textDirection: textDirection,
onTextDirection: (TextDirection value) {
setState(() {
textDirection = value;
});
},
),
),
),
);
}
}
class HomePage extends StatelessWidget {
const HomePage({
super.key,
required this.settings,
required this.onSettings,
required this.longLabel,
required this.onLongLabel,
required this.textDirection,
required this.onTextDirection,
});
final ThemeSettings settings;
final ValueChanged<ThemeSettings> onSettings;
final bool longLabel;
final ValueChanged<bool> onLongLabel;
final TextDirection textDirection;
final ValueChanged<TextDirection> onTextDirection;
@override
Widget build(BuildContext context) {
return ListView(
padding: const EdgeInsets.symmetric(horizontal: 16),
children: [
SwitchListTile(
title: const Text('Text directionality'),
subtitle: const Text('OFF=LTR ON=RTL'),
value: textDirection == TextDirection.rtl,
onChanged: (bool value) {
value
? onTextDirection(TextDirection.rtl)
: onTextDirection(TextDirection.ltr);
},
),
const SizedBox(height: 8),
const Text('DropdownMenu focused item style broken\n\n'
'The style indication of the found and selected item in a '
'DropdownMenu does not use MenuButtonThemeData. Its simulation of '
'the focused state omits the theme.'),
SwitchListTile(
title: const Text('Enable custom menu theme'),
value: settings.useCustomMenu,
onChanged: (bool value) {
onSettings(settings.copyWith(useCustomMenu: value));
},
),
const Padding(
padding: EdgeInsets.all(12.0),
child: DropDownMenuShowcase(),
),
const SizedBox(height: 16),
const ShowColorSchemeColors(),
],
);
}
}
class DropDownMenuShowcase extends StatefulWidget {
const DropDownMenuShowcase({super.key});
@override
State<DropDownMenuShowcase> createState() => _DropDownMenuShowcaseState();
}
class _DropDownMenuShowcaseState extends State<DropDownMenuShowcase> {
String selectedItem = '';
@override
Widget build(BuildContext context) {
return Column(
crossAxisAlignment: CrossAxisAlignment.start,
children: <Widget>[
DropdownMenu<String>(
initialSelection: selectedItem,
onSelected: (String? value) {
setState(() {
selectedItem = value ?? 'one';
});
},
dropdownMenuEntries: const <DropdownMenuEntry<String>>[
DropdownMenuEntry<String>(
label: 'Alarm settings',
leadingIcon: Icon(Icons.alarm),
value: 'one',
),
DropdownMenuEntry<String>(
label: 'Cabin overview',
leadingIcon: Icon(Icons.cabin),
value: 'three',
),
DropdownMenuEntry<String>(
label: 'Surveillance view',
leadingIcon: Icon(Icons.camera_outdoor_rounded),
value: 'four',
),
DropdownMenuEntry<String>(
label: 'Water alert',
leadingIcon: Icon(Icons.water_damage),
value: 'five',
),
DropdownMenuEntry<String>(
label: 'Disabled settings',
leadingIcon: Icon(Icons.settings),
value: 'two',
enabled: false,
),
],
),
],
);
}
}
/// A Theme Settings class to bundle properties we want to modify on our
/// theme interactively.
@immutable
class ThemeSettings with Diagnosticable {
final bool useMaterial3;
final bool useCustomMenu;
const ThemeSettings({
required this.useMaterial3,
required this.useCustomMenu,
});
/// Flutter debug properties override, includes toString.
@override
void debugFillProperties(DiagnosticPropertiesBuilder properties) {
super.debugFillProperties(properties);
properties.add(DiagnosticsProperty<bool>('useMaterial3', useMaterial3));
properties.add(DiagnosticsProperty<bool>('useCustomMenu', useCustomMenu));
}
/// Copy the object with one or more provided properties changed.
ThemeSettings copyWith({
bool? useMaterial3,
bool? useCustomMenu,
}) {
return ThemeSettings(
useMaterial3: useMaterial3 ?? this.useMaterial3,
useCustomMenu: useCustomMenu ?? this.useCustomMenu,
);
}
/// Override the equality operator.
@override
bool operator ==(Object other) {
if (identical(this, other)) return true;
if (other.runtimeType != runtimeType) return false;
return other is ThemeSettings &&
other.useMaterial3 == useMaterial3 &&
other.useCustomMenu == useCustomMenu;
}
/// Override for hashcode, dart.ui Jenkins based.
@override
int get hashCode => Object.hashAll(<Object?>[
useMaterial3.hashCode,
useCustomMenu.hashCode,
]);
}
/// Draw a number of boxes showing the colors of key theme color properties
/// in the ColorScheme of the inherited ThemeData and its color properties.
class ShowColorSchemeColors extends StatelessWidget {
const ShowColorSchemeColors({super.key, this.onBackgroundColor});
/// The color of the background the color widget are being drawn on.
///
/// Some of the theme colors may have semi transparent fill color. To compute
/// a legible text color for the sum when it shown on a background color, we
/// need to alpha merge it with background and we need the exact background
/// color it is drawn on for that. If not passed in from parent, it is
/// assumed to be drawn on card color, which usually is close enough.
final Color? onBackgroundColor;
// Return true if the color is light, meaning it needs dark text for contrast.
static bool _isLight(final Color color) =>
ThemeData.estimateBrightnessForColor(color) == Brightness.light;
// On color used when a theme color property does not have a theme onColor.
static Color _onColor(final Color color, final Color bg) =>
_isLight(Color.alphaBlend(color, bg)) ? Colors.black : Colors.white;
@override
Widget build(BuildContext context) {
final ThemeData theme = Theme.of(context);
final ColorScheme colorScheme = theme.colorScheme;
final bool useMaterial3 = theme.useMaterial3;
const double spacing = 4;
// Grab the card border from the theme card shape
ShapeBorder? border = theme.cardTheme.shape;
// If we had one, copy in a border side to it.
if (border is RoundedRectangleBorder) {
border = border.copyWith(
side: BorderSide(
color: colorScheme.outlineVariant,
width: 1,
),
);
// If
} else {
// If border was null, make one matching Card default, but with border
// side, if it was not null, we leave it as it was.
border ??= RoundedRectangleBorder(
borderRadius: BorderRadius.all(Radius.circular(useMaterial3 ? 12 : 4)),
side: BorderSide(
color: colorScheme.outlineVariant,
width: 1,
),
);
}
// Get effective background color.
final Color background =
onBackgroundColor ?? theme.cardTheme.color ?? theme.cardColor;
// Wrap this widget branch in a custom theme where card has a border outline
// if it did not have one, but retains its ambient themed border radius.
return Theme(
data: Theme.of(context).copyWith(
cardTheme: CardTheme.of(context).copyWith(
elevation: 0,
surfaceTintColor: Colors.transparent,
shape: border,
),
),
child: Column(
crossAxisAlignment: CrossAxisAlignment.start,
children: <Widget>[
Padding(
padding: const EdgeInsets.symmetric(vertical: 8),
child: Text(
'ColorScheme Colors',
style: theme.textTheme.titleMedium,
),
),
Wrap(
alignment: WrapAlignment.start,
crossAxisAlignment: WrapCrossAlignment.center,
spacing: spacing,
runSpacing: spacing,
children: <Widget>[
ColorCard(
label: 'Primary',
color: colorScheme.primary,
textColor: colorScheme.onPrimary,
),
ColorCard(
label: 'on\nPrimary',
color: colorScheme.onPrimary,
textColor: colorScheme.primary,
),
ColorCard(
label: 'Primary\nContainer',
color: colorScheme.primaryContainer,
textColor: colorScheme.onPrimaryContainer,
),
ColorCard(
label: 'onPrimary\nContainer',
color: colorScheme.onPrimaryContainer,
textColor: colorScheme.primaryContainer,
),
ColorCard(
label: 'Secondary',
color: colorScheme.secondary,
textColor: colorScheme.onSecondary,
),
ColorCard(
label: 'on\nSecondary',
color: colorScheme.onSecondary,
textColor: colorScheme.secondary,
),
ColorCard(
label: 'Secondary\nContainer',
color: colorScheme.secondaryContainer,
textColor: colorScheme.onSecondaryContainer,
),
ColorCard(
label: 'on\nSecondary\nContainer',
color: colorScheme.onSecondaryContainer,
textColor: colorScheme.secondaryContainer,
),
ColorCard(
label: 'Tertiary',
color: colorScheme.tertiary,
textColor: colorScheme.onTertiary,
),
ColorCard(
label: 'on\nTertiary',
color: colorScheme.onTertiary,
textColor: colorScheme.tertiary,
),
ColorCard(
label: 'Tertiary\nContainer',
color: colorScheme.tertiaryContainer,
textColor: colorScheme.onTertiaryContainer,
),
ColorCard(
label: 'on\nTertiary\nContainer',
color: colorScheme.onTertiaryContainer,
textColor: colorScheme.tertiaryContainer,
),
ColorCard(
label: 'Error',
color: colorScheme.error,
textColor: colorScheme.onError,
),
ColorCard(
label: 'on\nError',
color: colorScheme.onError,
textColor: colorScheme.error,
),
ColorCard(
label: 'Error\nContainer',
color: colorScheme.errorContainer,
textColor: colorScheme.onErrorContainer,
),
ColorCard(
label: 'onError\nContainer',
color: colorScheme.onErrorContainer,
textColor: colorScheme.errorContainer,
),
ColorCard(
label: 'Background',
color: colorScheme.background,
textColor: colorScheme.onBackground,
),
ColorCard(
label: 'on\nBackground',
color: colorScheme.onBackground,
textColor: colorScheme.background,
),
ColorCard(
label: 'Surface',
color: colorScheme.surface,
textColor: colorScheme.onSurface,
),
ColorCard(
label: 'on\nSurface',
color: colorScheme.onSurface,
textColor: colorScheme.surface,
),
ColorCard(
label: 'Surface\nVariant',
color: colorScheme.surfaceVariant,
textColor: colorScheme.onSurfaceVariant,
),
ColorCard(
label: 'onSurface\nVariant',
color: colorScheme.onSurfaceVariant,
textColor: colorScheme.surfaceVariant,
),
ColorCard(
label: 'Outline',
color: colorScheme.outline,
textColor: colorScheme.background,
),
ColorCard(
label: 'Outline\nVariant',
color: colorScheme.outlineVariant,
textColor: colorScheme.onBackground,
),
ColorCard(
label: 'Shadow',
color: colorScheme.shadow,
textColor: _onColor(colorScheme.shadow, background),
),
ColorCard(
label: 'Scrim',
color: colorScheme.scrim,
textColor: _onColor(colorScheme.scrim, background),
),
ColorCard(
label: 'Inverse\nSurface',
color: colorScheme.inverseSurface,
textColor: colorScheme.onInverseSurface,
),
ColorCard(
label: 'onInverse\nSurface',
color: colorScheme.onInverseSurface,
textColor: colorScheme.inverseSurface,
),
ColorCard(
label: 'Inverse\nPrimary',
color: colorScheme.inversePrimary,
textColor: colorScheme.inverseSurface,
),
ColorCard(
label: 'Surface\nTint',
color: colorScheme.surfaceTint,
textColor: colorScheme.onPrimary,
),
],
),
],
),
);
}
}
/// A [SizedBox] with a [Card] and string text in it. Used in this demo to
/// display theme color boxes.
///
/// Can specify label text color and background color.
class ColorCard extends StatelessWidget {
const ColorCard({
super.key,
required this.label,
required this.color,
required this.textColor,
this.size,
});
final String label;
final Color color;
final Color textColor;
final Size? size;
@override
Widget build(BuildContext context) {
const double fontSize = 11;
const Size effectiveSize = Size(86, 58);
return SizedBox(
width: effectiveSize.width,
height: effectiveSize.height,
child: Card(
margin: EdgeInsets.zero,
clipBehavior: Clip.antiAlias,
color: color,
child: Center(
child: Text(
label,
style: TextStyle(color: textColor, fontSize: fontSize),
textAlign: TextAlign.center,
),
),
),
);
}
}
DropdownMenu themed focused item broken
The style indication of the found and focused/selected item in a
DropdownMenudoes not useMenuButtonThemeData. Its simulation of the focused state omits the theme.This makes it impossible to provide a consistent style for the focused/selected item when using a custom theme in a
DropdownMenu. One have to live with the default style for the entire menu, or accept a deviant and out of style looking focused/selected item.Expected results
Expect to be able to theme the found selected item in a
DropdownMenuto a style where the selected item would match the style of used custom theme, and do so on all hover/focus/pressed themed MaterialState dependent colors.Consider these on purpose wild looking
MenuThemeDataandMenuButtonThemeData, used to visually highlight the functional gaps.Theme snippet
(For full code sample, see the Issue sample code further below).
Expect the theme to use above defined MenuButtonThemeData
ButtonStyletheming and look and behave as shown below:Screen.Recording.2023-03-30.at.1.16.34.mov
Actual results
Get a style where the focused (and selected) item has a style that does not used the themed style, it effectively ignores the theme defined by the
MenuButtonThemeDatatheme, concerning itsfocusedstates for all theme colors.Screen.Recording.2023-03-30.at.2.10.14.mov
Discussion
EDIT: The accessibility topic found during creation of this issues and included in this discussion topic previously, have on request been moved to its own issues, see #123797.
Fix used to demo expected result
An experimental revised and fixed version of
_buildButtons(..)function from filedropdown_menu.dart, used to generate the expected result above is included below for reference.It may be useful as a starting point for an actual fix. It only patches the current implementation concerning it ignoring the theme. It does not address the discussion part above.
This fix also has the same "hack" feel as the original implementation. It uses knowledge about what the M3 token defaults are for a default
focuseddropdown menu item, as its fallback defaults for the simulated none widget/themed defaults. It does so, since it cannot access the_MenuButtonDefaultsM3private class inmenu_anchor.dart. This is not the first time I have run into a situation where it would be useful to have access to the theme default classes, outside their component class files.I checked the quick fix below with existing tests in
dropdown_menu_theme_test.dartanddropdown_test.dart. It did not break any existing test in them. Existing tests do not capture this issue because they do not even include any customization ofDropdownMenuviaMenuButtonThemeData. The tests rely on that being covered byMenuItemButtonrelated tests. SinceDropdownMenuoverridesMenuItemButtondefault behavior, it needs its own tests of those parts to ensure those overrides do not break expected theming features of usedMenuItemButton.Issue sample code
Code sample
Used Flutter version
Channel master, 3.9.0-19.0.pre.50
Flutter doctor
Other Issues Related to DropdownMenu and Menus
ThemeData.dropDownMenuTheme.inputDecorationThemedoes not inherit fromThemeData.inputDecorationTheme#131213DropdownMenu] menu appears behind the keyboard #123395errorTextandhelperTextparameters in M3DropdownMenu#119743