ThemeData constructor

Implementation

factory ThemeData({
  // For the sanity of the reader, make sure these properties are in the same
  // order in every place that they are separated by section comments (e.g.
  // GENERAL CONFIGURATION). Each section except for deprecations should be
  // alphabetical by symbol name.

  // GENERAL CONFIGURATION
  Iterable<Adaptation<Object>>? adaptations,
  bool? applyElevationOverlayColor,
  NoDefaultCupertinoThemeData? cupertinoOverrideTheme,
  Iterable<ThemeExtension<dynamic>>? extensions,
  // TODO(bleroux): Change the parameter type to InputDecorationThemeData.
  Object? inputDecorationTheme,
  MaterialTapTargetSize? materialTapTargetSize,
  PageTransitionsTheme? pageTransitionsTheme,
  TargetPlatform? platform,
  ScrollbarThemeData? scrollbarTheme,
  InteractiveInkFeatureFactory? splashFactory,
  bool? useMaterial3,
  bool? useSystemColors,
  VisualDensity? visualDensity,
  // COLOR
  ColorScheme? colorScheme,
  Brightness? brightness,
  Color? colorSchemeSeed,
  double? contrastLevel,
  // [colorScheme] is the preferred way to configure colors. The [Color] properties
  // listed below (as well as primarySwatch) will gradually be phased out, see
  // https://github.com/flutter/flutter/issues/91772.
  Color? canvasColor,
  Color? cardColor,
  Color? disabledColor,
  Color? dividerColor,
  Color? focusColor,
  Color? highlightColor,
  Color? hintColor,
  Color? hoverColor,
  Color? primaryColor,
  Color? primaryColorDark,
  Color? primaryColorLight,
  MaterialColor? primarySwatch,
  Color? scaffoldBackgroundColor,
  Color? secondaryHeaderColor,
  Color? shadowColor,
  Color? splashColor,
  Color? unselectedWidgetColor,
  // TYPOGRAPHY & ICONOGRAPHY
  String? fontFamily,
  List<String>? fontFamilyFallback,
  String? package,
  IconThemeData? iconTheme,
  IconThemeData? primaryIconTheme,
  TextTheme? primaryTextTheme,
  TextTheme? textTheme,
  Typography? typography,
  // COMPONENT THEMES
  ActionIconThemeData? actionIconTheme,
  // TODO(huycozy): Change the parameter type to AppBarThemeData
  Object? appBarTheme,
  BadgeThemeData? badgeTheme,
  MaterialBannerThemeData? bannerTheme,
  BottomAppBarThemeData? bottomAppBarTheme,
  BottomNavigationBarThemeData? bottomNavigationBarTheme,
  BottomSheetThemeData? bottomSheetTheme,
  ButtonThemeData? buttonTheme,
  CardThemeData? cardTheme,
  CarouselViewThemeData? carouselViewTheme,
  CheckboxThemeData? checkboxTheme,
  ChipThemeData? chipTheme,
  DataTableThemeData? dataTableTheme,
  DatePickerThemeData? datePickerTheme,
  DialogThemeData? dialogTheme,
  DividerThemeData? dividerTheme,
  DrawerThemeData? drawerTheme,
  DropdownMenuThemeData? dropdownMenuTheme,
  ElevatedButtonThemeData? elevatedButtonTheme,
  ExpansionTileThemeData? expansionTileTheme,
  FilledButtonThemeData? filledButtonTheme,
  FloatingActionButtonThemeData? floatingActionButtonTheme,
  IconButtonThemeData? iconButtonTheme,
  ListTileThemeData? listTileTheme,
  MenuBarThemeData? menuBarTheme,
  MenuButtonThemeData? menuButtonTheme,
  MenuThemeData? menuTheme,
  NavigationBarThemeData? navigationBarTheme,
  NavigationDrawerThemeData? navigationDrawerTheme,
  NavigationRailThemeData? navigationRailTheme,
  OutlinedButtonThemeData? outlinedButtonTheme,
  PopupMenuThemeData? popupMenuTheme,
  ProgressIndicatorThemeData? progressIndicatorTheme,
  RadioThemeData? radioTheme,
  SearchBarThemeData? searchBarTheme,
  SearchViewThemeData? searchViewTheme,
  SegmentedButtonThemeData? segmentedButtonTheme,
  SliderThemeData? sliderTheme,
  SnackBarThemeData? snackBarTheme,
  SwitchThemeData? switchTheme,
  TabBarThemeData? tabBarTheme,
  TextButtonThemeData? textButtonTheme,
  TextSelectionThemeData? textSelectionTheme,
  TimePickerThemeData? timePickerTheme,
  ToggleButtonsThemeData? toggleButtonsTheme,
  TooltipThemeData? tooltipTheme,
  // DEPRECATED (newest deprecations at the bottom)
  @Deprecated(
    'Use OverflowBar instead. '
    'This feature was deprecated after v3.21.0-10.0.pre.',
  )
  ButtonBarThemeData? buttonBarTheme,
  @Deprecated(
    'Use DialogThemeData.backgroundColor instead. '
    'This feature was deprecated after v3.27.0-0.1.pre.',
  )
  Color? dialogBackgroundColor,
  @Deprecated(
    'Use TabBarThemeData.indicatorColor instead. '
    'This feature was deprecated after v3.28.0-1.0.pre.',
  )
  Color? indicatorColor,
}) {
  // GENERAL CONFIGURATION
  cupertinoOverrideTheme = cupertinoOverrideTheme?.noDefault();
  extensions ??= <ThemeExtension<dynamic>>[];
  adaptations ??= <Adaptation<Object>>[];
  // TODO(bleroux): Clean this up once the type of `inputDecorationTheme` is changed to `InputDecorationThemeData`
  if (inputDecorationTheme != null) {
    if (inputDecorationTheme is InputDecorationTheme) {
      inputDecorationTheme = inputDecorationTheme.data;
    } else if (inputDecorationTheme is! InputDecorationThemeData) {
      throw ArgumentError(
        'inputDecorationTheme must be either a InputDecorationThemeData or a InputDecorationTheme',
      );
    }
  }
  inputDecorationTheme ??= const InputDecorationThemeData();
  platform ??= defaultTargetPlatform;
  switch (platform) {
    case TargetPlatform.android:
    case TargetPlatform.fuchsia:
    case TargetPlatform.iOS:
      materialTapTargetSize ??= MaterialTapTargetSize.padded;
    case TargetPlatform.linux:
    case TargetPlatform.macOS:
    case TargetPlatform.windows:
      materialTapTargetSize ??= MaterialTapTargetSize.shrinkWrap;
  }
  pageTransitionsTheme ??= const PageTransitionsTheme();
  scrollbarTheme ??= const ScrollbarThemeData();
  visualDensity ??= VisualDensity.defaultDensityForPlatform(platform);
  useMaterial3 ??= true;
  useSystemColors ??= false;
  assert(
    contrastLevel == null ||
        (contrastLevel + precisionErrorTolerance >= -1.0 &&
            contrastLevel - precisionErrorTolerance <= 1.0),
    'contrastLevel must be between -1.0 and 1.0 inclusive.',
  );
  contrastLevel ??= ContrastLevel.standard;
  assert(
    colorSchemeSeed != null || _debugIsUsingPredefinedContrastLevel(contrastLevel),
    'colorSchemeSeed must be provided to use a custom contrastLevel. '
    'Without a colorSchemeSeed, contrastLevel must be '
    'ContrastLevel.standard (0.0), ContrastLevel.medium (0.5), or '
    'ContrastLevel.high (1.0).',
  );
  final bool useInkSparkle = platform == TargetPlatform.android && !kIsWeb;
  splashFactory ??= useMaterial3
      ? useInkSparkle
            ? InkSparkle.splashFactory
            : InkRipple.splashFactory
      : InkSplash.splashFactory;

  // COLOR
  assert(
    colorScheme?.brightness == null ||
        brightness == null ||
        colorScheme!.brightness == brightness,
    'ThemeData.brightness does not match ColorScheme.brightness. '
    'Either override ColorScheme.brightness or ThemeData.brightness to '
    'match the other.',
  );
  assert(colorSchemeSeed == null || colorScheme == null);
  assert(colorSchemeSeed == null || primarySwatch == null);
  assert(colorSchemeSeed == null || primaryColor == null);
  final Brightness effectiveBrightness =
      brightness ?? colorScheme?.brightness ?? Brightness.light;
  final isDark = effectiveBrightness == Brightness.dark;
  if (colorSchemeSeed != null || useMaterial3) {
    if (colorSchemeSeed != null) {
      colorScheme = ColorScheme.fromSeed(
        seedColor: colorSchemeSeed,
        brightness: effectiveBrightness,
        contrastLevel: contrastLevel,
      );
    }
    colorScheme ??= _defaultM3ColorScheme(effectiveBrightness, contrastLevel);

    // For surfaces that use primary color in light themes and surface color in dark
    final Color primarySurfaceColor = isDark ? colorScheme.surface : colorScheme.primary;
    final Color onPrimarySurfaceColor = isDark ? colorScheme.onSurface : colorScheme.onPrimary;

    // Default some of the color settings to values from the color scheme
    primaryColor ??= primarySurfaceColor;
    canvasColor ??= colorScheme.surface;
    scaffoldBackgroundColor ??= colorScheme.surface;
    cardColor ??= colorScheme.surface;
    dividerColor ??= colorScheme.outline;
    dialogBackgroundColor ??= colorScheme.surface;
    indicatorColor ??= onPrimarySurfaceColor;
    applyElevationOverlayColor ??= brightness == Brightness.dark;
  }
  applyElevationOverlayColor ??= false;
  primarySwatch ??= Colors.blue;
  primaryColor ??= isDark ? Colors.grey[900]! : primarySwatch;
  final Brightness estimatedPrimaryColorBrightness = estimateBrightnessForColor(primaryColor);
  primaryColorLight ??= isDark ? Colors.grey[500]! : primarySwatch[100]!;
  primaryColorDark ??= isDark ? Colors.black : primarySwatch[700]!;
  final primaryIsDark = estimatedPrimaryColorBrightness == Brightness.dark;
  focusColor ??= isDark ? Colors.white.withOpacity(0.12) : Colors.black.withOpacity(0.12);
  hoverColor ??= isDark ? Colors.white.withOpacity(0.04) : Colors.black.withOpacity(0.04);
  shadowColor ??= Colors.black;
  canvasColor ??= isDark ? Colors.grey[850]! : Colors.grey[50]!;
  scaffoldBackgroundColor ??= canvasColor;
  cardColor ??= isDark ? Colors.grey[800]! : Colors.white;
  dividerColor ??= isDark ? const Color(0x1FFFFFFF) : const Color(0x1F000000);
  // Create a ColorScheme that is backwards compatible as possible
  // with the existing default ThemeData color values.
  colorScheme ??= ColorScheme.fromSwatch(
    primarySwatch: primarySwatch,
    accentColor: isDark ? Colors.tealAccent[200]! : primarySwatch[500]!,
    cardColor: cardColor,
    backgroundColor: isDark ? Colors.grey[700]! : primarySwatch[200]!,
    errorColor: Colors.red[700],
    brightness: effectiveBrightness,
  );
  unselectedWidgetColor ??= isDark ? Colors.white70 : Colors.black54;
  // Spec doesn't specify a dark theme secondaryHeaderColor, this is a guess.
  secondaryHeaderColor ??= isDark ? Colors.grey[700]! : primarySwatch[50]!;
  hintColor ??= isDark ? Colors.white60 : Colors.black.withOpacity(0.6);
  // The default [buttonTheme] is here because it doesn't use the defaults for
  // [disabledColor], [highlightColor], and [splashColor].
  buttonTheme ??= ButtonThemeData(
    colorScheme: colorScheme,
    buttonColor: isDark ? primarySwatch[600]! : Colors.grey[300]!,
    disabledColor: disabledColor,
    focusColor: focusColor,
    hoverColor: hoverColor,
    highlightColor: highlightColor,
    splashColor: splashColor,
    materialTapTargetSize: materialTapTargetSize,
  );
  disabledColor ??= isDark ? Colors.white38 : Colors.black38;
  highlightColor ??= isDark ? const Color(0x40CCCCCC) : const Color(0x66BCBCBC);
  splashColor ??= isDark ? const Color(0x40CCCCCC) : const Color(0x66C8C8C8);

  // TYPOGRAPHY & ICONOGRAPHY
  typography ??= useMaterial3
      ? Typography.material2021(platform: platform, colorScheme: colorScheme)
      : Typography.material2014(platform: platform);
  TextTheme defaultTextTheme = isDark ? typography.white : typography.black;
  TextTheme defaultPrimaryTextTheme = primaryIsDark ? typography.white : typography.black;
  if (fontFamily != null) {
    defaultTextTheme = defaultTextTheme.apply(fontFamily: fontFamily);
    defaultPrimaryTextTheme = defaultPrimaryTextTheme.apply(fontFamily: fontFamily);
  }
  if (fontFamilyFallback != null) {
    defaultTextTheme = defaultTextTheme.apply(fontFamilyFallback: fontFamilyFallback);
    defaultPrimaryTextTheme = defaultPrimaryTextTheme.apply(
      fontFamilyFallback: fontFamilyFallback,
    );
  }
  if (package != null) {
    defaultTextTheme = defaultTextTheme.apply(package: package);
    defaultPrimaryTextTheme = defaultPrimaryTextTheme.apply(package: package);
  }
  textTheme = defaultTextTheme.merge(textTheme);
  primaryTextTheme = defaultPrimaryTextTheme.merge(primaryTextTheme);
  iconTheme ??= isDark
      ? IconThemeData(color: kDefaultIconLightColor)
      : IconThemeData(color: kDefaultIconDarkColor);
  primaryIconTheme ??= primaryIsDark
      ? const IconThemeData(color: Colors.white)
      : const IconThemeData(color: Colors.black);

  // COMPONENT THEMES
  // TODO(huycozy): Clean this up once the type of `appBarTheme` is changed to `appBarThemeData`
  if (appBarTheme != null) {
    if (appBarTheme is AppBarTheme) {
      appBarTheme = appBarTheme.data;
    } else if (appBarTheme is! AppBarThemeData) {
      throw ArgumentError('appBarTheme must be either a AppBarThemeData or a AppBarTheme');
    }
  }
  badgeTheme ??= const BadgeThemeData();
  bannerTheme ??= const MaterialBannerThemeData();
  bottomAppBarTheme ??= const BottomAppBarThemeData();
  bottomNavigationBarTheme ??= const BottomNavigationBarThemeData();
  bottomSheetTheme ??= const BottomSheetThemeData();
  cardTheme ??= const CardThemeData();
  carouselViewTheme ??= const CarouselViewThemeData();
  checkboxTheme ??= const CheckboxThemeData();
  chipTheme ??= const ChipThemeData();
  dataTableTheme ??= const DataTableThemeData();
  datePickerTheme ??= const DatePickerThemeData();
  dialogTheme ??= const DialogThemeData();
  dividerTheme ??= const DividerThemeData();
  drawerTheme ??= const DrawerThemeData();
  dropdownMenuTheme ??= const DropdownMenuThemeData();
  elevatedButtonTheme ??= const ElevatedButtonThemeData();
  expansionTileTheme ??= const ExpansionTileThemeData();
  filledButtonTheme ??= const FilledButtonThemeData();
  floatingActionButtonTheme ??= const FloatingActionButtonThemeData();
  iconButtonTheme ??= const IconButtonThemeData();
  listTileTheme ??= const ListTileThemeData();
  menuBarTheme ??= const MenuBarThemeData();
  menuButtonTheme ??= const MenuButtonThemeData();
  menuTheme ??= const MenuThemeData();
  navigationBarTheme ??= const NavigationBarThemeData();
  navigationDrawerTheme ??= const NavigationDrawerThemeData();
  navigationRailTheme ??= const NavigationRailThemeData();
  outlinedButtonTheme ??= const OutlinedButtonThemeData();
  popupMenuTheme ??= const PopupMenuThemeData();
  progressIndicatorTheme ??= const ProgressIndicatorThemeData();
  radioTheme ??= const RadioThemeData();
  searchBarTheme ??= const SearchBarThemeData();
  searchViewTheme ??= const SearchViewThemeData();
  segmentedButtonTheme ??= const SegmentedButtonThemeData();
  sliderTheme ??= const SliderThemeData();
  snackBarTheme ??= const SnackBarThemeData();
  switchTheme ??= const SwitchThemeData();
  tabBarTheme ??= const TabBarThemeData();
  textButtonTheme ??= const TextButtonThemeData();
  textSelectionTheme ??= const TextSelectionThemeData();
  timePickerTheme ??= const TimePickerThemeData();
  toggleButtonsTheme ??= const ToggleButtonsThemeData();
  tooltipTheme ??= const TooltipThemeData();
  // DEPRECATED (newest deprecations at the bottom)
  buttonBarTheme ??= const ButtonBarThemeData();
  dialogBackgroundColor ??= isDark ? Colors.grey[800]! : Colors.white;
  indicatorColor ??= colorScheme.secondary == primaryColor ? Colors.white : colorScheme.secondary;

  var theme = ThemeData.raw(
    // For the sanity of the reader, make sure these properties are in the same
    // order in every place that they are separated by section comments (e.g.
    // GENERAL CONFIGURATION). Each section except for deprecations should be
    // alphabetical by symbol name.

    // GENERAL CONFIGURATION
    adaptationMap: _createAdaptationMap(adaptations),
    applyElevationOverlayColor: applyElevationOverlayColor,
    cupertinoOverrideTheme: cupertinoOverrideTheme,
    extensions: _themeExtensionIterableToMap(extensions),
    inputDecorationTheme: inputDecorationTheme as InputDecorationThemeData,
    materialTapTargetSize: materialTapTargetSize,
    pageTransitionsTheme: pageTransitionsTheme,
    platform: platform,
    scrollbarTheme: scrollbarTheme,
    splashFactory: splashFactory,
    useMaterial3: useMaterial3,
    visualDensity: visualDensity,
    // COLOR
    canvasColor: canvasColor,
    cardColor: cardColor,
    colorScheme: colorScheme,
    disabledColor: disabledColor,
    dividerColor: dividerColor,
    focusColor: focusColor,
    highlightColor: highlightColor,
    hintColor: hintColor,
    hoverColor: hoverColor,
    primaryColor: primaryColor,
    primaryColorDark: primaryColorDark,
    primaryColorLight: primaryColorLight,
    scaffoldBackgroundColor: scaffoldBackgroundColor,
    secondaryHeaderColor: secondaryHeaderColor,
    shadowColor: shadowColor,
    splashColor: splashColor,
    unselectedWidgetColor: unselectedWidgetColor,
    // TYPOGRAPHY & ICONOGRAPHY
    iconTheme: iconTheme,
    primaryTextTheme: primaryTextTheme,
    textTheme: textTheme,
    typography: typography,
    primaryIconTheme: primaryIconTheme,
    // COMPONENT THEMES
    actionIconTheme: actionIconTheme,
    // TODO(huycozy): Remove this type cast when appBarTheme is explicitly set to appBarThemeData
    appBarTheme: (appBarTheme as AppBarThemeData?) ?? const AppBarThemeData(),
    badgeTheme: badgeTheme,
    bannerTheme: bannerTheme,
    bottomAppBarTheme: bottomAppBarTheme,
    bottomNavigationBarTheme: bottomNavigationBarTheme,
    bottomSheetTheme: bottomSheetTheme,
    buttonTheme: buttonTheme,
    cardTheme: cardTheme,
    carouselViewTheme: carouselViewTheme,
    checkboxTheme: checkboxTheme,
    chipTheme: chipTheme,
    dataTableTheme: dataTableTheme,
    datePickerTheme: datePickerTheme,
    dialogTheme: dialogTheme,
    dividerTheme: dividerTheme,
    drawerTheme: drawerTheme,
    dropdownMenuTheme: dropdownMenuTheme,
    elevatedButtonTheme: elevatedButtonTheme,
    expansionTileTheme: expansionTileTheme,
    filledButtonTheme: filledButtonTheme,
    floatingActionButtonTheme: floatingActionButtonTheme,
    iconButtonTheme: iconButtonTheme,
    listTileTheme: listTileTheme,
    menuBarTheme: menuBarTheme,
    menuButtonTheme: menuButtonTheme,
    menuTheme: menuTheme,
    navigationBarTheme: navigationBarTheme,
    navigationDrawerTheme: navigationDrawerTheme,
    navigationRailTheme: navigationRailTheme,
    outlinedButtonTheme: outlinedButtonTheme,
    popupMenuTheme: popupMenuTheme,
    progressIndicatorTheme: progressIndicatorTheme,
    radioTheme: radioTheme,
    searchBarTheme: searchBarTheme,
    searchViewTheme: searchViewTheme,
    segmentedButtonTheme: segmentedButtonTheme,
    sliderTheme: sliderTheme,
    snackBarTheme: snackBarTheme,
    switchTheme: switchTheme,
    tabBarTheme: tabBarTheme,
    textButtonTheme: textButtonTheme,
    textSelectionTheme: textSelectionTheme,
    timePickerTheme: timePickerTheme,
    toggleButtonsTheme: toggleButtonsTheme,
    tooltipTheme: tooltipTheme,
    // DEPRECATED (newest deprecations at the bottom)
    buttonBarTheme: buttonBarTheme,
    dialogBackgroundColor: dialogBackgroundColor,
    indicatorColor: indicatorColor,
  );

  if (useSystemColors) {
    theme = theme._overrideWithSystemColors();
  }
  return theme;
}