feat: Fixes issue #263: ✨ Support for dark theme

Author: Shubham Jitiya

CHANGELOG.md

@@ -5,6 +5,7 @@
 - Fixes right icon always shows default icon in `CalendarPageHeader` when providing custom icon. [#432](https://github.com/SimformSolutionsPvtLtd/flutter_calendar_view/issues/432)
 - Adds `hideDaysNotInMonth` argument in `cellBuilder` in readme. [#433](https://github.com/SimformSolutionsPvtLtd/flutter_calendar_view/issues/433)
 - Fixes `titleColor` of date for `hideDaysNotInMonth: false`.
+- Adds support for dark theme. [#263](https://github.com/SimformSolutionsPvtLtd/flutter_calendar_view/issues/263)
 
 # [1.3.0 - 12 Nov 2024](https://github.com/SimformSolutionsPvtLtd/flutter_calendar_view/tree/1.3.0)
 

README.md

@@ -354,6 +354,46 @@ WeekView(
 
 Above code will create `WeekView` with only five days, from monday to friday.
 
+## **Customise theme**
+* The default theme includes support for dark mode. 
+* For detailed instructions on how to override the default settings, please refer to [this]() guide.
+
+### Day view
+* Default timeline text color is `colorScheme.onSurface`.
+* Default hour, half hour & quarter color is `colorScheme.surfaceContainerHighest`.
+* Default timeline color `colorScheme.primaryColorLight`.
+
+Default hour indicator settings.
+```dart
+ HourIndicatorSettings(
+          height: widget.heightPerMinute,
+          // Color of horizontal and vertical lines
+          color: Theme.of(context).colorScheme.surfaceContainerHighest,
+          offset: 5,
+        );
+```
+
+### Week view
+* Week-number text color - Default color `onSecondaryContainer`.
+* To customise week number & weekdays use `weekNumberBuilder` & `weekDayBuilder`.
+* Default week tile color is `colorScheme.surfaceContainerHigh`.
+* To give background color use `backgroundColor` Default background color is `colorScheme.surfaceContainerLowest`.
+* To customise timeline use `timeLineBuilder`. Default text color is `colorScheme.onSurface`.
+* To change Hour lines color use `HourIndicatorSettings`.
+* To style hours, half hours & quarter hours use `HourIndicatorSettings`. Default color used is `surfaceContainerHighest`
+
+```dart
+  hourIndicatorSettings: HourIndicatorSettings(
+        color: Colors.greenAccent,
+        lineStyle: LineStyle.dashed,
+      ),
+      showHalfHours: true,
+  halfHourIndicatorSettings: HourIndicatorSettings(
+        color: Colors.redAccent,
+        lineStyle: LineStyle.dashed,
+      ),
+```
+
 ## Main Contributors
 
 <table>

doc/theme_guide.md

@@ -0,0 +1,61 @@
+## **Customise theme**
+The default theme supports dark mode. Refer this colors to override it.
+
+| Name                                          | Parameter              | Default color                       |
+|-----------------------------------------------|------------------------|-------------------------------------|
+| `MonthView` Border color                      | Color? borderColor     | colorScheme.surfaceContainerHigh    |
+| `WeekView` Background color of week view page | Color? backgroundColor | colorScheme.surfaceContainerLowest  |
+| `DayView` Default background color            | Color? backgroundColor | colorScheme.surfaceContainerLow     |
+| `FilledCell` Dates in month cell color        | Color? backgroundColor | colorScheme.surfaceContainerLowest  |
+| `FilledCell` Dates not in month cell color    | Color? backgroundColor | colorScheme.surfaceContainerLow     |
+| `WeekDayTile` Border color                    | Color? borderColor     | colorScheme.secondaryContainer      |
+| `WeekDayTile` Background color                | Color? backgroundColor | colorScheme.surfaceContainerHigh    |
+| `WeekDayTile` Text style color                | NA                     | colorScheme.onSecondaryContainer    |
+
+To customise `MonthView`, `DayView` & `WeekView` page header use `HeaderStyle`.
+
+```dart
+  headerStyle: HeaderStyle(
+        leftIconConfig: IconDataConfig(color: Colors.red),
+        rightIconConfig: IconDataConfig(color: Colors.red),
+        decoration: BoxDecoration(
+          color: Theme.of(context).highlightColor,
+        ),
+      ),
+```
+
+### Day view
+* Default timeline text color is `colorScheme.onSurface`.
+* Default hour, half hour & quarter color is `colorScheme.surfaceContainerHighest`.
+* Default timeline color `colorScheme.primaryColorLight`.
+
+Default hour indicator settings.
+```dart
+ HourIndicatorSettings(
+          height: widget.heightPerMinute,
+          // Color of horizontal and vertical lines
+          color: Theme.of(context).colorScheme.surfaceContainerHighest,
+          offset: 5,
+        );
+```
+
+### Week view
+* Week-number text color - Default color `onSecondaryContainer`.
+* To customise week number & weekdays use `weekNumberBuilder` & `weekDayBuilder`.
+* Default week tile color is `colorScheme.surfaceContainerHigh`.
+* To give background color use `backgroundColor` Default background color is `colorScheme.surfaceContainerLowest`.
+* To customise timeline use `timeLineBuilder`. Default text color is `colorScheme.onSurface`.
+* To change Hour lines color use `HourIndicatorSettings`.
+* To style hours, half hours & quarter hours use `HourIndicatorSettings`. Default color used is `surfaceContainerHighest`
+
+```dart
+  hourIndicatorSettings: HourIndicatorSettings(
+        color: Colors.greenAccent,
+        lineStyle: LineStyle.dashed,
+      ),
+      showHalfHours: true,
+  halfHourIndicatorSettings: HourIndicatorSettings(
+        color: Colors.redAccent,
+        lineStyle: LineStyle.dashed,
+      ),
+```

example/lib/main.dart

@@ -1,6 +1,7 @@
 import 'dart:ui';
 
 import 'package:calendar_view/calendar_view.dart';
+import 'package:example/theme/app_theme.dart';
 import 'package:flutter/material.dart';
 
 import 'pages/home_page.dart';
@@ -11,7 +12,14 @@ void main() {
   runApp(MyApp());
 }
 
-class MyApp extends StatelessWidget {
+class MyApp extends StatefulWidget {
+  @override
+  State<MyApp> createState() => _MyAppState();
+}
+
+class _MyAppState extends State<MyApp> {
+  bool isDarkMode = false;
+
   // This widget is the root of your application.
   @override
   Widget build(BuildContext context) {
@@ -20,15 +28,19 @@ class MyApp extends StatelessWidget {
       child: MaterialApp(
         title: 'Flutter Calendar Page Demo',
         debugShowCheckedModeBanner: false,
-        theme: ThemeData.light(),
+        theme: AppTheme.lightTheme,
+        darkTheme: AppTheme.darkTheme,
+        themeMode: isDarkMode ? ThemeMode.dark : ThemeMode.light,
         scrollBehavior: ScrollBehavior().copyWith(
           dragDevices: {
             PointerDeviceKind.trackpad,
             PointerDeviceKind.mouse,
             PointerDeviceKind.touch,
           },
         ),
-        home: HomePage(),
+        home: HomePage(
+          onChangeTheme: (isDark) => setState(() => isDarkMode = isDark),
+        ),
       ),
     );
   }

example/lib/pages/create_event_page.dart

@@ -1,7 +1,6 @@
 import 'package:calendar_view/calendar_view.dart';
 import 'package:flutter/material.dart';
 
-import '../app_colors.dart';
 import '../extension.dart';
 import '../widgets/add_event_form.dart';
 
@@ -12,22 +11,24 @@ class CreateEventPage extends StatelessWidget {
 
   @override
   Widget build(BuildContext context) {
+    final color = Theme.of(context).colorScheme;
+
     return Scaffold(
       appBar: AppBar(
         elevation: 0,
-        backgroundColor: Theme.of(context).scaffoldBackgroundColor,
+        backgroundColor: color.surfaceContainerHigh,
         centerTitle: false,
         leading: IconButton(
           onPressed: context.pop,
           icon: Icon(
             Icons.arrow_back,
-            color: AppColors.black,
+            color: color.onSurface,
           ),
         ),
         title: Text(
           event == null ? "Create New Event" : "Update Event",
           style: TextStyle(
-            color: AppColors.black,
+            color: color.onSurface,
             fontSize: 20.0,
             fontWeight: FontWeight.bold,
           ),

example/lib/pages/day_view_page.dart

@@ -22,6 +22,11 @@ class _DayViewPageDemoState extends State<DayViewPageDemo> {
         selectedView: CalendarView.day,
       ),
       mobileWidget: Scaffold(
+        primary: false,
+        appBar: AppBar(
+          leading: const SizedBox.shrink(),
+          backgroundColor: Theme.of(context).colorScheme.primaryContainer,
+        ),
         floatingActionButton: FloatingActionButton(
           child: Icon(Icons.add),
           elevation: 8,

example/lib/pages/event_details_page.dart

@@ -90,18 +90,23 @@ class DetailsPage extends StatelessWidget {
             children: [
               Expanded(
                 child: ElevatedButton(
+                  child: Text('Delete Event'),
+                  style: ElevatedButton.styleFrom(
+                    backgroundColor:
+                        Theme.of(context).colorScheme.surfaceContainer,
+                  ),
                   onPressed: () {
                     CalendarControllerProvider.of(context)
                         .controller
                         .remove(event);
                     Navigator.of(context).pop();
                   },
-                  child: Text('Delete Event'),
                 ),
               ),
               SizedBox(width: 30),
               Expanded(
                 child: ElevatedButton(
+                  child: Text('Edit Event'),
                   onPressed: () async {
                     final result = await Navigator.of(context).push(
                       MaterialPageRoute(
@@ -115,7 +120,10 @@ class DetailsPage extends StatelessWidget {
                       Navigator.of(context).pop();
                     }
                   },
-                  child: Text('Edit Event'),
+                  style: ElevatedButton.styleFrom(
+                    backgroundColor:
+                        Theme.of(context).colorScheme.surfaceContainer,
+                  ),
                 ),
               ),
             ],

example/lib/pages/home_page.dart

@@ -5,13 +5,20 @@ import 'mobile/mobile_home_page.dart';
 import 'web/web_home_page.dart';
 
 class HomePage extends StatelessWidget {
-  const HomePage({super.key});
+  const HomePage({
+    this.onChangeTheme,
+    super.key,
+  });
+
+  /// Return true for dark mode
+  /// false for light mode
+  final void Function(bool)? onChangeTheme;
 
   @override
   Widget build(BuildContext context) {
     return ResponsiveWidget(
-      mobileWidget: MobileHomePage(),
-      webWidget: WebHomePage(),
+      mobileWidget: MobileHomePage(onChangeTheme: onChangeTheme),
+      webWidget: WebHomePage(onThemeChange: onChangeTheme),
     );
   }
 }

example/lib/pages/mobile/mobile_home_page.dart

@@ -5,7 +5,21 @@ import '../day_view_page.dart';
 import '../month_view_page.dart';
 import '../week_view_page.dart';
 
-class MobileHomePage extends StatelessWidget {
+class MobileHomePage extends StatefulWidget {
+  MobileHomePage({
+    this.onChangeTheme,
+    super.key,
+  });
+
+  final void Function(bool)? onChangeTheme;
+
+  @override
+  State<MobileHomePage> createState() => _MobileHomePageState();
+}
+
+class _MobileHomePageState extends State<MobileHomePage> {
+  bool isDarkMode = false;
+
   @override
   Widget build(BuildContext context) {
     return Scaffold(
@@ -38,6 +52,15 @@ class MobileHomePage extends StatelessWidget {
           ],
         ),
       ),
+      floatingActionButton: FloatingActionButton(
+          child: Icon(Icons.dark_mode),
+          onPressed: () {
+            isDarkMode = !isDarkMode;
+            if (widget.onChangeTheme != null) {
+              widget.onChangeTheme!(isDarkMode);
+            }
+            setState(() {});
+          }),
     );
   }
 }

example/lib/pages/month_view_page.dart

@@ -24,6 +24,11 @@ class _MonthViewPageDemoState extends State<MonthViewPageDemo> {
         selectedView: CalendarView.month,
       ),
       mobileWidget: Scaffold(
+        primary: false,
+        appBar: AppBar(
+          leading: const SizedBox.shrink(),
+          backgroundColor: Theme.of(context).colorScheme.primaryContainer,
+        ),
         floatingActionButton: FloatingActionButton(
           child: Icon(Icons.add),
           elevation: 8,