Skip to content

Document Checkbox.fillColor behavior change #130295

Description

@rydmike

Is there an existing issue for this?

Steps to reproduce

The Checkbox component has a theme regression when comparing Flutter stable 3.10.5 (and earlier versions) with latest master channel (3.12.0-15.0.pre.74).

The issue applies to both M2 and M3 mode, as well as light and dark themes.

Background

This issue is is first mentioned mentioned in PR comment here #125643 (comment) and issue reproduction sample requested by @QuncCccccc here #125643 (comment).

cc: @TahaTesser

Expected results

When using an elaborate custom Checkbox theme on stable channel, with different optional settings giving us these themed results in stable 3.10.5 channel, we
EXPECT the themed results to be identical on master channel to these stable channel results:

No theme Theme A
Screenshot 2023-07-11 at 1 14 04 Screenshot 2023-07-11 at 1 14 18
Theme B Theme C
Screenshot 2023-07-11 at 1 14 29 Screenshot 2023-07-11 at 1 14 37

Actual results

The actual results on master channel are radically different as seen below:

No theme Theme A
Screenshot 2023-07-11 at 1 10 04 Screenshot 2023-07-11 at 1 10 21
Theme B Theme C
Screenshot 2023-07-11 at 1 10 28 Screenshot 2023-07-11 at 1 10 35

Cause

This PR causes the BREAKING changes: #125643

Proposal

Instead of breaking past fillColor behavior, consider introducing new backgroundColor that cannot be used together with fillColor. The fillColor can then be deprecated and removed in a more controlled manner instead of instant breakage, or some similar solution.

Instant breaking changes like these are impossible to work around or gradually adapt to. Breakage over longer period with due deprecation grace period are fine and not an issue.

When this PR #125643 lands in stable it will instantly break FlexColorScheme package Checkbox theming that depends on past behavior working as it currently does.

I like what the issue tries to solve. However, it would be so much nicer if it did without breaking past properties and their already used and established behavior.

Code sample

Code sample
// 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 NON-INFRINGEMENT. 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';

// This issue reported here:

// ***************************************************************************
// THESE styling constants and functions below are not important for the issue
// I just usd them as a real example of the syles created by this use case

/// The amount of alpha based opacity used on tinted disabled effect.
///
/// Same value as used on focused opacity on controls in M3, given as alpha.
///
/// Value: 0x61 = 97 = 38.04%
const int kAlphaDisabled = 0x61;

/// Unselected colored Checkbox, Radio alpha value.
///
/// Value: 0xDD = 221 = 86.67%
const int kAlphaUnselect = 0xDD;

/// The amount of alpha based opacity used on tinted hover effect.
///
/// Same value as used on Hover opacity on controls in M3, given as alpha.
///
/// Value: 0x14 = 20 = 8%
const int kAlphaHovered = 0x14;

/// The amount of alpha based opacity used on tinted focus effect.
///
/// Same value as used on focused opacity on controls in M3, given as alpha.
///
/// Value: 0x1F = 31 = 12.16%
const int kAlphaFocused = 0x1F;

/// The amount of alpha based opacity used on tinted pressed effect.
///
/// Same value as used on pressed opacity on controls in M3, given as alpha.
///
/// Value: 0x1F = 31 = 12.16%
const int kAlphaPressed = 0x1F;

/// The amount of alpha blend used on tinted hover effect that is blended
/// into overlay color.
///
/// Value: 0x99 = 153 = 60%
const int kTintHover = 0x99;

/// The amount of alpha blend used on tinted disabled effect that is blended
/// into overlay color.
///
/// Value: 0x66 = 102 = 40%
const int kTintDisabled = 0x66;

/// The amount of alpha blend used on tinted pressed effect that is blended
/// into overlay color.
///
/// Value: 0xA5 = 165 = 65%
const int kTintPressed = 0xA5;

/// The amount of alpha blend used on tinted focus effect that is blended
/// into overlay color.
///
/// Value: 0xB2 = 178 = 70%
const int kTintFocus = 0xB2;

extension FlexColorExtensions on Color {
  /// Blend in the given input Color with an alpha value.
  ///
  /// You typically apply this on a background color, light or dark
  /// to create a background color with a hint of a color used in a theme.
  ///
  /// This is a use case of the alphaBlend static function that exists in
  /// dart:ui Color. It is used to create the branded surface colors in
  /// FlexColorScheme and to calculate dark scheme colors from light ones,
  /// by blending in white color with light scheme color.
  ///
  /// Defaults to alpha 0x0A alpha blend of the passed in Color value,
  /// which is 10% alpha blend.
  Color blendAlpha(final Color input, [final int alpha = 0x0A]) {
    // Skip blending for impossible value and return the instance color value.
    if (alpha <= 0) return this;
    // Blend amounts >= 255 results in the input Color.
    if (alpha >= 255) return input;
    return Color.alphaBlend(input.withAlpha(alpha), this);
  }
}

/// Returns the FCS opinionated tinted disabled color on an overlay color.
///
/// Typically the primary color is the color used as tint base.
/// The tint effect is different for light and dark mode.
Color tintedDisabled(Color overlay, Color tint) =>
// Tint color alpha blend into overlay #66=40%
// Opacity of result #61=38%, same as M3 opacity on disable.
    overlay.blendAlpha(tint, kTintDisabled).withAlpha(kAlphaDisabled);

/// Returns the FCS opinionated tinted hover color on an overlay color.
///
/// Typically the primary color is the color used as tint base.
/// The tint effect is different for light and dark mode.
Color tintedHovered(Color overlay, Color tint, [double factor = 1]) {
// Starting kAlphaHover 0x14=20=8%, same as M3 opacity on hover.
  final int usedAlpha = (kAlphaHovered * factor).round().clamp(0x00, 0xFF);
// Tint color alpha blend into overlay kTintHover  0x99=153= 60%
  return overlay.blendAlpha(tint, kTintHover).withAlpha(usedAlpha);
}

/// Returns the FCS opinionated tinted splash color on an overlay color.
///
/// Typically the primary color is the color used as tint base.
/// The tint effect is different for light and dark mode.
Color tintedPressed(Color overlay, Color tint, [double factor = 1]) {
// Starting kAlphaPressed 0x1F = 31 = 12.16%, same as M3 opacity on pressed.
  final int usedAlpha = (kAlphaPressed * factor).round().clamp(0x00, 0xFF);
// Tint color alpha blend into overlay kTintPressed 0xA5 = 165 = 65%
  return overlay.blendAlpha(tint, kTintPressed).withAlpha(usedAlpha);
}

/// Returns the FCS opinionated tinted focus color on an overlay color.
///
/// Typically the primary color is the color used as tint base.
/// The tint effect is different for light and dark mode.
Color tintedFocused(Color overlay, Color tint, [double factor = 1]) {
// Starting kAlphaFocus 0x1F = 31 = 12.16%, same as M3 opacity on focus.
  final int usedAlpha = (kAlphaFocused * factor).round().clamp(0x00, 0xFF);
// Tint color alpha blend into overlay kTintFocus 0xB2 = 178 = 70%.
  return overlay.blendAlpha(tint, kTintFocus).withAlpha(usedAlpha);
}

/// A factor used by tinted interactions to increase the alpha based
/// opacity Material 3 baseline based opacity values for hover, focus and
/// splash under certain conditions.
///
/// Used by component themes. The factor is different depending on
/// if the color is light or dark. This factor increases the opacity of
/// the overlay color compared to the opacity used by M3 default. It works
/// well because the overlay color is also alpha blend colored. This extra
/// factor is used for interaction effects on colored widgets, when
/// using interactions on surface colors a lower factor is used.
double tintAlphaFactor(Color color, Brightness mode,
    [bool surfaceMode = false]) {
  if (mode == Brightness.light) {
    return surfaceMode
        ? ThemeData.estimateBrightnessForColor(color) == Brightness.dark
            ? 1.5
            : 4.0
        : ThemeData.estimateBrightnessForColor(color) == Brightness.dark
            ? 5.0
            : 2.0;
  } else {
    return surfaceMode
        ? ThemeData.estimateBrightnessForColor(color) == Brightness.dark
            ? 5.0
            : 2.0
        : ThemeData.estimateBrightnessForColor(color) == Brightness.dark
            ? 5.0
            : 4.0;
  }
}

