calendar library
The Syncfusion Flutter Calendar widget has built-in configurable views that provide basic functionalities for scheduling and representing appointments/events efficiently.
To use, import package:syncfusion_flutter_calendar/calendar.dart
.
See also:
Classes
- AgendaStyle
- Sets the style to customize SfCalendar month agenda view.
- Appointment
- Appointment data for calendar.
- AppointmentDragEndDetails
- The appointment that dragging ends on view in SfCalendar
- AppointmentDragStartDetails
- The appointment that starts dragging on view in SfCalendar
- AppointmentDragUpdateDetails
- The appointment that dragging on view in SfCalendar
- AppointmentResizeEndDetails
- The appointment that resizing ends on view in SfCalendar
- AppointmentResizeStartDetails
- The appointment that starts resizing on view in SfCalendar
- AppointmentResizeUpdateDetails
- The appointment that resizing on view in SfCalendar
- CalendarAppointmentDetails
- Contains the details that needed on appointment view builder.
- CalendarController
- An object that used for programmatic date navigation and date selection in SfCalendar.
-
CalendarDataSource<
T extends Object?> - An object that maintains the data source for SfCalendar.
- CalendarDataSourceChangeNotifier
- Notifier used to notify the action performed in the CalendarDataSource
- CalendarDetails
- Details for CalendarDetailsCallback, such as appointments, date, and targetElement and resource.
- CalendarHeaderStyle
- Sets the style for customizing the SfCalendar header view.
- CalendarLongPressDetails
- The element that long pressed on view in SfCalendar
- CalendarResource
- The resource data for calendar.
- CalendarSelectionDetails
- The element that tapped on view in SfCalendar
- CalendarTapDetails
- The element that tapped on view in SfCalendar
- CalendarTouchDetails
- The element that tapped or long pressed on view in SfCalendar.
- CalendarValueChangedNotifier
- Notifier used to notify the when the objects properties changed.
- DayHeaderSettings
- Sets the style to customize day label in SfCalendar schedule view.
- DragAndDropSettings
- The settings have properties which allow to customize the drag and drop environment of the SfCalendar.
- MonthCellDetails
- Contains the details that needed on month cell builder.
- MonthCellStyle
- Sets the style to customize SfCalendar month cells.
- MonthHeaderSettings
- Sets the style to customize month label in SfCalendar schedule view.
- MonthViewSettings
- The settings have properties which allow to customize the month view of the SfCalendar.
- RecurrenceProperties
- Recurrence properties allows to create recurrence rule for an Appointment.
- ResourceViewHeaderDetails
- Contains the details that needed on resource view header builder.
- ResourceViewSettings
- The settings have properties which allow to customize the resource view of the SfCalendar.
- ScheduleViewMonthHeaderDetails
- Contains the details that needed on schedule view month header builder.
- ScheduleViewSettings
- The settings have properties which allow to customize the schedule view of the SfCalendar.
- SfCalendar
- A material design calendar.
- TimeRegion
- It is used to highlight time slots on day, week, work week and timeline views based on start and end time and also used to restrict interaction on time slots.
- TimeRegionDetails
- Contains the details that needed on special region view builder.
- TimeSlotViewSettings
- The settings have properties which allow to customize the time slot views of the SfCalendar.
- ViewChangedDetails
- The dates that visible on the view changes in SfCalendar.
- ViewHeaderStyle
- Sets the style to customize SfCalendar view header.
- WeekHeaderSettings
- Sets the style to customize week label in SfCalendar schedule view.
- WeekNumberStyle
- Sets the style to customize the week number text of SfCalendar.
Enums
- AppointmentType
- Available Appointment types for Appointment
- CalendarDataSourceAction
- Action performed in data source
- CalendarElement
- The available calendar elements for the CalendarTapDetails in SfCalendar
- CalendarView
- Available views for SfCalendar.
- MonthAppointmentDisplayMode
- Available appointment display mode for SfCalendar month cell.
- A direction in which the SfCalendar month view navigates.
- RecurrenceRange
- The available options to recur the Appointment in SfCalendar
- RecurrenceType
- Available recurrence types for Appointment in SfCalendar
- Available view navigation modes for SfCalendar.
- WeekDays
- The week days occurrence of Appointment.
Typedefs
- AppointmentDragEndCallback = void Function(AppointmentDragEndDetails appointmentDragEndDetails)
- Signature for callback that reports that a appointment dragging completed in SfCalendar.
- AppointmentDragStartCallback = void Function(AppointmentDragStartDetails appointmentDragStartDetails)
- Signature for callback that reports that a appointment starts dragging in SfCalendar.
- AppointmentDragUpdateCallback = void Function(AppointmentDragUpdateDetails appointmentDragUpdateDetails)
- Signature for callback that reports that a appointment dragging in SfCalendar.
- AppointmentResizeEndCallback = void Function(AppointmentResizeEndDetails appointmentResizeEndDetails)
- Signature for callback that reports that a appointment resizing completed in SfCalendar.
- AppointmentResizeStartCallback = void Function(AppointmentResizeStartDetails appointmentResizeStartDetails)
- Signature for callback that reports that a appointment starts resizing in SfCalendar.
- AppointmentResizeUpdateCallback = void Function(AppointmentResizeUpdateDetails appointmentResizeUpdateDetails)
- Signature for callback that reports that a appointment resizing in SfCalendar.
- CalendarAppointmentBuilder = Widget Function(BuildContext context, CalendarAppointmentDetails calendarAppointmentDetails)
- Signature for a function that creates a widget based on appointment details.
- CalendarDataSourceCallback = void Function(CalendarDataSourceAction, List)
- Signature for callback that reports that a appointment collection set to the CalendarDataSource modified.
- CalendarDetailsCallback = CalendarDetails? Function(Offset position)
-
Signature for callback that gets the calendar details by using the
getCalendarDetailsAtOffset
function. - CalendarLongPressCallback = void Function(CalendarLongPressDetails calendarLongPressDetails)
- Signature for callback that reports that a calendar element long pressed on view.
- CalendarSelectionChangedCallback = void Function(CalendarSelectionDetails calendarSelectionDetails)
- Signature for callback that reports that a calendar view selection changed on view.
- CalendarTapCallback = void Function(CalendarTapDetails calendarTapDetails)
- Signature for callback that reports that a calendar element tapped on view.
- CalendarValueChangedCallback = void Function(String)
- Signature for callback that reports that the CalendarController properties changed.
-
LoadMoreCallback
= Future<
void> Function() - Signature for the function that have no arguments and return no data, but that return a Future to indicate when their work is complete.
- LoadMoreWidgetBuilder = Widget Function(BuildContext context, LoadMoreCallback loadMoreAppointments)
- Signature for the function that create the widget based on load more details.
- MonthCellBuilder = Widget Function(BuildContext context, MonthCellDetails details)
- Signature for a function that creates a widget based on month cell details.
- ResourceViewHeaderBuilder = Widget Function(BuildContext context, ResourceViewHeaderDetails details)
- Signature for a function that creates a widget based on resource header details.
- ScheduleViewMonthHeaderBuilder = Widget Function(BuildContext context, ScheduleViewMonthHeaderDetails details)
- Signature for a function that creates a widget based on month header details.
- TimeRegionBuilder = Widget Function(BuildContext context, TimeRegionDetails timeRegionDetails)
- Signature for a function that creates a widget based on time region details.
- ViewChangedCallback = void Function(ViewChangedDetails viewChangedDetails)
- Signature for callback that reports that a current view or current visible dates changes.