Calendar class

A month calendar widget with selection, range and events support.

Inheritance
Available extensions

Constructors

Calendar({Key? key, DateTime? initialMonth, DateTime? initialSelected, ValueChanged<DateTime>? onSelected, DateTimeRange<DateTime>? initialRange, ValueChanged<DateTimeRange<DateTime>>? onRangeSelected, CalendarMode mode = CalendarMode.single, String? locale, DateFormat? monthFormat, List<String>? weekdayLabels, int firstDayOfWeek = DateTime.monday, Set<DateTime> markerDates = const <DateTime>{}, Color? markerColor, Color? selectedColor, Color? todayColor, Widget dayBuilder(BuildContext, DateTime)?, TextStyle? monthTextStyle, TextStyle? weekdayTextStyle, TextStyle? dayTextStyle, bool showOutsideDays = true, bool showTrailingOutsideDays = true})
const

Properties

centered → Widget

Available on Widget, provided by the WidgetX extension

Wraps the widget in a Center.
no setter
dayBuilder → Widget Function(BuildContext, DateTime)?
Custom day cell builder.
final
dayTextStyle → TextStyle?
Day number style.
final
firstDayOfWeek → int
First day of the week.
final
hashCode → int
The hash code for this object.
no setterinherited
initialMonth → DateTime?
Initially displayed month.
final
initialRange → DateTimeRange<DateTime>?
Initial range.
final
initialSelected → DateTime?
Initially selected date(s).
final
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
locale → String?
Calendar locale (used for month names).
final
markerColor → Color?
Marker dot color.
final
markerDates → Set<DateTime>
Dates to highlight with a dot.
final
mode → CalendarMode
Selection mode.
final
monthFormat → DateFormat?
Month title format.
final
monthTextStyle → TextStyle?
Month title style.
final
onRangeSelected → ValueChanged<DateTimeRange<DateTime>>?
Range-selection callback.
final
onSelected → ValueChanged<DateTime>?
Single-selection callback.
final
repaint → Widget

Available on Widget, provided by the WidgetX extension

Wraps in RepaintBoundary to isolate repaints.
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
selectedColor → Color?
Selected day background color.
final
showOutsideDays → bool
Show days from the previous month in the leading cells.
final
showTrailingOutsideDays → bool
Show days from the next month in the trailing cells.
final
todayColor → Color?
Today outline color.
final
weekdayLabels → List<String>?
Custom weekday headers (7 entries, starting from firstDayOfWeek).
final
weekdayTextStyle → TextStyle?
Weekday header style.
final

Methods

animatedSwitcher({Duration duration = const Duration(milliseconds: 300), AnimatedSwitcherTransitionBuilder transitionBuilder = _defaultAnimatedSwitcherTransition, AnimatedSwitcherLayoutBuilder layoutBuilder = AnimatedSwitcher.defaultLayoutBuilder}) → Widget

Available on Widget, provided by the WidgetX extension

Wraps in an AnimatedSwitcher with duration and default fade.
createElement() → StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → State<Calendar>
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
expanded({int flex = 1}) → Widget

Available on Widget, provided by the WidgetX extension

Expands the widget inside a Flex parent.
fadeIn({double opacity = 1, Duration duration = const Duration(milliseconds: 300), Curve curve = Curves.easeIn}) → Widget

Available on Widget, provided by the WidgetAnimateX extension

Wraps in an AnimatedOpacity.
flexible({int flex = 1, FlexFit fit = FlexFit.loose}) → Widget

Available on Widget, provided by the WidgetX extension

Applies flexible sizing.
keyed(Object key) → Widget

Available on Widget, provided by the WidgetX extension

Wraps the widget in a KeyedSubtree with key.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
onTap(VoidCallback onTap, {HitTestBehavior behavior = HitTestBehavior.opaque}) → Widget

Available on Widget, provided by the WidgetX extension

Wraps the widget in GestureDetector with onTap.
pad({double horizontal = 0, double vertical = 0}) → Widget

Available on Widget, provided by the WidgetX extension

Applies symmetric padding.
padded([double padding = AppSpacing.lg]) → Widget

Available on Widget, provided by the WidgetX extension

Applies uniform padding.
scaleOnTap({double scale = 0.95, required VoidCallback onTap, Duration duration = const Duration(milliseconds: 150)}) → Widget

Available on Widget, provided by the WidgetAnimateX extension

Wraps in an AnimatedScale.
semantics({required String label, bool button = false}) → Widget

Available on Widget, provided by the WidgetX extension

Wraps in a Semantics node with label.
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
visible({bool condition = true}) → Widget

Available on Widget, provided by the WidgetX extension

Hides the widget entirely when condition is false.
withPadding(EdgeInsetsGeometry padding) → Widget

Available on Widget, provided by the WidgetX extension

Applies padding only.

Operators

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