// END of not ISSUE relevant styling constants and functions.
// ***************************************************************************

// A seed color for the M3 ColorScheme.
const Color seedColor = Color(0xFF2E747D); // Color(0xFF6750A4);

// Example theme
ThemeData theme(Brightness brightness, ThemeSettings settings) {
  // Make M3 ColorSchemes from a seed color.
  final ColorScheme colorScheme = ColorScheme.fromSeed(
    brightness: brightness,
    seedColor: seedColor,
  );
  final bool useM3 = settings.useMaterial3;
  final bool isLight = brightness == Brightness.light;
  final bool useCustomCheck = settings.customCheck;
  final bool coloredUnselected = settings.coloredUnselected;
  final bool tintedDisable = settings.tintedDisable;
  final bool tintedInteract = settings.tintedInteraction;
  final Color baseColor = colorScheme.primary;
  final Color onBaseColor = colorScheme.onPrimary;

  // Using these tinted overlay variable in all themes for ease of
  // reasoning and duplication.
  final Color overlay = colorScheme.surface;
  final Color tint = baseColor;
  final double factor = tintAlphaFactor(tint, colorScheme.brightness, true);

  return ThemeData(
    colorScheme: colorScheme,
    useMaterial3: settings.useMaterial3,
    visualDensity: VisualDensity.standard,
    checkboxTheme: useCustomCheck
        ? CheckboxThemeData(
            checkColor: MaterialStateProperty.resolveWith<Color>(
              (Set<MaterialState> states) {
                if (useM3) {
                  if (states.contains(MaterialState.disabled)) {
                    if (states.contains(MaterialState.selected)) {
                      return colorScheme.surface;
                    }
                    return Colors.transparent;
                  }
                  if (states.contains(MaterialState.selected)) {
                    if (states.contains(MaterialState.error)) {
                      return colorScheme.onError;
                    }
                    return onBaseColor;
                  }
                  return Colors.transparent;
                } else {
                  if (states.contains(MaterialState.disabled)) {
                    return isLight
                        ? Colors.grey.shade200
                        : Colors.grey.shade900;
                  }
                  if (states.contains(MaterialState.selected)) {
                    return onBaseColor;
                  }
                  return isLight ? Colors.grey.shade50 : Colors.grey.shade400;
                }
              },
            ),
            fillColor: MaterialStateProperty.resolveWith<Color>(
              (Set<MaterialState> states) {
                if (useM3) {
                  if (states.contains(MaterialState.disabled)) {
                    if (tintedDisable) {
                      return tintedDisabled(colorScheme.onSurface, baseColor);
                    }
                    return colorScheme.onSurface.withAlpha(kAlphaDisabled);
                  }
                  if (states.contains(MaterialState.error)) {
                    return colorScheme.error;
                  }
                  if (states.contains(MaterialState.selected)) {
                    return baseColor;
                  }
                  if (states.contains(MaterialState.pressed)) {
                    if (coloredUnselected) return baseColor;
                    return colorScheme.onSurface;
                  }
                  if (states.contains(MaterialState.hovered)) {
                    if (coloredUnselected) return baseColor;
                    return colorScheme.onSurface;
                  }
                  if (states.contains(MaterialState.focused)) {
                    if (coloredUnselected) return baseColor;
                    return colorScheme.onSurface;
                  }
                  if (coloredUnselected) {
                    return baseColor.withAlpha(kAlphaUnselect);
                  }
                  return colorScheme.onSurfaceVariant;
                } else {
                  if (states.contains(MaterialState.disabled)) {
                    if (tintedDisable) {
                      return tintedDisabled(colorScheme.onSurface, baseColor);
                    }
                    return isLight
                        ? Colors.grey.shade400
                        : Colors.grey.shade800;
                  }
                  if (states.contains(MaterialState.selected)) {
                    return baseColor;
                  }
                  // Opinionated color on unselected checkbox.
                  if (coloredUnselected) {
                    return baseColor.withAlpha(kAlphaUnselect);
                  }
                  // This is M2 SDK default.
                  return isLight ? Colors.black54 : Colors.white70;
                }
              },
            ),
            overlayColor: MaterialStateProperty.resolveWith<Color>(
              (Set<MaterialState> states) {
                // Error state only exists in M3 mode.
                if (states.contains(MaterialState.error) && useM3) {
                  if (states.contains(MaterialState.pressed)) {
                    return colorScheme.error.withAlpha(kAlphaPressed);
                  }
                  if (states.contains(MaterialState.hovered)) {
                    return colorScheme.error.withAlpha(kAlphaHovered);
                  }
                  if (states.contains(MaterialState.focused)) {
                    return colorScheme.error.withAlpha(kAlphaFocused);
                  }
                }
                if (states.contains(MaterialState.selected)) {
                  if (states.contains(MaterialState.pressed)) {
                    if (tintedInteract) {
                      return tintedPressed(overlay, tint, factor);
                    }
                    return colorScheme.onSurface.withAlpha(kAlphaPressed);
                  }
                  if (states.contains(MaterialState.hovered)) {
                    if (tintedInteract) {
                      return tintedHovered(overlay, tint, factor);
                    }
                    return baseColor.withAlpha(kAlphaHovered);
                  }
                  if (states.contains(MaterialState.focused)) {
                    if (tintedInteract) {
                      return tintedFocused(overlay, tint, factor);
                    }
                    return baseColor.withAlpha(kAlphaFocused);
                  }
                  return Colors.transparent;
                }
                if (states.contains(MaterialState.pressed)) {
                  if (tintedInteract) {
                    return tintedPressed(overlay, tint, factor);
                  }
                  return baseColor.withAlpha(kAlphaPressed);
                }
                if (states.contains(MaterialState.hovered)) {
                  if (tintedInteract) {
                    return tintedHovered(overlay, tint, factor);
                  }
                  return colorScheme.onSurface.withAlpha(kAlphaHovered);
                }
                if (states.contains(MaterialState.focused)) {
                  if (tintedInteract) {
                    return tintedFocused(overlay, tint, factor);
                  }
                  return colorScheme.onSurface.withAlpha(kAlphaFocused);
                }
                return Colors.transparent;
              },
            ),
          )
        : 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;
  ThemeSettings settings = const ThemeSettings(
    useMaterial3: true,
    customCheck: false,
    tintedDisable: false,
    tintedInteraction: false,
    coloredUnselected: false,
  );

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      debugShowCheckedModeBanner: false,
      themeMode: themeMode,
      theme: theme(Brightness.light, settings),
      darkTheme: theme(Brightness.dark, settings),
      home: Scaffold(
        extendBodyBehindAppBar: true,
        appBar: AppBar(
          title: settings.useMaterial3
              ? const Text('Checkbox regression (M3)')
              : const Text('Checkbox regression (M2)'),
          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;
            });
          },
        ),
      ),
    );
  }
}

