Merge pull request #449 from SimformSolutionsPvtLtd/feature/change_tile_tap

feat: Fixes issue #390: ✨ Add tap details callback in month view

Author: PRBaraiya

CHANGELOG.md

@@ -1,6 +1,7 @@
 # [1.4.1 - Unreleased]
 
 - Adds clear method to `EventController`.
+- Adds `onEventTapDetails`, `onEventDoubleTapDetails` & `onEventLongTapDetails` gesture recognizers to get tap details. [#390](https://github.com/SimformSolutionsPvtLtd/flutter_calendar_view/issues/390)
 
 # [1.4.0 - 7 Jan 2025](https://github.com/SimformSolutionsPvtLtd/flutter_calendar_view/tree/1.4.0)
 

README.md

@@ -153,9 +153,14 @@ MonthView(
     },
     startDay: WeekDays.sunday, // To change the first day of the week.
     // This callback will only work if cellBuilder is null.
-    onEventTap: (event, date) => print(event),
-    onEventDoubleTap: (events, date) => print(events),
-    onEventLongTap: (event, date) => print(event),
+    onEventTap: (event, data) => print('on tap'),
+    onEventTapDetails: (event, data, details) => print('on tap details'),
+    onEventDoubleTap: (event, data) => print('on double tap'),
+    onEventDoubleTapDetails: (event, data, details) =>
+      print('on double details'),
+    onEventLongTap: (event, data) => print('on long tap'),
+    onEventLongTapDetails: (event, data, details) =>
+      print('on long tap details'),
     onDateLongPress: (date) => print(date),
     headerBuilder: MonthHeader.hidden, // To hide month header
     showWeekTileBorder: false, // To show or hide header border

lib/src/components/month_view_components.dart

@@ -80,6 +80,7 @@ class FilledCell<T extends Object?> extends StatelessWidget {
   /// Color for event tile.
   final Color tileColor;
 
+  // TODO(Shubham): Move all callbacks to separate class
   /// Called when user taps on any event tile.
   final TileTapCallback<T>? onTileTap;
 
@@ -89,6 +90,15 @@ class FilledCell<T extends Object?> extends StatelessWidget {
   /// Called when user double tap on any event tile.
   final TileTapCallback<T>? onTileDoubleTap;
 
+  /// Similar to [onTileTap] with additional tap details callback.
+  final TileTapDetailsCallback<T>? onTileTapDetails;
+
+  /// Similar to [onTileDoubleTap] with additional tap details callback.
+  final TileDoubleTapDetailsCallback<T>? onTileDoubleTapDetails;
+
+  /// Similar to [onTileLongTap] with additional tap details callback.
+  final TileLongTapDetailsCallback<T>? onTileLongTapDetails;
+
   /// defines that [date] is in current month or not.
   final bool isInMonth;
 
@@ -117,6 +127,9 @@ class FilledCell<T extends Object?> extends StatelessWidget {
     this.highlightColor = Colors.blue,
     this.onTileTap,
     this.onTileLongTap,
+    this.onTileTapDetails,
+    this.onTileDoubleTapDetails,
+    this.onTileLongTapDetails,
     this.tileColor = Colors.blue,
     this.highlightRadius = 11,
     this.titleColor = Constants.black,
@@ -165,6 +178,23 @@ class FilledCell<T extends Object?> extends StatelessWidget {
                             onTileLongTap?.call(events[index], date),
                         onDoubleTap: () =>
                             onTileDoubleTap?.call(events[index], date),
+                        onTapUp: (details) => onTileTapDetails?.call(
+                          events[index],
+                          date,
+                          details,
+                        ),
+                        onLongPressStart: (details) =>
+                            onTileLongTapDetails?.call(
+                          events[index],
+                          date,
+                          details,
+                        ),
+                        onDoubleTapDown: (details) =>
+                            onTileDoubleTapDetails?.call(
+                          events[index],
+                          date,
+                          details,
+                        ),
                         child: Container(
                           decoration: BoxDecoration(
                             color: events[index].color,

lib/src/month_view/month_view.dart

@@ -53,9 +53,30 @@ class MonthView<T extends Object?> extends StatefulWidget {
   /// This function will only work if [cellBuilder] is null.
   final TileTapCallback<T>? onEventLongTap;
 
-  /// This method will be called when user double taps on event tile.
+  /// This function will be called when user will double tap on a single event
+  /// tile inside a cell.
+  ///
+  /// This function will only work if [cellBuilder] is null.
   final TileTapCallback<T>? onEventDoubleTap;
 
+  /// This function will be called when user will tap on a single event
+  /// tile inside a cell and gives additional details offset.
+  ///
+  /// This function will only work if [cellBuilder] is null.
+  final TileTapDetailsCallback<T>? onEventTapDetails;
+
+  /// This function will be called when user will long press on a single event
+  /// tile inside a cell and gives additional details offset.
+  ///
+  /// This function will only work if [cellBuilder] is null.
+  final TileLongTapDetailsCallback<T>? onEventLongTapDetails;
+
+  /// This function will be called when user will double tap on a single event
+  /// tile inside a cell and gives additional details offset.
+  ///
+  /// This function will only work if [cellBuilder] is null.
+  final TileDoubleTapDetailsCallback<T>? onEventDoubleTapDetails;
+
   /// Show weekends or not.
   /// Default value is true.
   final bool showWeekends;
@@ -192,7 +213,10 @@ class MonthView<T extends Object?> extends StatefulWidget {
     this.onPageChange,
     this.onCellTap,
     this.onEventTap,
+    this.onEventTapDetails,
     this.onEventLongTap,
+    this.onEventLongTapDetails,
+    this.onEventDoubleTapDetails,
     this.onDateLongPress,
     this.startDay = WeekDays.monday,
     this.headerStringBuilder,
@@ -574,6 +598,9 @@ class MonthViewState<T extends Object?> extends State<MonthView<T>> {
         onTileTap: widget.onEventTap,
         onTileDoubleTap: widget.onEventDoubleTap,
         onTileLongTap: widget.onEventLongTap,
+        onTileTapDetails: widget.onEventTapDetails,
+        onTileDoubleTapDetails: widget.onEventDoubleTapDetails,
+        onTileLongTapDetails: widget.onEventLongTapDetails,
         dateStringBuilder: widget.dateStringBuilder,
         hideDaysNotInMonth: hideDaysNotInMonth,
       );
@@ -585,6 +612,9 @@ class MonthViewState<T extends Object?> extends State<MonthView<T>> {
       events: events,
       onTileTap: widget.onEventTap,
       onTileLongTap: widget.onEventLongTap,
+      onTileTapDetails: widget.onEventTapDetails,
+      onTileDoubleTapDetails: widget.onEventDoubleTapDetails,
+      onTileLongTapDetails: widget.onEventLongTapDetails,
       dateStringBuilder: widget.dateStringBuilder,
       onTileDoubleTap: widget.onEventDoubleTap,
       hideDaysNotInMonth: hideDaysNotInMonth,

lib/src/typedefs.dart

@@ -63,6 +63,24 @@ typedef WeekPageHeaderBuilder = Widget Function(
 typedef TileTapCallback<T extends Object?> = void Function(
     CalendarEventData<T> event, DateTime date);
 
+typedef TileTapDetailsCallback<T extends Object?> = void Function(
+  CalendarEventData<T> event,
+  DateTime date,
+  TapUpDetails? tapDetails,
+);
+
+typedef TileLongTapDetailsCallback<T extends Object?> = void Function(
+  CalendarEventData<T> event,
+  DateTime date,
+  LongPressStartDetails? longPressDetails,
+);
+
+typedef TileDoubleTapDetailsCallback<T extends Object?> = void Function(
+  CalendarEventData<T> event,
+  DateTime date,
+  TapDownDetails? doubleTapDetails,
+);
+
 typedef CellTapCallback<T extends Object?> = void Function(
     List<CalendarEventData<T>> events, DateTime date);