FCalendar class

A calendar.

The calendar pages are designed to be navigable through swipe gestures on mobile Android, iOS & iPadOS, allowing left and right swipes to transition between pages.

All DateTimes are in UTC timezone. A FCalendarController is used to customize the date selection behavior. DateTimes outside start and end are unselectable regardless of the FCalendarController used.

See:

Inheritance

Constructors

FCalendar({required FCalendarController controller, FCalendarStyle style(FCalendarStyle style)?, ValueWidgetBuilder<FCalendarDayData> dayBuilder = defaultDayBuilder, ValueChanged<DateTime>? onMonthChange, ValueChanged<DateTime>? onPress, ValueChanged<DateTime>? onLongPress, FCalendarPickerType initialType = FCalendarPickerType.day, DateTime? start, DateTime? end, DateTime? today, DateTime? initialMonth, Key? key})
Creates a FCalendar.

Properties

controller → FCalendarController
A controller that determines if a date is selected.
final
dayBuilder → ValueWidgetBuilder<FCalendarDayData>
The builder used to build a day in the day picker. Defaults to returning the given child.
final
end → DateTime
The end date, exclusive. It is truncated to the nearest date. Defaults to 1st January, 2100.
final
hashCode → int
The hash code for this object.
no setterinherited
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
onLongPress → ValueChanged<DateTime>?
A callback for when a date in a FCalendarPickerType.day picker is long pressed.
final
onMonthChange → ValueChanged<DateTime>?
A callback for when the displayed month changes.
final
onPress → ValueChanged<DateTime>?
A callback for when a date in a FCalendarPickerType.day picker is pressed.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
start → DateTime
The start date, inclusive. It is truncated to the nearest date. Defaults to 1st January, 1900.
final
style → FCalendarStyle Function(FCalendarStyle style)?
The style. Defaults to FThemeData.calendarStyle.
final
today → DateTime
The current date. It is truncated to the nearest date. Defaults to the DateTime.now.
final

Methods

createElement() → StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → State<FCalendar>
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.
override
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

Static Methods

defaultDayBuilder(BuildContext _, FCalendarDayData data, Widget? child) → Widget
The default day builder.