kalender
library
Classes
ContinuousScheduleIndexCalculator
Views
Calculates page indices and date ranges for a continuous schedule view.
ContinuousScheduleViewController
Controllers and callbacks
The ScheduleViewController of ScheduleViewConfiguration.continuous , one list over the display range.
CustomIndexCalculator
Views
Calculates page indices and date ranges for a custom multi-day view.
DayDetail
Controllers and callbacks
The detail for when the calendar is tapped.
A widget that displays the name of the day and the day number of the week.
The style for the DayHeader .
DayIndexCalculator
Views
Calculates page indices and date ranges for a single day view.
DayNumberStyle
Appearance
The style of the DayNumber.
DaySeparator
Appearance
A widget that displays a separator between days.
DaySeparatorStyle
Appearance
The style for the DaySeparator widget.
DefaultEventsController
Events
The default EventsController for managing KalenderEvent s.
DefaultEventStore
Events
The default class for storing KalenderEvent s.
DefaultResizeHandles
Interaction
The default layout for the resize handles of an event tile.
DurationMultiDayLayoutStrategy
Layout
Places the longest events first, breaking ties by start time.
EventInteraction
Interaction
What users may do with one event: resize its start, resize its end and reschedule it.
EventLayoutData
Layout
This stores the final layout data of a single KalenderEvent .
EventLayoutDelegate
Layout
The base MultiChildLayoutDelegate class for laying out KalenderEvent s.
EventLayoutDelegateCache
Layout
A cache for EventLayoutDelegate s.
EventLayoutInformation
Layout
Contains all the data needed to layout a single event with the MultiDayLayout .
EventLayoutStrategy
Layout
Decides how tiles that overlap in time share a day column.
EventsController
Events
The EventsController is used to manage KalenderEvent s.
EventSnapStrategy
Interaction
Decides where a dragged event lands, given the position of the cursor.
EventStore
Events
A class that maps KalenderEvent s to dates.
FloatingDateTime
Dates and times
A date and time with no timezone, used for calendar layout.
FloatingDateTimeRange
Dates and times
A range between two FloatingDateTime s, used for calendar layout.
GestureCallbacks <T extends TapDetail >
Controllers and callbacks
The gestures reported for one part of the calendar, such as KalenderCallbacks.dateLabel .
HorizontalConfiguration
Views
The base class for all horizontal views of the calendar.
HorizontalGroupData
Layout
This stores horizontal data top and bottom for a group of VerticalLayoutData .
HourLines
Appearance
A widget that displays lines for each hour based on the timeOfDayRange and heightPerMinute .
HourLinesStyle
Appearance
The style of the HourLines widget.
IntervalSnapStrategy
Interaction
Snaps to the nearest multiple of the snap interval.
KalenderCallbacks
Controllers and callbacks
The callbacks used by the KalenderView .
KalenderComponents
Appearance
A class holding the widget builders used by the KalenderView .
KalenderController
Controllers and callbacks
Holds the ViewConfiguration and Location of a calendar and the ViewController a KalenderView shows.
KalenderDateTimeRange
Dates and times
A range between two DateTime s. FloatingDateTimeRange.forLocation converts to it,
FloatingDateTimeRange.fromDateTimeRange back.
KalenderEvent
Events
Base class for events displayed in the calendar.
KalenderInteraction
Interaction
What users may do with the calendar: resize, reschedule and create events, and with which gestures.
KalenderScope
Controllers and callbacks
Reads the state of the KalenderView a widget is built inside.
KalenderSnapping
Interaction
How a dragged or resized event snaps to time intervals, the time indicator and other events.
KalenderTheme
Appearance
Applies a KalenderThemeData to the calendars below it.
KalenderThemeData
Appearance
The calendar's visual theme, following the same layering as Flutter's own component themes.
KalenderTime
Dates and times
A time of day, as an hour and a minute.
KalenderTimeRange
Dates and times
Encapsulates a start and end KalenderTime that represents a day time range.
KalenderView
Views
A calendar that shows the events of eventsController in the view kalenderController holds.
KalenderViewState
Views
The state of a KalenderView . It holds the ViewController the view shows.
Location
A Location maps time instants to the zone in use at that time.
Typically, the Location represents the collection of time offsets
in use in a geographical area, such as CEST and CET for central Europe.
MonthBody
Views
The weeks of a month view, one page per month. The default body of MonthViewParts .
MonthBodyComponents
Appearance
The component builders used by the MonthBody .
MonthBodyConfiguration
Views
The configuration of a MonthBody .
MonthComponents
Appearance
A class containing custom widget builders for the MonthBody and MonthHeader .
MonthDayCell
Appearance
Renders the background of a single day cell in the month body.
MonthDayCellDetails
Appearance
Details describing a single day cell, passed to a MonthDayCellBuilder .
A widget that displays the day number.
The style of the MonthDayHeader .
MonthGrid
Appearance
A widget that displays the month grid.
MonthGridStyle
Appearance
The style of the MonthGrid .
The weekday names above a MonthBody . The default header of MonthViewParts .
The component builders used by the MonthHeader .
MonthIndexCalculator
Views
Calculates page indices and date ranges for a month view.
MonthViewConfiguration
Views
MonthViewController
Controllers and callbacks
The controller of a month view. It opens on the month of the date of initial.
MonthViewParts
Views
The parts of a MonthViewConfiguration : a MonthHeader and a MonthBody by default.
MonthWeek
Views
A single week in the month view.
MultiDayBody
Views
The scrollable body of a multi-day view: a timeline and one column of events per day. The default body of
MultiDayViewParts .
MultiDayBodyComponents
Appearance
The component builders used by the MultiDayBody .
MultiDayBodyConfiguration
Views
The configuration used by the MultiDayBody .
MultiDayComponents
Appearance
A class containing custom widget builders for the MultiDayBody and MultiDayHeader .
MultiDayDetail
Controllers and callbacks
The detail for when a multi-day range is tapped.
MultiDayEventOverlayTile
Appearance
The day headers and multi-day events above a MultiDayBody . The default header of MultiDayViewParts .
The component builders used by the MultiDayHeader .
The configuration used by the MultiDayHeader .
MultiDayLayout
Layout
A custom layout delegate for arranging multi-day events in a calendar view.
MultiDayLayoutFrame
Layout
Frame containing all the data to layout the KalenderEvent s with MultiDayLayout .
MultiDayLayoutFrameCache
Layout
A cache for MultiDayLayoutFrame s.
MultiDayLayoutStrategy
Layout
Assigns each event in the multi-day lane a row and a span of columns.
MultiDayOverlay
Appearance
MultiDayOverlayPortal
Appearance
The "+N more" button of a day. It opens the day's overlay through KalenderController.openDayOverlay .
MultiDayOverlayStyle
Appearance
MultiDayPage
Views
MultiDayPortalOverlayButton
Appearance
MultiDayPortalOverlayButtonStyle
Appearance
MultiDayRule
Events
Decides whether an event belongs in the multi-day header lane rather than the day timeline.
MultiDayViewConfiguration
Views
The configuration used by the MultiDayBody and MultiDayHeader .
MultiDayViewController
Controllers and callbacks
The controller of a multi-day view. It opens on the date, time of day and zoom of initial.
MultiDayViewParts
Views
The parts of a MultiDayViewConfiguration : a MultiDayHeader and a MultiDayBody by default.
NoSnapStrategy
Interaction
Returns the cursor position unchanged.
OverlapLayoutDelegate
Layout
The OverlapLayoutDelegate lays out KalenderEvent s, by stacking them on top of one another.
OverlapLayoutStrategy
Layout
Lays out the tiles on top of each other.
OverlayBuilders
Appearance
Builders used to create the overlayPortal, overlay and overlay button widgets.
PageIndexCalculator
Views
Calculates page indices and date ranges for paginated calendar views.
PageTriggerConfiguration
Interaction
The configuration for the page triggers.
PaginatedSchedule
Views
A PageView of SchedulePositionList s for a PaginatedScheduleViewController .
PaginatedScheduleIndexCalculator
Views
Calculates page indices and date ranges for a paginated schedule view.
PaginatedScheduleViewController
Controllers and callbacks
The ScheduleViewController of ScheduleViewConfiguration.paginated , one page per month.
ResizeDetector
Interaction
The draggable that detects a resize gesture, wrapping the handle widget from TileComponents.verticalResizeHandle
or TileComponents.horizontalResizeHandle .
ResizeHandleDetails
Interaction
What a ResizeHandlePositioner needs to lay out the resize handles of one event tile.
ResizeHandleStyle
Appearance
The style of the resize handles laid out by DefaultResizeHandles .
ScheduleBody
Views
Displays events as a vertical list. The default body of ScheduleViewParts .
ScheduleBodyConfiguration
Views
ScheduleComponents
Appearance
A class containing custom widget builders for the ScheduleBody.
ScheduleDate
Appearance
The short day name and the day of the month shown at the start of each day in the schedule.
ScheduleDateStyle
Appearance
The style of the ScheduleDate .
SchedulePositionList
Views
A scrollable list of the schedule items in range , tracking the position of every item.
ScheduleTileComponents
Appearance
The components used by the ScheduleBody to render the event tiles.
ScheduleTileHighlight
Appearance
A widget that highlights the list item if the date is within the given range.
ScheduleTileHighlightStyle
Appearance
ScheduleViewConfiguration
Views
ScheduleViewController
Controllers and callbacks
The controller of a schedule view. It opens on the date of initial.
ScheduleViewParts
Views
The parts of a ScheduleViewConfiguration : a ScheduleBody and no header by default.
ScrollTriggerConfiguration
Interaction
The configuration for the scroll triggers.
SideBySideLayoutDelegate
Layout
The SideBySideLayoutDelegate lays out KalenderEvent s next to one another.
SideBySideLayoutStrategy
Layout
Lays out the tiles side by side.
SideBySidePlacement
Layout
Where SideBySideLayoutDelegate.arrange places one tile: in column of a group with columns columns, widened
over span columns.
TapDetail
Controllers and callbacks
The detail of a gesture on the calendar, a DayDetail or a MultiDayDetail depending on the calendar view.
TileComponents
Appearance
The components used by the MultiDayBody /MonthBody to render the event tiles.
TimeIndicator
Appearance
A widget that displays the current time as a line and a circle.
TimeIndicatorStyle
Appearance
The style of the TimeIndicator widget.
TimeLine
Appearance
A widget that displays a list of times based on the timeOfDayRange and heightPerMinute .
TimelineStyle
Appearance
The style of the TimeLine widget.
TZDateTime
TimeZone aware DateTime.
VerticalConfiguration
Views
The base class for all vertical views of the calendar.
VerticalLayoutData
Layout
This stores the vertical layout data of a single KalenderEvent .
ViewConfiguration
Views
The base class for all ViewConfiguration s.
ViewController
Controllers and callbacks
A controller for calendar views.
ViewParts <C extends ViewConfiguration >
Views
The header and body KalenderView shows for a kind of ViewConfiguration .
ViewSnapshot
Views
What a view shows, as returned by ViewController.snapshot .
ViewTransitionContext
Views
The inputs available when resolving how a view switch or a location change should transfer state.
A widget that displays the name of the day of the week.
The style of the WeekDayHeader .
WeekIndexCalculator
Views
Calculates page indices and date ranges for a week view.
WeekNumber
Appearance
A widget that displays the week number.
WeekNumberStyle
Appearance
The style of the WeekNumber .
Typedefs
DateResolver
= FloatingDateTime Function(ViewTransitionContext transition )
Views
Resolves the initial date for the incoming view. Overrides DateTransition .
DateStringBuilder
= String Function(BuildContext context , DateTime date )
Appearance
Builds the text displayed for date.
DateToEventIds
= Map <String , Set <String > >
Events
Maps a date key from DefaultEventStore.toKey to the ids of the events on that date.
The day header builder.
DaySeparatorBuilder
= Widget Function(BuildContext context )
Appearance
The day separator builder.
EmptyItemBuilder
= Widget Function(BuildContext context , KalenderDateTimeRange tileRange )
Appearance
The builder for the empty item.
EventIdToEvent
= Map <String , KalenderEvent >
Events
Maps an event id to its KalenderEvent .
FeedbackTileBuilder
= Widget Function(BuildContext context , KalenderEvent event , Size dropTargetWidgetSize )
Appearance
The builder for the feedback tile. (When dragging)
HiddenEventCountStringBuilder
= String Function(BuildContext context , int numberOfHiddenEvents )
Appearance
Builds the text displayed on the overlay button that opens the hidden events.
HorizontalTriggerWidgetBuilder
= Widget Function(BuildContext context , double pageWidth )
Interaction
The trigger widget builder, should be constrained in width.
HourLinesBuilder
= Widget Function(BuildContext context , double heightPerMinute , KalenderTimeRange timeOfDayRange )
Appearance
The hour lines builder.
KalenderTimeStringBuilder
= String Function(BuildContext context , KalenderTime time )
Appearance
Builds the text displayed for time.
LocationDateIdMap
= Map <String , DateToEventIds >
Events
Maps a timezone location name to its DateToEventIds .
MonthDayCellBuilder
= Widget Function(BuildContext context , MonthDayCellDetails details )
Appearance
Builds the background of a single day cell in the month body.
The month day header builder.
MonthGridBuilder
= Widget Function(BuildContext context , int numberOfRows )
Appearance
The month grid builder.
MonthItemBuilder
= Widget Function(BuildContext context , KalenderDateTimeRange tileRange )
Appearance
The builder for the month item.
MultiDayOverlayBuilder
= Widget Function(BuildContext context , {required DateTime date , required List <KalenderEvent > events , required RenderBoxCallback getMultiDayEventLayoutRenderBox , required RenderBoxCallback getOverlayPortalRenderBox , required MultiDayOverlayEventTileBuilder overlayTileBuilder , required OverlayPortalController portalController , required double tileHeight })
Appearance
A function that returns a MultiDayOverlay widget.
MultiDayOverlayEventTileBuilder
= MultiDayEventOverlayTile Function(BuildContext context , KalenderEvent event , FloatingDateTimeRange floatingRange , VoidCallback dismissOverlay )
Appearance
A function that returns a MultiDayEventOverlayTile for the multi-day overlay.
MultiDayOverlayPortalBuilder
= Widget Function(BuildContext context , {required DateTime date , required List <KalenderEvent > events , required int numberOfHiddenRows , required OverlayBuilders ? overlayBuilders , required double tileHeight })
Appearance
A function that returns a MultiDayOverlayPortal .
MultiDayPortalOverlayButtonBuilder
= Widget Function(BuildContext context , OverlayPortalController portalController , int numberOfHiddenRows )
Appearance
The builder used to create the button for the MultiDayPortalOverlayButton .
NowCallback
= DateTime Function()
Views
A callback that returns the current DateTime representing "now" for the calendar.
OnEventChange
= void Function(KalenderEvent event )
Controllers and callbacks
The callback for when an event is about to be changed.
OnEventChanged
= void Function(KalenderEvent event , KalenderEvent updatedEvent )
Controllers and callbacks
The callback for when an event is changed.
OnEventCreate
= KalenderEvent ? Function(KalenderEvent event )
Controllers and callbacks
The call back for creating a new event.
OnEventCreated
= void Function(KalenderEvent event )
Controllers and callbacks
The callback for a new event has been created.
OnEventCreateWithDetail
= KalenderEvent ? Function(KalenderEvent event , TapDetail detail )
Controllers and callbacks
The call back for creating a new event with details.
OnEventTapped
= void Function(KalenderEvent event )
Controllers and callbacks
The callback for when an event is tapped.
OnEventTappedWithDetail
= void Function(KalenderEvent event , TapDetail detail )
Controllers and callbacks
The callback for when an event is tapped.
OnGesture <T extends TapDetail >
= void Function(T detail )
Controllers and callbacks
A callback for a gesture on one part of the calendar.
OnLongPressed
= void Function(DateTime date )
Controllers and callbacks
The callback for when a user long presses on an empty space in the calendar.
OnLongPressedWithDetail
= void Function(TapDetail detail )
Controllers and callbacks
The callback for when a user long presses on an empty space in the calendar with details.
OnPageChanged
= void Function(KalenderDateTimeRange dateTimeRange )
Controllers and callbacks
The callback for when a calendar page is changed.
OnScrollPositionChanged
= void Function(KalenderTime visibleTimeOfDay )
Controllers and callbacks
The callback for when the vertical scroll position of a multi-day view changes.
OnTapped
= void Function(DateTime date )
Controllers and callbacks
The callback for when a user taps on an empty space in the calendar.
OnTappedWithDetail
= void Function(TapDetail detail )
Controllers and callbacks
The callback for when a user taps on an empty space in the calendar with details.
OnWillAcceptWithDetailsHorizontal
= bool Function(DragTargetDetails <Object ? > details , KalenderController controller , HorizontalConfiguration configuration )
Interaction
The callback for when a drag target is evaluating whether to accept a draggable.
OnWillAcceptWithDetailsVertical
= bool Function(DragTargetDetails <Object ? > details , KalenderController controller , VerticalConfiguration configuration )
Interaction
The callback for when a drag target is evaluating whether to accept a draggable.
RenderBoxCallback
= RenderBox Function()
Layout
A function that returns a RenderBox for the multi-day event layout.
ResizeHandlePositioner
= Widget Function(BuildContext context , ResizeHandleDetails details )
Interaction
The builder that positions the resize handles of an event tile.
ScheduleDateBuilder
= Widget Function(BuildContext context , FloatingDateTime date )
Appearance
Builds the date shown at the start of each day in the schedule.
ScheduleTileHighlightBuilder
= Widget Function(BuildContext context , FloatingDateTime date , ValueNotifier <FloatingDateTimeRange ? > range , Widget child )
Appearance
The schedule tile highlight builder.
ScrollResolver
= KalenderTime ? Function(ViewTransitionContext transition )
Views
Resolves the time of day the incoming multi-day view opens on. A null result falls back to ScrollTransition .
TileBuilder
= Widget Function(BuildContext context , KalenderEvent event , KalenderDateTimeRange tileRange )
Appearance
The default builder for the event tiles.
TileDropTargetBuilder
= Widget Function(BuildContext context , KalenderEvent event )
Appearance
The builder for the drop target event tile.
TileWhenDraggingBuilder
= Widget Function(BuildContext context , KalenderEvent event )
Appearance
The builder for the event tile when dragging.
TimeIndicatorBuilder
= Widget Function(BuildContext context , KalenderTimeRange timeOfDayRange , double heightPerMinute , Location ? location )
Appearance
The time indicator builder.
TimeLineBuilder
= Widget Function(BuildContext context , double heightPerMinute , KalenderTimeRange timeOfDayRange , ValueNotifier <KalenderEvent ? > eventBeingDragged , ValueListenable <KalenderDateTimeRange > visibleDateTimeRange )
Appearance
The time line builder.
TimelineWidthBuilder
= double Function(BuildContext context , KalenderTimeRange timeOfDayRange )
Appearance
Resolves the width of the timeline gutter.
UpdatedEvent
= (KalenderEvent , KalenderEvent )
Events
VerticalTriggerWidgetBuilder
= Widget Function(BuildContext context , double pageWidth )
Interaction
The trigger widget builder, should be constrained in height.
The week day header builder.
WeekNumberBuilder
= Widget Function(BuildContext context , KalenderDateTimeRange visibleDateTimeRange )
Appearance
The week number builder.
WeekNumberWidthBuilder
= double Function(BuildContext context )
Appearance
Resolves the width of the month's week number column.
ZoomResolver
= double ? Function(ViewTransitionContext transition )
Views
Resolves the zoom (heightPerMinute) the incoming multi-day view opens on. A null result falls back to
ZoomTransition .