Method Detail

• HorizontalCalendar

  @Composable() final static Unit HorizontalCalendar(Modifier modifier, CalendarState state, Boolean calendarScrollPaged, Boolean userScrollEnabled, Boolean reverseLayout, PaddingValues contentPadding, Function2<BoxScope, CalendarDay, Unit> dayContent, Function2<ColumnScope, CalendarMonth, Unit> monthHeader, Function3<ColumnScope, CalendarMonth, Function0<Unit>, Unit> monthBody, Function2<ColumnScope, CalendarMonth, Unit> monthFooter, Function3<LazyItemScope, CalendarMonth, Function0<Unit>, Unit> monthContainer)

  A horizontally scrolling calendar.

  Parameters:

  modifier - the modifier to apply to this calendar.

  state - the state object to be used to control or observe the calendar's properties.

  calendarScrollPaged - the scrolling behavior of the calendar.

  userScrollEnabled - whether the scrolling via the user gestures or accessibility actions is allowed.

  reverseLayout - reverse the direction of scrolling and layout.

  contentPadding - a padding around the whole calendar.

  dayContent - a composable block which describes the day content.

  monthHeader - a composable block which describes the month header content.

  monthBody - a composable block which describes the month body content.

  monthFooter - a composable block which describes the month footer content.

  monthContainer - a composable block which describes the entire month content.

• VerticalCalendar

  @Composable() final static Unit VerticalCalendar(Modifier modifier, CalendarState state, Boolean calendarScrollPaged, Boolean userScrollEnabled, Boolean reverseLayout, PaddingValues contentPadding, Function2<BoxScope, CalendarDay, Unit> dayContent, Function2<ColumnScope, CalendarMonth, Unit> monthHeader, Function3<ColumnScope, CalendarMonth, Function0<Unit>, Unit> monthBody, Function2<ColumnScope, CalendarMonth, Unit> monthFooter, Function3<LazyItemScope, CalendarMonth, Function0<Unit>, Unit> monthContainer)

  A vertically scrolling calendar.

  Parameters:

  modifier - the modifier to apply to this calendar.

  state - the state object to be used to control or observe the calendar's properties.

  calendarScrollPaged - the scrolling behavior of the calendar.

  userScrollEnabled - whether the scrolling via the user gestures or accessibility actions is allowed.

  reverseLayout - reverse the direction of scrolling and layout.

  contentPadding - a padding around the whole calendar.

  dayContent - a composable block which describes the day content.

  monthHeader - a composable block which describes the month header content.

  monthBody - a composable block which describes the month body content.

  monthFooter - a composable block which describes the month footer content.

  monthContainer - a composable block which describes the entire month content.

• WeekCalendar

  @Composable() final static Unit WeekCalendar(Modifier modifier, WeekCalendarState state, Boolean calendarScrollPaged, Boolean userScrollEnabled, Boolean reverseLayout, PaddingValues contentPadding, Function2<BoxScope, WeekDay, Unit> dayContent, Function2<ColumnScope, Week, Unit> weekHeader, Function2<ColumnScope, Week, Unit> weekFooter)

  A horizontally scrolling week calendar.

  Parameters:

  modifier - the modifier to apply to this calendar.

  state - the state object to be used to control or observe the calendar's properties.

  calendarScrollPaged - the scrolling behavior of the calendar.

  userScrollEnabled - whether the scrolling via the user gestures or accessibility actions is allowed.

  reverseLayout - reverse the direction of scrolling and layout.

  contentPadding - a padding around the whole calendar.

  dayContent - a composable block which describes the day content.

  weekHeader - a composable block which describes the week header content.

  weekFooter - a composable block which describes the week footer content.

• HeatMapCalendar

  @Composable() final static Unit HeatMapCalendar(Modifier modifier, HeatMapCalendarState state, HeatMapWeekHeaderPosition weekHeaderPosition, Boolean userScrollEnabled, PaddingValues contentPadding, Function3<ColumnScope, CalendarDay, HeatMapWeek, Unit> dayContent, Function2<ColumnScope, DayOfWeek, Unit> weekHeader, Function2<ColumnScope, CalendarMonth, Unit> monthHeader)

  A horizontal scrolling heatmap calendar, useful for showing how data changes over time. A popular example is the user contribution chart on GitHub.

  Parameters:

  modifier - the modifier to apply to this calendar.

  state - the state object to be used to control or observe the calendar's properties.

  weekHeaderPosition - Determines the position for the weekHeader composable.

  userScrollEnabled - whether the scrolling via the user gestures or accessibility actions is allowed.

  contentPadding - a padding around the whole calendar.

  dayContent - a composable block which describes the day content.

  weekHeader - a composable block which describes the day of week (Mon, Tue, Wed...) on the horizontal axis of the calendar.

  monthHeader - a composable block which describes the month header content.