class HomePage extends StatefulWidget {
  const HomePage({
    super.key,
    required this.settings,
    required this.onSettings,
  });

  final ThemeSettings settings;
  final ValueChanged<ThemeSettings> onSettings;

  @override
  State<HomePage> createState() => _HomePageState();
}

class _HomePageState extends State<HomePage> {
  bool? isSelected1 = true;
  bool? isSelected2;

  @override
  Widget build(BuildContext context) {
    return ListView(
      children: [
        const SizedBox(height: 8),
        const Padding(
          padding: EdgeInsets.symmetric(horizontal: 16),
          child: Text(
            'Checkbox regression by '
            'PR https://github.com/flutter/flutter/pull/125643.',
          ),
        ),
        const Divider(),
        SwitchListTile(
          title: const Text('Enable custom Checkbox theme'),
          value: widget.settings.customCheck,
          onChanged: (bool value) {
            widget.onSettings(widget.settings.copyWith(customCheck: value));
          },
        ),
        SwitchListTile(
          title: const Text('Checkbox theme with tinted interactions'),
          value: widget.settings.customCheck
              ? widget.settings.tintedInteraction
              : false,
          onChanged: widget.settings.customCheck
              ? (bool value) {
                  widget.onSettings(
                      widget.settings.copyWith(tintedInteraction: value));
                }
              : null,
        ),
        SwitchListTile(
          title: const Text('Checkbox theme with tinted disabled states'),
          value: widget.settings.customCheck
              ? widget.settings.tintedDisable
              : false,
          onChanged: widget.settings.customCheck
              ? (bool value) {
                  widget.onSettings(
                      widget.settings.copyWith(tintedDisable: value));
                }
              : null,
        ),
        SwitchListTile(
          title: const Text('Checkbox theme with colored unselected outline'),
          value: widget.settings.customCheck
              ? widget.settings.coloredUnselected
              : false,
          onChanged: widget.settings.customCheck
              ? (bool value) {
                  widget.onSettings(
                      widget.settings.copyWith(coloredUnselected: value));
                }
              : null,
        ),
        Wrap(
          crossAxisAlignment: WrapCrossAlignment.center,
          spacing: 8,
          runSpacing: 8,
          children: <Widget>[
            const SizedBox(width: 8),
            const Text('Themed Checkbox: '),
            Checkbox(
              value: isSelected1,
              onChanged: (bool? value) {
                setState(() {
                  isSelected1 = value;
                });
              },
            ),
            Checkbox(
              tristate: true,
              value: isSelected2,
              onChanged: (bool? value) {
                setState(() {
                  isSelected2 = value;
                });
              },
            ),
            Checkbox(
              value: false,
              onChanged: (bool? value) {},
            ),
            const Checkbox(
              value: true,
              onChanged: null,
            ),
            const Checkbox(
              value: null,
              tristate: true,
              onChanged: null,
            ),
            const Checkbox(
              value: false,
              onChanged: null,
            ),
          ],
        ),
        const Divider(),
        const SizedBox(height: 16),
        const Padding(
          padding: EdgeInsets.symmetric(horizontal: 16),
          child: ShowColorSchemeColors(),
        ),
      ],
    );
  }
}

