WeekCalendar class

A horizontally scrollable weekly calendar widget with multiple visual styles

Inheritance
Available extensions

Constructors

WeekCalendar({Key? key, required DateTime initialDate, required DateTime selectedDate, required ValueChanged<DateTime> onDateSelected, VoidCallback? onNextMonth, VoidCallback? onPreviousMonth, VoidCallback? onPreviousWeek, VoidCallback? onNextWeek, WeekCalendarType calendarType = WeekCalendarType.standard, WeekCalendarStyle calendarStyle = const WeekCalendarStyle(), Duration? animationDuration, Curve? animationCurve, bool showMonthHeader = true, IconData? previousMonthIcon = Icons.chevron_left, IconData? nextMonthIcon = Icons.chevron_right, Color? iconColor, Weekday? startingDay, bool enableAnimations = true, dynamic onHeaderDateTapped(Offset widgetPosition)?, dynamic onHeaderTodayDate(Offset widgetPosition)?, bool isUtc = true, bool showCalendarPopupOnHeaderTap = true, DateTime? minDate, DateTime? maxDate, Set<DateTime>? eventIndicatorDates, Color? eventIndicatorColor})
Default constructor for standard calendar
const
WeekCalendar.minimal({Key? key, required DateTime initialDate, required DateTime selectedDate, required ValueChanged<DateTime> onDateSelected, VoidCallback? onNextMonth, VoidCallback? onPreviousMonth, VoidCallback? onPreviousWeek, VoidCallback? onNextWeek, WeekCalendarStyle calendarStyle = const WeekCalendarStyle(dayIndicatorSize: 32, monthHeaderStyle: TextStyle(fontSize: 14), selectedDayTextStyle: TextStyle(fontWeight: FontWeight.bold)), Duration? animationDuration, Curve? animationCurve, bool showMonthHeader = true, IconData? previousMonthIcon = Icons.chevron_left, IconData? nextMonthIcon = Icons.chevron_right, Color? iconColor, Weekday? startingDay, bool enableAnimations = true, dynamic onHeaderDateTapped(Offset widgetPosition)?, dynamic onHeaderTodayDate(Offset widgetPosition)?, bool isUtc = true, bool showCalendarPopupOnHeaderTap = true, DateTime? minDate, DateTime? maxDate, Set<DateTime>? eventIndicatorDates, Color? eventIndicatorColor})
Preconfigured constructor for minimal variant
const
WeekCalendar.outlined({Key? key, required DateTime initialDate, required DateTime selectedDate, required ValueChanged<DateTime> onDateSelected, VoidCallback? onNextMonth, VoidCallback? onPreviousMonth, VoidCallback? onPreviousWeek, VoidCallback? onNextWeek, WeekCalendarStyle calendarStyle = const WeekCalendarStyle(), Duration? animationDuration, Curve? animationCurve, bool showMonthHeader = true, IconData? previousMonthIcon = Icons.chevron_left, IconData? nextMonthIcon = Icons.chevron_right, Color? iconColor, Weekday? startingDay, bool enableAnimations = true, dynamic onHeaderDateTapped(Offset widgetPosition)?, dynamic onHeaderTodayDate(Offset widgetPosition)?, bool isUtc = true, bool showCalendarPopupOnHeaderTap = true, DateTime? minDate, DateTime? maxDate, Set<DateTime>? eventIndicatorDates, Color? eventIndicatorColor})
Preconfigured constructor for outlined variant
const

Properties

animationCurve → Curve?
Custom curve for month transition animations
final
animationDuration → Duration?
Custom duration for month transition animations
final
calendarStyle → WeekCalendarStyle
Complete styling configuration
final
calendarType → WeekCalendarType
Visual variant of the calendar
final
enableAnimations → bool
Global toggle for all animations
final
eventIndicatorColor → Color?
Color of the event indicator dot. Defaults to the theme's primary color.
final
eventIndicatorDates → Set<DateTime>?
Set of dates that should display an event indicator dot.
final
hashCode → int
The hash code for this object.
no setterinherited
iconColor → Color?
Color for navigation icons
final
initialDate → DateTime
Initial displayed month
final
isUtc → bool
Indicates if the calendar is in UTC mode
final
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
makeRefreshable → Widget

