Skip to content

Commit b8dcf76

Browse files
Merge pull request #1294 from syncfusion-content/FLUT-964937-calendar-UG-hotfix
FLUT-964937 - [Others] Included a Calendar UG improvement changes in hotfix branch
2 parents 26c7582 + c0996cf commit b8dcf76

19 files changed

+171
-169
lines changed

Flutter/DateRangePicker/headers.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -52,12 +52,12 @@ You can customize the header style of the [SfDateRangePicker](https://pub.dev/do
5252
fontStyle: FontStyle.normal,
5353
fontSize: 25,
5454
letterSpacing: 5,
55-
color: Color(0xFFff5eaea),
55+
color: Color(0xFFffeaea),
5656
),
57-
),
5857
),
59-
);
60-
}
58+
),
59+
);
60+
}
6161

6262
{% endhighlight %}
6363
{% endtabs %}

Flutter/calendar/accessibility.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ documentation: ug
1111

1212
## Screen reader support
1313

14-
The `SfCalendar` can easily be accessed by screen readers. Please find the following table to get spoken feedback about the inner element contents of the screen.
14+
The [SfCalendar](https://pub.dev/documentation/syncfusion_flutter_calendar/latest/calendar/SfCalendar-class.html). can easily be accessed by screen readers. Please find the following table to get spoken feedback about the inner element contents of the screen.
1515

1616
### Month view
1717

@@ -54,7 +54,7 @@ The `SfCalendar` can easily be accessed by screen readers. Please find the follo
5454

5555
## Sufficient contrast
5656

57-
The `SfCalendar` [theming](https://help.syncfusion.com/flutter/themes) support offers a consistent and standardized look, as well as the ability to set the colors for all UI elements.
57+
The [SfCalendar](https://pub.dev/documentation/syncfusion_flutter_calendar/latest/calendar/SfCalendar-class.html). [theming](https://help.syncfusion.com/flutter/themes) support offers a consistent and standardized look, as well as the ability to set the colors for all UI elements.
5858

5959
The following APIs allow you to customize the colors of the following elements.
6060
* [todayHighlightColor](https://help.syncfusion.com/flutter/calendar/getting-started#today-highlight-color)
@@ -70,7 +70,7 @@ The following APIs allow you to customize the colors of the following elements.
7070

7171
## Large fonts
7272

73-
The `SfCalendar` font size can be adjusted automatically based on device settings and the font size scaled based on the `MediaQueryData.textScaleFactor`. And also it allows to change the font size of all UI elements in the calendar.
73+
The [SfCalendar](https://pub.dev/documentation/syncfusion_flutter_calendar/latest/calendar/SfCalendar-class.html). font size can be adjusted automatically based on device settings and the font size scaled based on the `MediaQueryData.textScaleFactor`. And also it allows to change the font size of all UI elements in the calendar.
7474
* [appointmentTextStyle](https://help.syncfusion.com/flutter/calendar/appointments#appearance-customization)
7575
* [timeTextStyle](https://help.syncfusion.com/flutter/calendar/timeslot-views#time-text-appearance)
7676
* [dateTextStyle](https://help.syncfusion.com/flutter/calendar/schedule-view#day-header-customization)
@@ -79,7 +79,7 @@ The `SfCalendar` font size can be adjusted automatically based on device setting
7979

8080
## Keyboard navigation
8181

82-
The following keyboard interactions are supported by the `SfCalendar`.
82+
The following keyboard interactions are supported by the [SfCalendar](https://pub.dev/documentation/syncfusion_flutter_calendar/latest/calendar/SfCalendar-class.html).
8383

8484

8585
| Key | Description |

Flutter/calendar/appointment-resizing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ Widget build(BuildContext context) {
4242

4343
## onAppointmentResizeStart
4444

45-
[onAppointmentResizeStart](https://pub.dev/documentation/syncfusion_flutter_calendar/latest/calendar/SfCalendar/onAppointmentResizeStart.html) callback is called whenever the appointment starts to resizing in SfCalendar. The [AppointmentResizeStartDetails]() arguments contains the resizing appointment, and resource details.
45+
[onAppointmentResizeStart](https://pub.dev/documentation/syncfusion_flutter_calendar/latest/calendar/SfCalendar/onAppointmentResizeStart.html) callback is called whenever the appointment starts to resizing in SfCalendar. The [AppointmentResizeStartDetails](https://pub.dev/documentation/syncfusion_flutter_calendar/latest/calendar/AppointmentResizeStartDetails-class.html) arguments contains the resizing appointment, and resource details.
4646

4747
* [appointment](https://pub.dev/documentation/syncfusion_flutter_calendar/latest/calendar/AppointmentResizeStartDetails/appointment.html) - Get the resizing appointment details.
4848
* [resource](https://pub.dev/documentation/syncfusion_flutter_calendar/latest/calendar/AppointmentResizeStartDetails/resource.html) - Get the resource details.

Flutter/calendar/appointments.md

Lines changed: 28 additions & 29 deletions
Large diffs are not rendered by default.

Flutter/calendar/builders.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,10 @@ The [MonthCellBuilder](https://pub.dev/documentation/syncfusion_flutter_calendar
1919

2020
[MonthCellDetails](https://pub.dev/documentation/syncfusion_flutter_calendar/latest/calendar/MonthCellDetails-class.html) - returns the details of the month cell.
2121

22-
* `date` - returns the month cell date.
23-
* `appointments` - returns the month cell appointments.
24-
* `visibleDates` - returns the current view visible dates.
25-
* `bounds` - returns the month cell bounds.
22+
* [date](https://pub.dev/documentation/syncfusion_flutter_calendar/latest/calendar/MonthCellDetails/date.html) - returns the month cell date.
23+
* [appointments](https://pub.dev/documentation/syncfusion_flutter_calendar/latest/calendar/MonthCellDetails/appointments.html) - returns the month cell appointments.
24+
* [visibleDates](https://pub.dev/documentation/syncfusion_flutter_calendar/latest/calendar/MonthCellDetails/visibleDates.html) - returns the current view visible dates.
25+
* [bounds](https://pub.dev/documentation/syncfusion_flutter_calendar/latest/calendar/MonthCellDetails/bounds.html) - returns the month cell bounds.
2626

2727

2828
{% tabs %}
@@ -69,12 +69,12 @@ Widget build(BuildContext context) {
6969

7070
## Schedule view month header builder
7171

72-
You can design your custom view and assign this view to the month header of a schedule view in the calendar by returning an appropriate widget using the [scheduleViewMonthHeaderBuilder](https://pub.dev/documentation/syncfusion_flutter_calendar/latest/calendar/SfCalendar/scheduleViewMonthHeaderBuilder.html) in the `SfCalendar`.
72+
You can design your custom view and assign this view to the month header of a schedule view in the calendar by returning an appropriate widget using the [scheduleViewMonthHeaderBuilder](https://pub.dev/documentation/syncfusion_flutter_calendar/latest/calendar/SfCalendar/scheduleViewMonthHeaderBuilder.html) in the [SfCalendar](https://pub.dev/documentation/syncfusion_flutter_calendar/latest/calendar/SfCalendar-class.html).
7373

7474
[ScheduleViewMonthHeaderDetails](https://pub.dev/documentation/syncfusion_flutter_calendar/latest/calendar/ScheduleViewMonthHeaderDetails-class.html) - returns the required details of the schedule view month header.
7575

76-
* `date` - returns the header date.
77-
* `bounds` - returns the header bounds.
76+
* [date](https://pub.dev/documentation/syncfusion_flutter_calendar/latest/calendar/ScheduleViewMonthHeaderDetails/date.html) - returns the header date.
77+
* [bounds](https://pub.dev/documentation/syncfusion_flutter_calendar/latest/calendar/ScheduleViewMonthHeaderDetails/bounds.html) - returns the header bounds.
7878

7979
{% tabs %}
8080
{% highlight dart hl_lines="8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30" %}
@@ -120,15 +120,15 @@ Widget build(BuildContext context) {
120120
![Schedule view header builder](images/builder/schedule_view_month_header_builder.png)
121121

122122
## Appointment builder
123-
The [CalendarAppointmentBuilder](https://pub.dev/documentation/syncfusion_flutter_calendar/latest/calendar/CalendarAppointmentBuilder.html) allows you to design your custom view and assign the view to the appointment UI of the calendar by returning an appropriate widget in the [appointmentBuilder](https://pub.dev/documentation/syncfusion_flutter_calendar/latest/calendar/SfCalendar/appointmentBuilder.html) of `SfCalendar`.
123+
The [CalendarAppointmentBuilder](https://pub.dev/documentation/syncfusion_flutter_calendar/latest/calendar/CalendarAppointmentBuilder.html) allows you to design your custom view and assign the view to the appointment UI of the calendar by returning an appropriate widget in the [appointmentBuilder](https://pub.dev/documentation/syncfusion_flutter_calendar/latest/calendar/SfCalendar/appointmentBuilder.html) of [SfCalendar](https://pub.dev/documentation/syncfusion_flutter_calendar/latest/calendar/SfCalendar-class.html).
124124

125125
[CalendarAppointmentDetails](https://pub.dev/documentation/syncfusion_flutter_calendar/latest/calendar/CalendarAppointmentDetails-class.html): Returns the details of the appointment view.
126126

127127

128-
* `date`: The date associate with the appointment view.
129-
* `appointments`: List of appointments associated with the appointment view.
130-
*`bound`: Returns the appointment view bounds.
131-
* `isMoreAppointmentRegion`: Determines whether the widget replaces the more appointment region.
128+
* [date](https://pub.dev/documentation/syncfusion_flutter_calendar/latest/calendar/CalendarAppointmentDetails/date.html): The date associate with the appointment view.
129+
* [appointments](https://pub.dev/documentation/syncfusion_flutter_calendar/latest/calendar/CalendarAppointmentDetails/appointments.html): List of appointments associated with the appointment view.
130+
* [bounds](https://pub.dev/documentation/syncfusion_flutter_calendar/latest/calendar/CalendarAppointmentDetails/bounds.html): Returns the appointment view bounds.
131+
* [isMoreAppointmentRegion](https://pub.dev/documentation/syncfusion_flutter_calendar/latest/calendar/CalendarAppointmentDetails/isMoreAppointmentRegion.html): Determines whether the widget replaces the more appointment region.
132132

133133
{% tabs %}
134134
{% highlight dart hl_lines="11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106" %}
@@ -258,9 +258,9 @@ The [TimeRegionBuilder](https://pub.dev/documentation/syncfusion_flutter_calenda
258258

259259
[TimeRegionDetails](https://pub.dev/documentation/syncfusion_flutter_calendar/latest/calendar/TimeRegionDetails-class.html): Returns the details of the time region view.
260260

261-
* `date`: The date associate with the time region view.
262-
* `bound`: Returns the time region view bounds.
263-
* `region`: The Region detail associated with the time region view.
261+
* [date](https://pub.dev/documentation/syncfusion_flutter_calendar/latest/calendar/TimeRegionDetails/date.html): The date associate with the time region view.
262+
* [bounds](https://pub.dev/documentation/syncfusion_flutter_calendar/latest/calendar/TimeRegionDetails/bounds.html): Returns the time region view bounds.
263+
* [region](https://pub.dev/documentation/syncfusion_flutter_calendar/latest/calendar/TimeRegionDetails/region.html): The Region detail associated with the time region view.
264264

265265
{% tabs %}
266266
{% highlight dart hl_lines="22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44" %}
@@ -323,8 +323,8 @@ The [ResourceViewHeaderBuilder](https://pub.dev/documentation/syncfusion_flutter
323323

324324
[ResourceViewHeaderDetails](https://pub.dev/documentation/syncfusion_flutter_calendar/latest/calendar/ResourceViewHeaderDetails-class.html) - returns the required details of the resource view header builder.
325325

326-
* `bound`: returns the resource view header bound.
327-
* `resource`: returns the display name, color, id and image.
326+
* [bounds](https://pub.dev/documentation/syncfusion_flutter_calendar/latest/calendar/ResourceViewHeaderDetails/bounds.html): returns the resource view header bounds.
327+
* [resource](https://pub.dev/documentation/syncfusion_flutter_calendar/latest/calendar/ResourceViewHeaderDetails/resource.html): returns the display name, color, id and image.
328328

329329

330330
{% tabs %}

Flutter/calendar/callbacks.md

Lines changed: 38 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Calendar supports the [ViewChangedCallback](https://pub.dev/documentation/syncfu
1414

1515
The [onViewChanged](https://pub.dev/documentation/syncfusion_flutter_calendar/latest/calendar/SfCalendar/onViewChanged.html) callback triggers when the current view of calendar changed, that is view swiped to previous/next view, calendar view switched to another calendar view.
1616

17-
* `visibleDates` - returns the current view visible dates collection.
17+
* [visibleDates](https://pub.dev/documentation/syncfusion_flutter_calendar/latest/calendar/ViewChangedDetails/visibleDates.html) - returns the current view visible dates collection.
1818

1919
{% tabs %}
2020
{% highlight dart hl_lines="8 9 10" %}
@@ -45,9 +45,10 @@ Widget build(BuildContext context) {
4545

4646
The [onTap](https://pub.dev/documentation/syncfusion_flutter_calendar/latest/calendar/SfCalendar/onTap.html) callback triggers whenever the calendar is tapped.
4747

48-
* `date` - returns the selected date.
49-
* `appointments` - returns the selected appointments.
50-
* `targetElement` - returns the element tapped.
48+
* [date](https://pub.dev/documentation/syncfusion_flutter_calendar/latest/calendar/CalendarTouchDetails/date.html) - returns the selected date.
49+
* [appointments](https://pub.dev/documentation/syncfusion_flutter_calendar/latest/calendar/CalendarTouchDetails/appointments.html) - returns the selected appointments.
50+
* [targetElement](https://pub.dev/documentation/syncfusion_flutter_calendar/latest/calendar/CalendarTouchDetails/targetElement.html) - returns the element tapped.
51+
* [resource](https://pub.dev/documentation/syncfusion_flutter_calendar/latest/calendar/CalendarTouchDetails/resource.html) - returns the tapped resource.
5152

5253
{% tabs %}
5354
{% highlight dart hl_lines="8 9 10 11 12" %}
@@ -75,56 +76,58 @@ Widget build(BuildContext context) {
7576

7677
>**NOTE**
7778
* For recurrence appointment, the tap details will always return as `Appointment`, even for the custom business object.
78-
* The `onTap` and `onLongPress` callbacks are not applicable for pop-ups like allowedViews and date picker in the calendar header.
79+
* The [onTap](https://pub.dev/documentation/syncfusion_flutter_calendar/latest/calendar/SfCalendar/onTap.html) and [onLongPress](https://pub.dev/documentation/syncfusion_flutter_calendar/latest/calendar/SfCalendar/onLongPress.html) callbacks are not applicable for pop-ups like allowedViews and date picker in the calendar header.
7980

8081
## Calendar details callback
8182

8283
Return calendar details based on the given offset passed through argument by using the [getCalendarDetailsAtOffset](https://pub.dev/documentation/syncfusion_flutter_calendar/latest/calendar/CalendarController/getCalendarDetailsAtOffset.html) method.
8384

84-
* `date` - returns the date based on the given offset.
85-
* `appointments` - returns the appointments based on the given offset.
86-
* `targetElement` - returns the calendar element based on the given offset.
87-
* `resource` - returns the resource based on the given offset.
85+
* [date](https://pub.dev/documentation/syncfusion_flutter_calendar/latest/calendar/CalendarTouchDetails/date.html) - returns the date based on the given offset.
86+
* [appointments](https://pub.dev/documentation/syncfusion_flutter_calendar/latest/calendar/CalendarTouchDetails/appointments.html) - returns the appointments based on the given offset.
87+
* [targetElement](https://pub.dev/documentation/syncfusion_flutter_calendar/latest/calendar/CalendarTouchDetails/targetElement.html) - returns the calendar element based on the given offset.
88+
* [resource](https://pub.dev/documentation/syncfusion_flutter_calendar/latest/calendar/CalendarTouchDetails/resource.html) - returns the resource based on the given offset.
8889

8990
{% tabs %}
9091
{% highlight dart hl_lines="6 7 8 9 10 11 12 13 14 15 16" %}
9192

9293
@override
93-
Widget build(BuildContext context) {
94-
return MaterialApp(
95-
home: Scaffold(
96-
body: MouseRegion(
97-
onHover: (PointerHoverEvent event) {
98-
CalendarDetails? details = _calendarController
99-
.getCalendarDetailsAtOffset!(event.localPosition);
100-
if (details!.targetElement == CalendarElement.appointment) {
101-
dynamic appointments = details.appointments;
102-
final String subject =
103-
details.appointments![0].subject.toString();
104-
final dynamic startTime = details.appointments![0].startTime;
105-
final dynamic endTime = details.appointments![0].endTime;
106-
}
107-
},
108-
child: SfCalendar(
109-
view: CalendarView.month,
110-
controller: _calendarController,
111-
dataSource: _getCalendarDataSource(),
112-
))),
113-
);
114-
}
94+
Widget build(BuildContext context) {
95+
return MaterialApp(
96+
home: Scaffold(
97+
body: MouseRegion(
98+
onHover: (PointerHoverEvent event) {
99+
CalendarDetails? details = _calendarController
100+
.getCalendarDetailsAtOffset!(event.localPosition);
101+
if (details!.targetElement == CalendarElement.appointment) {
102+
dynamic appointments = details.appointments;
103+
final String subject =
104+
details.appointments![0].subject.toString();
105+
final dynamic startTime = details.appointments![0].startTime;
106+
final dynamic endTime = details.appointments![0].endTime;
107+
}
108+
},
109+
child: SfCalendar(
110+
view: CalendarView.month,
111+
controller: _calendarController,
112+
dataSource: _getCalendarDataSource(),
113+
),
114+
),
115+
),
116+
);
115117
}
116118

117119
{% endhighlight %}
118120
{% endtabs %}
119121

120122
## Long press callback
121-
The [onLongPress](https://pub.dev/documentation/syncfusion_flutter_calendar/latest/calendar/SfCalendar/onLongPress.html) callback is called, whenever the `SfCalendar` elements are long pressed on view.
123+
The [onLongPress](https://pub.dev/documentation/syncfusion_flutter_calendar/latest/calendar/SfCalendar/onLongPress.html) callback is called, whenever the [SfCalendar](https://pub.dev/documentation/syncfusion_flutter_calendar/latest/calendar/SfCalendar-class.html). elements are long pressed on view.
122124

123125
The long-pressed date, appointments, and element details when the long-press action performed on element available in the [CalendarLongPressDetails](https://pub.dev/documentation/syncfusion_flutter_calendar/latest/calendar/CalendarLongPressDetails-class.html).
124126

125-
* `date` - returns the long-pressed date.
126-
* `appointments` - returns the long-pressed appointments.
127-
* `targetElement` - returns the long-pressed calendar element.
127+
* [date](https://pub.dev/documentation/syncfusion_flutter_calendar/latest/calendar/CalendarTouchDetails/date.html) - returns the long-pressed date.
128+
* [appointments](https://pub.dev/documentation/syncfusion_flutter_calendar/latest/calendar/CalendarTouchDetails/appointments.html) - returns the long-pressed appointments.
129+
* [targetElement](https://pub.dev/documentation/syncfusion_flutter_calendar/latest/calendar/CalendarTouchDetails/targetElement.html) - returns the long-pressed calendar element.
130+
* [resource](https://pub.dev/documentation/syncfusion_flutter_calendar/latest/calendar/CalendarTouchDetails/resource.html) - returns the long-pressed calendar resource.
128131

129132
{% tabs %}
130133
{% highlight dart hl_lines="8 9 10 11 12" %}

0 commit comments

Comments
 (0)