/// 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 customCheck;
  final bool tintedInteraction;
  final bool tintedDisable;
  final bool coloredUnselected;

  const ThemeSettings({
    required this.useMaterial3,
    required this.customCheck,
    required this.tintedInteraction,
    required this.tintedDisable,
    required this.coloredUnselected,
  });

  /// Flutter debug properties override, includes toString.
  @override
  void debugFillProperties(DiagnosticPropertiesBuilder properties) {
    super.debugFillProperties(properties);
    properties.add(DiagnosticsProperty<bool>('useMaterial3', useMaterial3));
    properties.add(DiagnosticsProperty<bool>('customCheckTheme', customCheck));
    properties
        .add(DiagnosticsProperty<bool>('tintedInteraction', tintedInteraction));
    properties.add(DiagnosticsProperty<bool>('tintedDisable', tintedDisable));
    properties.add(
        DiagnosticsProperty<bool>('customCheckUnselected', coloredUnselected));
  }

  /// Copy the object with one or more provided properties changed.
  ThemeSettings copyWith({
    bool? useMaterial3,
    bool? customCheck,
    bool? tintedInteraction,
    bool? tintedDisable,
    bool? coloredUnselected,
  }) {
    return ThemeSettings(
      useMaterial3: useMaterial3 ?? this.useMaterial3,
      customCheck: customCheck ?? this.customCheck,
      tintedInteraction: tintedInteraction ?? this.tintedInteraction,
      tintedDisable: tintedDisable ?? this.tintedDisable,
      coloredUnselected: coloredUnselected ?? this.coloredUnselected,
    );
  }

  /// 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.customCheck == customCheck &&
        other.tintedInteraction == tintedInteraction &&
        other.tintedDisable == tintedDisable &&
        other.coloredUnselected == coloredUnselected;
  }

  /// Override for hashcode, dart.ui Jenkins based.
  @override
  int get hashCode => Object.hashAll(<Object?>[
        useMaterial3.hashCode,
        customCheck.hashCode,
        tintedInteraction.hashCode,
        tintedDisable.hashCode,
        coloredUnselected.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,
          ),
        ),
      ),
    );
  }
}

Flutter Doctor output

Used Flutter version Channel master, 3.12.0-15.0.pre.74

