MonthView<T extends Object?> class

Inheritance

Constructors

MonthView({Key? key, bool showBorder = true, Color borderColor = Constants.defaultBorderColor, CellBuilder<T>? cellBuilder, DateTime? minMonth, DateTime? maxMonth, EventController<T>? controller, DateTime? initialMonth, double borderSize = 1, bool useAvailableVerticalSpace = false, double cellAspectRatio = 0.55, DateWidgetBuilder? headerBuilder, WeekDayBuilder? weekDayBuilder, Duration pageTransitionDuration = const Duration(milliseconds: 300), Curve pageTransitionCurve = Curves.ease, double? width, CalendarPageChangeCallBack? onPageChange, CellTapCallback<T>? onCellTap, TileTapCallback<T>? onEventTap, TileTapCallback<T>? onEventLongTap, DatePressCallback? onDateLongPress, WeekDays startDay = WeekDays.monday, StringProvider? headerStringBuilder, StringProvider? dateStringBuilder, String weekDayStringBuilder(int)?, HeaderStyle headerStyle = const HeaderStyle(), SafeAreaOption safeAreaOption = const SafeAreaOption(), HeaderTitleCallback? onHeaderTitleTap, ScrollPhysics pagePhysics = const ClampingScrollPhysics(), ScrollPhysics? pageViewPhysics, TileTapCallback<T>? onEventDoubleTap, bool showWeekTileBorder = true, bool hideDaysNotInMonth = false, dynamic pageController(PageController pageController)?, Color? backgroundHeaderColor})
Main Widget to display month view.
const

Properties

backgroundHeaderColor → Color?
final
borderColor → Color
Defines width of default border
final
borderSize → double
Defines width of default border
final
cellAspectRatio → double
Defines aspect ratio of day cells in month calendar page.
final
cellBuilder → CellBuilder<T>?
A function that returns a Widget that determines appearance of each cell in month calendar.
final
controller → EventController<T>?
A required parameters that controls events for month view.
final
dateStringBuilder → StringProvider?
This function will generate DayString in month view cell. Useful for I18n
final
hashCode → int
The hash code for this object.
no setterinherited
headerBuilder → DateWidgetBuilder?
Builds month page title.
final
headerStringBuilder → StringProvider?
This function will generate DateString in the calendar header. Useful for I18n
final
headerStyle → HeaderStyle
Style for MontView header.
final
hideDaysNotInMonth → bool
defines that show and hide cell not is in current month
final
initialMonth → DateTime?
Defines initial display month.
final
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
maxMonth → DateTime?
Determines upper boundary user can scroll.
final
minMonth → DateTime?
Determines the lower boundary user can scroll.
final
onCellTap → CellTapCallback<T>?
This function will be called when user taps on month view cell.
final
onDateLongPress → DatePressCallback?
This method will be called when user long press on calendar.
final
onEventDoubleTap → TileTapCallback<T>?
This method will be called when user double taps on event tile.
final
onEventLongTap → TileTapCallback<T>?
This function will be called when user will long press on a single event tile inside a cell.
final
onEventTap → TileTapCallback<T>?
This function will be called when user will tap on a single event tile inside a cell.
final
onHeaderTitleTap → HeaderTitleCallback?
Callback for the Header title
final
onPageChange → CalendarPageChangeCallBack?
Called when user changes month.
final
pageController → dynamic Function(PageController pageController)?
final
pagePhysics → ScrollPhysics
Defines scroll physics for a page of a month view.
final
pageTransitionCurve → Curve
Page transition curve used when user try to change page using MonthView.nextPage or MonthView.previousPage
final
pageTransitionDuration → Duration
Page transition duration used when user try to change page using MonthView.nextPage or MonthView.previousPage
final
pageViewPhysics → ScrollPhysics?
Defines scroll physics for a page of a month view.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
safeAreaOption → SafeAreaOption
Option for SafeArea.
final
showBorder → bool
Defines whether to show default borders or not.
final
showWeekTileBorder → bool
Defines whether to show default borders or not for weekTile.
final
startDay → WeekDays
/// Defines the day from which the week starts.
final
useAvailableVerticalSpace → bool
Automated Calculate cellAspectRatio using available vertical space.
final
weekDayBuilder → WeekDayBuilder?
Builds the name of the weeks.
final
weekDayStringBuilder → String Function(int)?
This function will generate WeeDayString in weekday view. Useful for I18n Ex : 'Mon','Tue','Wed','Thu','Fri','Sat','Sun'
final
width → double?
Width of month view.
final

Methods

createElement() → StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → MonthViewState<T>
Creates the mutable state for this widget at a given location in the tree.
override
debugDescribeChildren() → List<DiagnosticsNode>
Returns a list of DiagnosticsNode objects describing this node's children.
inherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → void
Add additional properties associated with the node.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toDiagnosticsNode({String? name, DiagnosticsTreeStyle? style}) → DiagnosticsNode
Returns a debug representation of the object that is used by debugging tools and by DiagnosticsNode.toStringDeep.
inherited
toString({DiagnosticLevel minLevel = DiagnosticLevel.info}) → String
A string representation of this object.
inherited
toStringDeep({String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug, int wrapWidth = 65}) → String
Returns a string representation of this node and its descendants.
inherited
toStringShallow({String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String
Returns a one-line detailed description of the object.
inherited
toStringShort() → String
A short, textual description of this widget.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited