UICalendar class
Widget that provides a calendar function.
Tap the date on the monthly calendar to display the event details.
You can also tap the event to take action.
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatefulWidget
- UICalendar
Constructors
-
UICalendar({Key? key, List events = const [], List holidays = const [], DateTime? initialDay, Widget? markerIcon, UICalendarMarkerType markerType = UICalendarMarkerType.count, Widget markerItemBuilder(EventData event)?, void onTap(EventData eventData)?, String startTimeKey = "startTime", String endTimeKey = "endTime", String titleKey = "name", String textKey = "text", String titleBuilder(dynamic data)?, String textBuilder(dynamic data)?, String allDayKey = "allDay", bool expand = false, double heightOfDayOfWeekLabel = 20, TableBorder? calendarContentBorder, Widget dayBuilder(BuildContext context, DateTime date, List<
EventData> events)?, Widget selectedDayBuilder(BuildContext context, DateTime date, List<EventData> events)?, Color? highlightTodayColor, Color? highlightTodayTextColor, Color? highlightSelectedDayColor, Color? highlightSelectedDayTextColor, bool highlightSelectedDay = true, bool highlightToday = true, Color? counterColor, Color? counterTextColor, Map<DateTime, String> ? regularHolidays, Color? saturdayColor, Color? sundayColor, Color? holidayColor, Widget todayDayBuilder(BuildContext context, DateTime date, List<EventData> events)?, List<Widget> markersBuilder(BuildContext context, DateTime date, List<EventData> events, List<EventData> holidays)?, void onDaySelect(DateTime day, List<EventData> events, List<EventData> holidays)?, void onDayLongPressed(DateTime day, List<EventData> events, List<EventData> holidays)?, Duration animationTime = const Duration(milliseconds: 300)}) -
Widget that provides a calendar function.
const
Properties
- allDayKey → String
-
True if the event is all day.
final
- animationTime → Duration
-
Animation time.
final
- calendarContentBorder → TableBorder?
-
Specify all borders of the calendar.
final
- counterColor → Color?
-
Color of the counter.
final
- counterTextColor → Color?
-
Text color of the counter.
final
-
dayBuilder
→ (Widget Function(BuildContext context, DateTime date, List<
EventData> events)?) -
Day builder.
final
- endTimeKey → String
-
Key for event end time.
final
- events → List
-
Event list.
final
- expand → bool
-
Display the calendar in the full width of the parent widget.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- heightOfDayOfWeekLabel → double
-
DayOfWeek label height.
final
- highlightSelectedDay → bool
-
True to highlight the selected days.
final
- highlightSelectedDayColor → Color?
-
The color when the selected date is highlighted.
final
- highlightSelectedDayTextColor → Color?
-
The text color when the selected date is highlighted.
final
- highlightToday → bool
-
True to highlight today.
final
- highlightTodayColor → Color?
-
Color for highlighting today.
final
- highlightTodayTextColor → Color?
-
Text color for highlighting today.
final
- holidayColor → Color?
-
Holiday Colors.
final
- holidays → List
-
Holiday list.
final
- initialDay → DateTime?
-
First date to choose.
final
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- markerIcon → Widget?
-
Icons for markers.
final
- markerItemBuilder → (Widget Function(EventData event)?)
-
Builder for each item in the marker.
final
-
markersBuilder
→ (List<
Widget> Function(BuildContext context, DateTime date, List<EventData> events, List<EventData> holidays)?) -
Markers builder.
final
- markerType → UICalendarMarkerType
-
Marker type of calendar.
final
-
onDayLongPressed
→ (void Function(DateTime day, List<
EventData> events, List<EventData> holidays)?) -
What happens when a date is long pressed.
final
-
onDaySelect
→ (void Function(DateTime day, List<
EventData> events, List<EventData> holidays)?) -
What happens when a date is selected.
final
- onTap → (void Function(EventData eventData)?)
-
Processing when an event is tapped.
final
-
regularHolidays
→ Map<
DateTime, String> ? -
Regular holiday list.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- saturdayColor → Color?
-
Saturday Color.
final
-
selectedDayBuilder
→ (Widget Function(BuildContext context, DateTime date, List<
EventData> events)?) -
Selected day builder.
final
- startTimeKey → String
-
Key for event start time.
final
- sundayColor → Color?
-
Sunday Colors.
final
- textBuilder → (String Function(dynamic data)?)
-
Builder for getting text.
final
- textKey → String
-
The text key.
final
- titleBuilder → (String Function(dynamic data)?)
-
Builder for getting the title.
final
- titleKey → String
-
The name key.
final
-
todayDayBuilder
→ (Widget Function(BuildContext context, DateTime date, List<
EventData> events)?) -
Today day builder.
final
Methods
-
createElement(
) → StatefulElement -
Creates a StatefulElement to manage this widget's location in the tree.
inherited
-
createState(
) → _UICalendarState -
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}) → 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 Properties
-
japaneseHolidays
→ Map<
DateTime, String> -
Holidays in Japan.
final