Available on Widget?, provided by the WidgetExtension extension

Make your any widget refreshable with RefreshIndicator on top
no setter
maxDate → DateTime?
Latest selectable date. Days after this are disabled.
final
minDate → DateTime?
Earliest selectable date. Days before this are disabled.
final
nextMonthIcon → IconData?
Custom icon for next month navigation
final
onDateSelected → ValueChanged<DateTime>
Callback when user selects a date
final
onHeaderDateTapped → dynamic Function(Offset widgetPosition)?
Callback when the header date is tapped
final
onHeaderTodayDate → dynamic Function(Offset widgetPosition)?
Callback when the header today's date is tapped
final
onNextMonth → VoidCallback?
Callback when calendar advances to next month
final
onNextWeek → VoidCallback?
Callback when calendar advances to next week
final
onPreviousMonth → VoidCallback?
Callback when calendar returns to previous month
final
onPreviousWeek → VoidCallback?
Callback when calendar returns to previous week
final
previousMonthIcon → IconData?
Custom icon for previous month navigation
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
selectedDate → DateTime
Currently selected date
final
showCalendarPopupOnHeaderTap → bool
Toggles the display of the calendar popup on header tap
final
showMonthHeader → bool
Toggles month header visibility
final
startingDay → Weekday?
Override default week starting day
final

Methods

addMaterialWidget() → Material

Available on Widget, provided by the GenericExtensions extension

addTooltipWidget(String toolTip) → Tooltip

Available on Widget, provided by the GenericExtensions extension

borderRadius([BorderRadiusGeometry? borderRadius]) → Widget

Available on Widget, provided by the GenericExtensions extension

boxDecoration([BoxDecoration? boxDecoration]) → Widget

Available on Widget, provided by the GenericExtensions extension

center({double? heightFactor, double? widthFactor}) → Widget

Available on Widget?, provided by the WidgetExtension extension

set parent widget in center
colorFilter([ColorFilter? colorFilter]) → Widget

Available on Widget, provided by the GenericExtensions extension

set parent widget in center
cornerRadiusWithClipRRect(double radius) → ClipRRect

Available on Widget?, provided by the WidgetExtension extension

add corner radius
cornerRadiusWithClipRRectOnly({int bottomLeft = 0, int bottomRight = 0, int topLeft = 0, int topRight = 0}) → ClipRRect

Available on Widget?, provided by the WidgetExtension extension

add custom corner radius each side
createElement() → StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → State<WeekCalendar>
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
expand({int flex = 1}) → Widget

Available on Widget?, provided by the WidgetExtension extension

add Expanded to parent widget
fit({BoxFit? fit, AlignmentGeometry? alignment}) → Widget

Available on Widget?, provided by the WidgetExtension extension

add FittedBox to parent widget
flexible({int flex = 1, FlexFit? fit}) → Widget

Available on Widget?, provided by the WidgetExtension extension

add Flexible to parent widget
launch<T>(BuildContext context, {bool isNewTask = false, PageRouteAnimation? pageRouteAnimation, Duration? duration, String? routeName, Object? routeArguments}) → Future<T?>

Available on Widget?, provided by the WidgetExtension extension

Launch a new screen
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
onTap(Function? function, {BorderRadius? borderRadius, Color? splashColor, Color? hoverColor, Color? highlightColor, Color? focusColor, WidgetStateProperty<Color?>? overlayColor}) → Widget

Available on Widget?, provided by the WidgetExtension extension

add tap to parent widget
opacity({required double opacity, int durationInSecond = 1, Duration? duration}) → Widget

Available on Widget?, provided by the WidgetExtension extension

add opacity to parent widget
paddingAll(double padding) → Padding

Available on Widget?, provided by the WidgetExtension extension

return padding all
paddingBottom(double bottom) → Padding

Available on Widget?, provided by the WidgetExtension extension

return padding bottom
paddingDirectional({double start = 0.0, double top = 0.0, double end = 0.0, double bottom = 0.0}) → Widget

Available on Widget?, provided by the WidgetExtension extension

