[Flutter] DatePicker の土曜日を青、日曜日を赤に色変更する方法

showDatePicker で日付選択カレンダーを表示すると黒文字だけですが、土曜日を青、日曜日を赤のテキストにしたいですよね?

最近ようやくその機能が実装されたのでご紹介いたします。

バージョンについて

Flutter 3.47 以降から、material が material_ui という独立したパッケージとして利用できるようになりました。

今回必要になるカレンダーのカスタマイズ機能を使う場合は、material_ui 1.9.0以降を使う必要があります。

本日時点で最新の Flutter 3.50.0、material_ui 1.11.0 で実装しました。

showDatePickerの新しい引数

material_ui の showDatePicker には、表示をカスタマイズすることができるように次の引数が追加されています。

  • CalendarDatePickerDayBuilder? dayBuilder
  • CalendarDatePickerWeekdayBuilder? weekdayBuilder

これを使って、土曜日、日曜日に色を付けていきます。

実装例

例として、DatePickerUtil クラスを作ります。

showDatePicker としていた部分を、 DatePickerUtil.showCustomDatePicker と書き換えるだけですむようにしてみます。

次のように実装できます。

import 'package:material_ui/material_ui.dart';

/// 土曜を青、日曜を赤で表示する共通の日付ピッカー。
class DatePickerUtil {
  /// 土日に色が付いた日付ピッカーを表示する
  static Future<DateTime?> showCustomDatePicker({
    required BuildContext context,
    required DateTime initialDate,
    required DateTime firstDate,
    required DateTime lastDate,
  }) {
    return showDatePicker(
      context: context,
      initialDate: initialDate,
      firstDate: firstDate,
      lastDate: lastDate,
      dayBuilder: _buildDay,
      weekdayBuilder: _buildWeekday,
    );
  }

  static Widget _buildDay(BuildContext context, CalendarDatePickerDayDetails details) {
    // 選択されている時は背景に色が付くので、土日でも文字の色変更しない
    if (details.states.contains(WidgetState.selected)) {
      return details.child;
    }

    return _applyWeekdayColor(details.day.weekday, details.child);
  }

  static Widget _buildWeekday(
    BuildContext context,
    CalendarDatePickerWeekdayDetails details,
  ) {
    return _applyWeekdayColor(details.weekday, details.child);
  }

  /// 曜日に合わせた文字色に変更する
  static Widget _applyWeekdayColor(int weekday, Widget child) {
    final color = switch (weekday) {
      DateTime.saturday => Colors.blue,
      DateTime.sunday => Colors.red,
      _ => null,
    };

    if (color == null) {
      return child;
    }

    return DefaultTextStyle.merge(
      style: TextStyle(color: color),
      child: child,
    );
  }
}

実行例

元々の showDatePicker() では次のように表示されました。

そして、DatePickerUtil.showCustomDatePicker() では次のようになりました。

土日に色がついて、選びやすくなりましたね!

裏話

実は、この日付と曜日の色をカスタマイズする機能は、弊社がFlutterにプルリクエストを出して実装された機能です!

カレンダーの日付を装飾したいという issue は 6年前に立てられていました。→ https://github.com/flutter/flutter/issues/68106

しかし、ずっと放置されてきたのです。

(何で誰も困っていないんだ。。。)と思って調べたら、ヨーロッパ圏やアメリカ圏では、カレンダーの色を変える文化が無いそうです。

皆さんもぜひ、showDatePicker のカレンダーをカスタマイズしてみてください。

土曜日、日曜日に色を付けたいのは、日本とか一部地域だけらしいです!!

その結果、カレンダーの色に課題に感じている人が少なく放置され続けていました。しかし、日本人向けのアプリを作っている弊社は、土曜日を青、日曜日を赤にしたかったので、今回Flutterにプルリクエストを出しました。