Doctor output
flutter doctor -v
flutter doctor -v
[!] Flutter (Channel master, 3.12.0-15.0.pre.74, on macOS 13.4.1 22F82 darwin-arm64, locale en-US)
    • Flutter version 3.12.0-15.0.pre.74 on channel master at /Users/rydmike/fvm/versions/master
    • Upstream repository https://github.com/flutter/flutter.git
    • Framework revision cb91ba11a9 (54 minutes ago), 2023-07-10 16:08:08 -0400
    • Engine revision 71c5674a44
    • Dart version 3.1.0 (build 3.1.0-291.0.dev)
    • DevTools version 2.25.0
    • If those were intentional, you can disregard the above warnings; however it is recommended to use "git" directly to perform
      update checks and upgrades.

[✓] Android toolchain - develop for Android devices (Android SDK version 33.0.0)
    • Android SDK at /Users/rydmike/Library/Android/sdk
    • Platform android-33, build-tools 33.0.0
    • Java binary at: /Applications/Android Studio.app/Contents/jbr/Contents/Home/bin/java
    • Java version OpenJDK Runtime Environment (build 17.0.6+0-17.0.6b802.4-9586694)
    • All Android licenses accepted.

[✓] Xcode - develop for iOS and macOS (Xcode 14.3.1)
    • Xcode at /Applications/Xcode.app/Contents/Developer
    • Build 14E300c
    • CocoaPods version 1.11.3

[✓] Chrome - develop for the web
    • Chrome at /Applications/Google Chrome.app/Contents/MacOS/Google Chrome

[✓] Android Studio (version 2022.2)
    • Android Studio at /Applications/Android Studio.app/Contents
    • Flutter plugin can be installed from:
      🔨 https://plugins.jetbrains.com/plugin/9212-flutter
    • Dart plugin can be installed from:
      🔨 https://plugins.jetbrains.com/plugin/6351-dart
    • Java version OpenJDK Runtime Environment (build 17.0.6+0-17.0.6b802.4-9586694)

[✓] IntelliJ IDEA Community Edition (version 2023.1.3)
    • IntelliJ at /Applications/IntelliJ IDEA CE.app
    • Flutter plugin version 74.0.4
    • Dart plugin version 231.9161.14

[✓] VS Code (version 1.79.2)
    • VS Code at /Applications/Visual Studio Code.app/Contents
    • Flutter extension version 3.62.0

[✓] Connected device (2 available)
    • macOS (desktop) • macos  • darwin-arm64   • macOS 13.4.1 22F82 darwin-arm64
    • Chrome (web)    • chrome • web-javascript • Google Chrome 114.0.5735.198

[✓] Network resources
    • All expected network resources are available.

