✨ Provide more configurations for page headers.

SimformSolutionsPvtLtd · Sep 18, 2024 · e730cba · e730cba
1 parent 22b8282
commit e730cba
Show file tree

Hide file tree

Showing 16 changed files with 540 additions and 254 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,15 @@
 - Use `hourLinePainter` in `DayView` [#386](https://github.com/SimformSolutionsPvtLtd/flutter_calendar_view/issues/386)
 - Refactor `SideEventArranger` to arrange events properly. [#290](https://github.com/SimformSolutionsPvtLtd/flutter_calendar_view/issues/290)
 - Adds generic type in `_InternalWeekViewPageState`. [#380](https://github.com/SimformSolutionsPvtLtd/flutter_calendar_view/issues/380)
+- Adds additional configurations for `HeaderStyle`.
+    - Added `mainAxisSize`, `mainAxisAlignment`, `rightIconConfig` and `leftIconConfig`.
+- Adds additional configurations for `CalendarPageHeader`, `MonthPageHeader`, `DayPageHeader` and `WeekPageHeader`.
+    - Added `titleBuilder` to build custom title for header.
+- `Deprecations`:
+    - deprecated `backgroundColor` and `iconColor` from `CalendarPageHeader`, `DayPageHeader`, `MonthPageHeader` and `WeekPageHeader`.
+        - **Solution:** use `headerStyle` instead.
+    - deprecated `leftIconVisible`, `rightIconVisible`, `leftIconPadding`, `rightIconPadding`, `leftIcon` and `rightIcon` from `HeaderStyle`.
+        - **Solution:** use `rightIconConfig` and `leftIconConfig` instead.
 
 # [1.2.0 - 10 May 2024](https://github.com/SimformSolutionsPvtLtd/flutter_calendar_view/tree/1.2.0)
 

diff --git a/docs/migration_guide.md b/docs/migration_guide.md
@@ -0,0 +1,74 @@
+# Migration Guide
+
+## Migrate from `1.x.x` to latest
+
+1. Migrate `HeaderStyle`.
+   ```dart
+    // Old
+    final style = HeaderStyle(
+      headerTextStyle : TextStyle(),
+      headerMargin : EdgeInsets.zero,
+      headerPadding : EdgeInsets.zero,
+      titleAlign : TextAlign.center,
+      decoration : BoxDecoration(),
+      mainAxisAlignment : MainAxisAlignment.spaceBetween,
+      leftIcon : Icon(Icons.left),
+      rightIcon : Icon(Icons.right),
+      leftIconVisible : true,
+      rightIconVisible : true,
+      leftIconPadding : EdgeInsets.zero,
+      rightIconPadding : EdgeInsets.zero,
+    );
+   ```
+   ```dart 
+   // After Migration
+   
+   // NOTE: leftIconVisible and rightIconVisible is removed in
+   // latest version. set leftIconConfig and rightIconConfig null to
+   // hide the respective icon.
+   final style = HeaderStyle(
+      headerTextStyle : TextStyle(),
+      headerMargin : EdgeInsets.zero,
+      headerPadding : EdgeInsets.zero,
+      titleAlign : TextAlign.center,
+      decoration : BoxDecoration(),
+      mainAxisAlignment : MainAxisAlignment.spaceBetween,
+      
+      // Set this null to hide the left icon.
+      leftIconConfig : IconDataConfig(
+        padding: EdgeInsets.zero,
+        icon: Icon(Icons.left),
+      ),
+   
+      // Set this null to hide the right icon.
+      rightIconConfig :  IconDataConfig(
+        padding: EdgeInsets.zero,
+        icon: Icon(Icons.right),
+      ),
+    );
+   ```
+2. Migrate `CalendarPageHeader` | `DayPageHeader` | `MonthPageHeader` | `WeekPageHeader`:
+   ```dart
+      // Old
+      final header = MonthPageBuilder({
+        date = DateTime.now(),
+        dateStringBuilder = (date, {secondaryDate}) => '$date',
+        backgroundColor = Constants.headerBackground,
+        iconColor = Constants.black,
+      });
+   ```
+   ```dart
+      // After Migration
+      final header = MonthPageBuilder({
+        date = DateTime.now(),
+        dateStringBuilder = (date, {secondaryDate}) => '$date',
+        headerStyle = HeaderStyle.withSameIcons(
+          decoration: BoxDecoration(
+            color: Constants.headerBackground,
+          ),       
+          iconConfig: IconDataConfig(
+            color: Constants.black,
+          ),
+        ),
+      });
+   ```
diff --git a/lib/calendar_view.dart b/lib/calendar_view.dart
@@ -8,7 +8,6 @@ export './src/calendar_constants.dart';
 export './src/calendar_controller_provider.dart';
 export './src/calendar_event_data.dart';
 export './src/components/components.dart';
-export './src/components/safe_area_wrapper.dart';
 export './src/day_view/day_view.dart';
 export './src/enumerations.dart';
 export './src/event_arrangers/event_arrangers.dart';

diff --git a/lib/src/components/common_components.dart b/lib/src/components/common_components.dart
@@ -2,126 +2,15 @@
 // Use of this source code is governed by a MIT-style license
 // that can be found in the LICENSE file.
 
-import 'package:flutter/foundation.dart';
 import 'package:flutter/material.dart';
 
 import '../calendar_event_data.dart';
 import '../constants.dart';
+import '../enumerations.dart';
 import '../extensions.dart';
-import '../style/header_style.dart';
 import '../typedefs.dart';
-import '../enumerations.dart';
 import 'components.dart';
 
-class CalendarPageHeader extends StatelessWidget {
-  /// When user taps on right arrow.
-  final VoidCallback? onNextDay;
-
-  /// When user taps on left arrow.
-  final VoidCallback? onPreviousDay;
-
-  /// When user taps on title.
-  final AsyncCallback? onTitleTapped;
-
-  /// Date of month/day.
-  final DateTime date;
-
-  /// Secondary date. This date will be used when we need to define a
-  /// range of dates.
-  /// [date] can be starting date and [secondaryDate] can be end date.
-  final DateTime? secondaryDate;
-
-  /// Provides string to display as title.
-  final StringProvider dateStringBuilder;
-
-  // TODO: Need to remove after next release
-  /// background color of header.
-  @Deprecated("Use Header Style to provide background")
-  final Color backgroundColor;
-
-  // TODO: Need to remove after next release
-  /// Color of icons at both sides of header.
-  @Deprecated("Use Header Style to provide icon color")
-  final Color iconColor;
-
-  /// Style for Calendar's header
-  final HeaderStyle headerStyle;
-
-  /// Common header for month and day view In this header user can define format
-  /// in which date will be displayed by providing [dateStringBuilder] function.
-  const CalendarPageHeader({
-    Key? key,
-    required this.date,
-    required this.dateStringBuilder,
-    this.onNextDay,
-    this.onTitleTapped,
-    this.onPreviousDay,
-    this.secondaryDate,
-    @Deprecated("Use Header Style to provide background")
-    this.backgroundColor = Constants.headerBackground,
-    @Deprecated("Use Header Style to provide icon color")
-    this.iconColor = Constants.black,
-    this.headerStyle = const HeaderStyle(),
-  }) : super(key: key);
-
-  @override
-  Widget build(BuildContext context) {
-    return Container(
-      margin: headerStyle.headerMargin,
-      padding: headerStyle.headerPadding,
-      decoration:
-          // ignore_for_file: deprecated_member_use_from_same_package
-          headerStyle.decoration ?? BoxDecoration(color: backgroundColor),
-      clipBehavior: Clip.antiAlias,
-      child: Row(
-        mainAxisAlignment: MainAxisAlignment.spaceBetween,
-        children: [
-          if (headerStyle.leftIconVisible)
-            IconButton(
-              onPressed: onPreviousDay,
-              splashColor: Colors.transparent,
-              focusColor: Colors.transparent,
-              hoverColor: Colors.transparent,
-              highlightColor: Colors.transparent,
-              padding: headerStyle.leftIconPadding,
-              icon: headerStyle.leftIcon ??
-                  Icon(
-                    Icons.chevron_left,
-                    size: 30,
-                    color: iconColor,
-                  ),
-            ),
-          Expanded(
-            child: InkWell(
-              onTap: onTitleTapped,
-              child: Text(
-                dateStringBuilder(date, secondaryDate: secondaryDate),
-                textAlign: headerStyle.titleAlign,
-                style: headerStyle.headerTextStyle,
-              ),
-            ),
-          ),
-          if (headerStyle.rightIconVisible)
-            IconButton(
-              onPressed: onNextDay,
-              splashColor: Colors.transparent,
-              focusColor: Colors.transparent,
-              hoverColor: Colors.transparent,
-              highlightColor: Colors.transparent,
-              padding: headerStyle.rightIconPadding,
-              icon: headerStyle.rightIcon ??
-                  Icon(
-                    Icons.chevron_right,
-                    size: 30,
-                    color: iconColor,
-                  ),
-            ),
-        ],
-      ),
-    );
-  }
-}
-
 /// This will be used in day and week view
 class DefaultPressDetector extends StatelessWidget {
   /// default press detector builder used in week and day view

diff --git a/lib/src/components/components.dart b/lib/src/components/components.dart
@@ -2,6 +2,13 @@
 // Use of this source code is governed by a MIT-style license
 // that can be found in the LICENSE file.
 
+export 'common_components.dart';
 export 'day_view_components.dart';
+export 'event_scroll_notifier.dart';
+export 'headers/calendar_page_header.dart';
+export 'headers/day_page_header.dart';
+export 'headers/month_page_header.dart';
+export 'headers/week_page_header.dart';
 export 'month_view_components.dart';
+export 'safe_area_wrapper.dart';
 export 'week_view_components.dart';
diff --git a/lib/src/components/day_view_components.dart b/lib/src/components/day_view_components.dart
@@ -2,15 +2,11 @@
 // Use of this source code is governed by a MIT-style license
 // that can be found in the LICENSE file.
 
-import 'package:flutter/foundation.dart';
 import 'package:flutter/material.dart';
 
 import '../calendar_event_data.dart';
-import '../constants.dart';
 import '../extensions.dart';
-import '../style/header_style.dart';
 import '../typedefs.dart';
-import 'common_components.dart';
 
 /// This class defines default tile to display in day view.
 class RoundedEventTile extends StatelessWidget {
@@ -114,37 +110,6 @@ class RoundedEventTile extends StatelessWidget {
   }
 }
 
-/// A header widget to display on day view.
-class DayPageHeader extends CalendarPageHeader {
-  /// A header widget to display on day view.
-  const DayPageHeader({
-    Key? key,
-    VoidCallback? onNextDay,
-    AsyncCallback? onTitleTapped,
-    VoidCallback? onPreviousDay,
-    Color iconColor = Constants.black,
-    Color backgroundColor = Constants.headerBackground,
-    StringProvider? dateStringBuilder,
-    required DateTime date,
-    HeaderStyle headerStyle = const HeaderStyle(),
-  }) : super(
-          key: key,
-          date: date,
-          // ignore_for_file: deprecated_member_use_from_same_package
-          backgroundColor: backgroundColor,
-          iconColor: iconColor,
-          onNextDay: onNextDay,
-          onPreviousDay: onPreviousDay,
-          onTitleTapped: onTitleTapped,
-          dateStringBuilder:
-              dateStringBuilder ?? DayPageHeader._dayStringBuilder,
-          headerStyle: headerStyle,
-        );
-
-  static String _dayStringBuilder(DateTime date, {DateTime? secondaryDate}) =>
-      "${date.day} - ${date.month} - ${date.year}";
-}
-
 class DefaultTimeLineMark extends StatelessWidget {
   /// Defines time to display
   final DateTime date;