paddingLeft(double left) → Padding

Available on Widget?, provided by the WidgetExtension extension

return padding left
paddingOnly({double top = 0.0, double left = 0.0, double bottom = 0.0, double right = 0.0}) → Padding

Available on Widget?, provided by the WidgetExtension extension

return custom padding from each side
paddingRight(double right) → Padding

Available on Widget?, provided by the WidgetExtension extension

return padding right
paddingSymmetric({double vertical = 0.0, double horizontal = 0.0}) → Padding

Available on Widget?, provided by the WidgetExtension extension

return padding symmetric
paddingTop(double top) → Padding

Available on Widget?, provided by the WidgetExtension extension

return padding top
rotate({required double angle, bool transformHitTests = true, Offset? origin}) → Widget

Available on Widget?, provided by the WidgetExtension extension

add rotation to parent widget
scale({required double scale, Offset? origin, AlignmentGeometry? alignment, bool transformHitTests = true}) → Widget

Available on Widget?, provided by the WidgetExtension extension

add scaling to parent widget
toDiagnosticsNode({String? name, DiagnosticsTreeStyle? style}) → DiagnosticsNode
Returns a debug representation of the object that is used by debugging tools and by DiagnosticsNode.toStringDeep.
inherited
tooltip({required String msg}) → Widget

Available on Widget?, provided by the WidgetExtension extension

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
translate({required Offset offset, bool transformHitTests = true, Key? key}) → Widget

Available on Widget?, provided by the WidgetExtension extension

add translate to parent widget
validate({Widget value = const SizedBox()}) → Widget

Available on Widget?, provided by the WidgetExtension extension

Validate given widget is not null and returns given value if null.
visible(bool visible, {Widget? defaultWidget}) → Widget

Available on Widget?, provided by the WidgetExtension extension

set visibility
withHeight(double height) → SizedBox

Available on Widget?, provided by the WidgetExtension extension

With custom height
withRoundedCorners({Color backgroundColor = whiteColor, BorderRadius borderRadius = const BorderRadius.all(Radius.circular(8.0)), LinearGradient? gradient, BoxBorder? border, List<BoxShadow>? boxShadow, DecorationImage? decorationImage, BoxShape boxShape = BoxShape.rectangle}) → Container

Available on Widget?, provided by the WidgetExtension extension

withScroll({ScrollPhysics? physics, EdgeInsetsGeometry? padding, Axis scrollDirection = Axis.vertical, ScrollController? controller, DragStartBehavior dragStartBehavior = DragStartBehavior.start, bool? primary, required bool reverse}) → Widget

Available on Widget?, provided by the WidgetExtension extension

withShaderMask(List<Color> colors, {BlendMode blendMode = BlendMode.srcATop}) → Widget

Available on Widget?, provided by the WidgetExtension extension

Wrap with ShaderMask widget
withShaderMaskGradient(Gradient gradient, {BlendMode blendMode = BlendMode.srcATop}) → Widget

Available on Widget?, provided by the WidgetExtension extension

Wrap with ShaderMask widget Gradient
withShadow({Color bgColor = whiteColor, Color shadowColor = Colors.black12, dynamic blurRadius = 10.0, dynamic spreadRadius = 0.0, Offset offset = const Offset(0.0, 0.0), LinearGradient? gradient, BoxBorder? border, DecorationImage? decorationImage, BoxShape boxShape = BoxShape.rectangle}) → Container

Available on Widget?, provided by the WidgetExtension extension

withSize({double width = 0.0, double height = 0.0}) → SizedBox

Available on Widget?, provided by the WidgetExtension extension

With custom height and width
withTooltip({required String msg}) → Widget

Available on Widget?, provided by the WidgetExtension extension

Validate given widget is not null and returns given value if null.
withVisibility(bool visible, {Widget? replacement, bool maintainAnimation = false, bool maintainState = false, bool maintainSize = false, bool maintainSemantics = false, bool maintainInteractivity = false}) → Visibility

Available on Widget?, provided by the WidgetExtension extension

set widget visibility
withWidth(double width) → SizedBox

Available on Widget?, provided by the WidgetExtension extension

With custom width

Operators

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