Activity

  1. added
    in triagePresently being triaged by the triage team
    c: regressionIt was better in the past than it is now
    frameworkflutter/packages/flutter repository. See also f: labels.
    p: material_uimaterial_ui package in flutter/packages
    team-designOwned by Design Languages team
    has reproducible stepsThe issue has been confirmed reproducible and is ready to work on
    and removed
    in triagePresently being triaged by the triage team
    on Jul 11, 2023
  2. added
    P2Important issues not at the top of the work list
    on Jul 12, 2023
  3. rydmike commented on Jul 24, 2023

    @rydmike
    ContributorAuthor

    This regression issue has now regressed into latest beta channel 3.13.0-0.2.pre and will thus land in next stable and break current Checkbox theming. It will do so with zero breaking or deprecation time.

    cc: @HansMuller @TahaTesser @QuncCccccc

  4. QuncCccccc commented on Jul 24, 2023

    @QuncCccccc
    Contributor

    Thanks a lot for filing this issue! The proposal(Deprecating fillColor and creating a property for background color) sounds good to me. I can work on this later.

  5. rydmike commented on Jul 25, 2023

    @rydmike
    ContributorAuthor

    Cool, would be nice and proper if this does not land as an unplanned immediately breaking change in next stable. It is already in beta now and thus scheduled to land, as an unexpected breaking change, in next stable.

    So it either should be reverted from beta or beta needs a CP fix.

  6. rydmike commented on Aug 13, 2023

    @rydmike
    ContributorAuthor

    Hi @HansMuller and @QuncCccccc, I can see that this regression still exists in Channel beta, 3.13.0-0.3.pre so assume it will land as is in next stable?

    Suggestion

    Even though this is a sudden and unexpected breaking change/regression. Personally I think it would be fine keeping it as is by just adding a breaking change notice and migration info in the next stable release. So that those that might potentially be hit by it knows why and what to do. I think it might be rare that users are impacted by this, but I'm sure some might be.


    Personally I am in FlexColorScheme and ThemesPlayground as preparation for this, adding a fix/change commit that uses this new behavior.

  7. added a commit that references this issue on Aug 13, 2023
  8. 7 remaining items

  9. miDeb commented on Aug 21, 2023

    @miDeb
    Contributor

    I agree with @rydmike that the fix is to improve the documentation, as the fix for apps is quite trivial. At least in our case, all we had to do was to add a if (!states.contains(MaterialState.selected)) return Colors.transparent; to our MaterialStateProperty.resolveWith callback.

  10. TahaTesser commented on Aug 22, 2023

    @TahaTesser
    Contributor

    Based on #130295 (comment)

    Since this is an improvement over the previous behavior and it doesn't break the widget itself.
    I'm documenting this as a breaking change in behavior.

  11. moved this from To do to In progress in Nevercodeon Aug 22, 2023
  12. changed the title [-][Material] Checkbox theme regression[/-] [+]Document `Checkbox.fillColor` behavior change[/+] on Aug 22, 2023
  13. TahaTesser commented on Aug 22, 2023

    @TahaTesser
    Contributor

    @rydmike
    Filed the migration guide in flutter/website#9279

  14. moved this from In progress to PR submitted in Nevercodeon Aug 22, 2023
  15. rydmike commented on Aug 22, 2023

    @rydmike
    ContributorAuthor

    @HansMuller and @QuncCccccc, if you had a very intricate theme on Checkbox box, with optional custom selected, error, hover, focused, pressed, and disabled state designs, then the change was pretty significant. I had to review and update all the state designs for side and fillColor.

    In flex_color_scheme, it meant that I had to review and update 175 lines of code in the component theme to make it work correctly and as intended again. Plus I had to revise/update/fix 780 lines of test code for its various config options in light/dark/M2/M3/custom-options mode, that this change actually partially broke, which is why I found it early to begin with. Just saying, that from my point of view this sudden and unplanned breaking change was very significant. I also had to make a special new release of said package that now requires minimum Flutter 3.13.0, because this theming feature does not work like this on any previous version.

    So yes this breaking change was certainly quite disappointing and irritating, especially since it could have been implemented and introduced in an un-breaking manner, with a more planned deprecation of older API in favor of this new better design, using alternative new names instead, that cannot be combined with older API.

    That said, this new behavior is certainly better and gives more design freedom and works more as one would have expected the original API to work. I'm all for improving things, but please preferably when possible in staged steps so things don't just land without any deprecation warning and just suddenly completely change the result an API produces visually. It is just imo not good practice for a framework API to do things this way. Please consider improving the process.

    Very pleased to see a breaking change notice now added to docs, even if is "post mortem" 😄 for this change, by @TahaTesser - thank you! 👍🏻

  16. moved this from PR submitted to Done (PR merged) in Nevercodeon Aug 22, 2023
  17. TahaTesser commented on Aug 23, 2023

    @TahaTesser
    Contributor
  18. github-actions commented on Sep 6, 2023

    @github-actions

    This thread has been automatically locked since there has not been any recent activity after it was closed. If you are still experiencing a similar issue, please open a new bug, including the output of flutter doctor -v and a minimal reproduction of the issue.

  19. locked as resolved and limited conversation to collaborators on Sep 6, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

P2Important issues not at the top of the work listfound in release: 3.12Found to occur in 3.12frameworkflutter/packages/flutter repository. See also f: labels.has reproducible stepsThe issue has been confirmed reproducible and is ready to work onp: material_uimaterial_ui package in flutter/packagesteam-designOwned by Design Languages teamtriaged-designTriaged by Design Languages team

Type

No type

Projects

  • Status
    Done (PR merged)

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions