commonMain.com.kizitonwose.calendar.compose.heatmapcalendar.HeatMapWeek.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of compose-multiplatform Show documentation

A highly customizable calendar library for Compose Multiplatform, backed by LazyRow/LazyColumn.

There is a newer version: 2.6.0-beta01

Show newest version

package com.kizitonwose.calendar.compose.heatmapcalendar

import androidx.compose.runtime.Immutable
import com.kizitonwose.calendar.compose.HeatMapCalendar
import com.kizitonwose.calendar.core.CalendarDay

/**
 * Represents a week on the heatmap calendar.
 *
 * This model exists only as a wrapper class with the [Immutable] annotation for compose.
 * The alternative would be to use the `kotlinx.ImmutableList` type for the `days` value
 * which is used ONLY in the dayContent parameter of the [HeatMapCalendar] but then we
 * would force that dependency on the library consumers.
 *
 * @param days the days in this week.
 */
@Immutable
public data class HeatMapWeek(val days: List)