Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rename year calendar parameter columns to monthColumns #571

Merged
merged 1 commit into from
Aug 3, 2024
Merged

Rename year calendar parameter columns to monthColumns #571

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 20 additions & 17 deletions ...-multiplatform/library/src/commonMain/kotlin/com/kizitonwose/calendar/compose/Calendar.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -308,7 +308,7 @@ public fun HeatMapCalendar(
* @param modifier the modifier to apply to this calendar.
* @param state the state object to be used to control or observe the calendar's properties.
* Examples: `startYear`, `endYear`, `firstDayOfWeek`, `firstVisibleYear`, `outDateStyle`.
* @param columns the number of months columns in each year on the calendar.
* @param monthColumns the number of month columns in each year. Must be from 1 to 12.
* @param calendarScrollPaged the scrolling behavior of the calendar. When `true`, the calendar will
* snap to the nearest year after a scroll or swipe action. When `false`, the calendar scrolls normally.
* @param userScrollEnabled whether the scrolling via the user gestures or accessibility actions
Expand All @@ -319,10 +319,11 @@ public fun HeatMapCalendar(
* content after it has been clipped, which is not possible via [modifier] param. You can use it
* to add a padding before the first year or after the last one. If you want to add a spacing
* between each year, use the [yearContainer] composable or the [yearBodyContentPadding] parameter.
* @param yearBodyContentPadding a padding around the year body content. Alternatively, you can
* also provide a [yearBody] with the desired padding to achieve the same result.
* @param monthVerticalSpacing the vertical spacing between month rows.
* @param monthHorizontalSpacing the horizontal spacing between month columns.
* @param yearBodyContentPadding a padding around the year body content, this is the grid in which
* the months in each year are shown, excluding the year header and footer. Alternatively, you can
* provide a [yearBody] with the desired padding to achieve the same result.
* @param monthVerticalSpacing the vertical spacing between month rows in each year.
* @param monthHorizontalSpacing the horizontal spacing between month columns in each year.
* @param contentHeightMode Determines how the height of the month and day content is calculated.
* @param isMonthVisible Determines if a month is shown on the calendar grid. For example, you can
* use this to hide all past months.
Expand Down Expand Up @@ -361,7 +362,7 @@ public fun HeatMapCalendar(
public fun HorizontalYearCalendar(
modifier: Modifier = Modifier,
state: YearCalendarState = rememberYearCalendarState(),
columns: Int = 3,
monthColumns: Int = 3,
calendarScrollPaged: Boolean = true,
userScrollEnabled: Boolean = true,
reverseLayout: Boolean = false,
Expand All @@ -383,7 +384,7 @@ public fun HorizontalYearCalendar(
): Unit = YearCalendar(
modifier = modifier,
state = state,
columns = columns,
monthColumns = monthColumns,
calendarScrollPaged = calendarScrollPaged,
userScrollEnabled = userScrollEnabled,
isHorizontal = true,
Expand Down Expand Up @@ -411,7 +412,7 @@ public fun HorizontalYearCalendar(
* @param modifier the modifier to apply to this calendar.
* @param state the state object to be used to control or observe the calendar's properties.
* Examples: `startYear`, `endYear`, `firstDayOfWeek`, `firstVisibleYear`, `outDateStyle`.
* @param columns the number of months columns in each year on the calendar.
* @param monthColumns the number of month columns in each year. Must be from 1 to 12.
* @param calendarScrollPaged the scrolling behavior of the calendar. When `true`, the calendar will
* snap to the nearest year after a scroll or swipe action. When `false`, the calendar scrolls normally.
* @param userScrollEnabled whether the scrolling via the user gestures or accessibility actions
Expand All @@ -422,10 +423,11 @@ public fun HorizontalYearCalendar(
* content after it has been clipped, which is not possible via [modifier] param. You can use it
* to add a padding before the first year or after the last one. If you want to add a spacing
* between each year, use the [yearContainer] composable or the [yearBodyContentPadding] parameter.
* @param yearBodyContentPadding a padding around the year body content. Alternatively, you can
* also provide a [yearBody] with the desired padding to achieve the same result.
* @param monthVerticalSpacing the vertical spacing between month rows.
* @param monthHorizontalSpacing the horizontal spacing between month columns.
* @param yearBodyContentPadding a padding around the year body content, this is the grid in which
* the months in each year are shown, excluding the year header and footer. Alternatively, you can
* provide a [yearBody] with the desired padding to achieve the same result.
* @param monthVerticalSpacing the vertical spacing between month rows in each year.
* @param monthHorizontalSpacing the horizontal spacing between month columns in each year.
* @param contentHeightMode Determines how the height of the month and day content is calculated.
* @param isMonthVisible Determines if a month is shown on the calendar grid. For example, you can
* use this to hide all past months.
Expand Down Expand Up @@ -464,7 +466,7 @@ public fun HorizontalYearCalendar(
public fun VerticalYearCalendar(
modifier: Modifier = Modifier,
state: YearCalendarState = rememberYearCalendarState(),
columns: Int = 3,
monthColumns: Int = 3,
calendarScrollPaged: Boolean = true,
userScrollEnabled: Boolean = true,
reverseLayout: Boolean = false,
Expand All @@ -486,7 +488,7 @@ public fun VerticalYearCalendar(
): Unit = YearCalendar(
modifier = modifier,
state = state,
columns = columns,
monthColumns = monthColumns,
calendarScrollPaged = calendarScrollPaged,
userScrollEnabled = userScrollEnabled,
isHorizontal = false,
Expand All @@ -512,7 +514,7 @@ public fun VerticalYearCalendar(
private fun YearCalendar(
modifier: Modifier,
state: YearCalendarState,
columns: Int,
monthColumns: Int,
calendarScrollPaged: Boolean,
userScrollEnabled: Boolean,
isHorizontal: Boolean,
Expand All @@ -533,6 +535,7 @@ private fun YearCalendar(
yearFooter: (@Composable ColumnScope.(CalendarYear) -> Unit)?,
yearContainer: (@Composable LazyItemScope.(CalendarYear, container: @Composable () -> Unit) -> Unit)?,
) {
require(monthColumns in 1..12) { "Param `monthColumns` must be 1..12" }
if (isHorizontal) {
LazyRow(
modifier = modifier,
Expand All @@ -545,7 +548,7 @@ private fun YearCalendar(
YearCalendarMonths(
yearCount = state.calendarInfo.indexCount,
yearData = { offset -> state.store[offset] },
columns = columns,
monthColumns = monthColumns,
monthVerticalSpacing = monthVerticalSpacing,
monthHorizontalSpacing = monthHorizontalSpacing,
yearBodyContentPadding = yearBodyContentPadding,
Expand Down Expand Up @@ -574,7 +577,7 @@ private fun YearCalendar(
YearCalendarMonths(
yearCount = state.calendarInfo.indexCount,
yearData = { offset -> state.store[offset] },
columns = columns,
monthColumns = monthColumns,
monthVerticalSpacing = monthVerticalSpacing,
monthHorizontalSpacing = monthHorizontalSpacing,
yearBodyContentPadding = yearBodyContentPadding,
Expand Down
22 changes: 10 additions & 12 deletions ...src/commonMain/kotlin/com/kizitonwose/calendar/compose/yearcalendar/YearCalendarMonths.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,13 @@ import com.kizitonwose.calendar.compose.or
import com.kizitonwose.calendar.core.CalendarDay
import com.kizitonwose.calendar.core.CalendarMonth
import com.kizitonwose.calendar.core.CalendarYear
import kotlin.math.min

@Suppress("FunctionName")
internal fun LazyListScope.YearCalendarMonths(
yearCount: Int,
yearData: (offset: Int) -> CalendarYear,
columns: Int,
monthColumns: Int,
monthVerticalSpacing: Dp,
monthHorizontalSpacing: Dp,
yearBodyContentPadding: PaddingValues,
Expand Down Expand Up @@ -74,8 +75,8 @@ internal fun LazyListScope.YearCalendarMonths(
.fillMaxWidth()
.then(if (fillHeight) Modifier.weight(1f) else Modifier.wrapContentHeight())
.padding(yearBodyContentPadding),
columns = columns,
itemCount = months.count(),
monthColumns = monthColumns,
monthCount = months.count(),
fillHeight = fillHeight,
monthVerticalSpacing = monthVerticalSpacing,
monthHorizontalSpacing = monthHorizontalSpacing,
Expand Down Expand Up @@ -139,39 +140,36 @@ internal fun LazyListScope.YearCalendarMonths(

@Composable
private fun CalendarGrid(
columns: Int,
monthColumns: Int,
fillHeight: Boolean,
monthVerticalSpacing: Dp,
monthHorizontalSpacing: Dp,
itemCount: Int,
monthCount: Int,
modifier: Modifier = Modifier,
content: @Composable BoxScope.(Int) -> Unit,
) {
Column(
modifier = modifier,
verticalArrangement = Arrangement.spacedBy(monthVerticalSpacing),
) {
var rows = (itemCount / columns)
if (itemCount.mod(columns) > 0) {
rows += 1
}
val rows = (monthCount / monthColumns) + min(monthCount % monthColumns, 1)

for (rowId in 0 until rows) {
val firstIndex = rowId * columns
val firstIndex = rowId * monthColumns

Row(
modifier = Modifier.then(
if (fillHeight) Modifier.weight(1f) else Modifier,
),
horizontalArrangement = Arrangement.spacedBy(monthHorizontalSpacing),
) {
for (columnId in 0 until columns) {
for (columnId in 0 until monthColumns) {
val index = firstIndex + columnId
Box(
modifier = Modifier
.weight(1f),
) {
if (index < itemCount) {
if (index < monthCount) {
content(index)
}
}
Expand Down
2 changes: 1 addition & 1 deletion compose-multiplatform/sample/src/commonMain/kotlin/Example10Page.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ fun Example10Page(adjacentYears: Int = 50) {
.fillMaxSize()
.testTag("Calendar"),
state = state,
columns = if (isPortrait) {
monthColumns = if (isPortrait) {
3
} else {
if (isTablet) 4 else 6
Expand Down
2 changes: 1 addition & 1 deletion compose-multiplatform/sample/src/commonMain/kotlin/ListPage.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ enum class Page(val title: String, val subtitle: String, val showToolBar: Boolea
),
Example10(
title = "Example 10",
subtitle = "Horizontal year calendar - Year header and paged scrolling. Best suited for large screens.",
subtitle = "Horizontal year calendar - Paged scrolling, shows the \"Fill\" implementation of YearContentHeightMode property. Best suited for large screens.",
showToolBar = true,
),
Example11(
Expand Down
38 changes: 21 additions & 17 deletions compose/src/main/java/com/kizitonwose/calendar/compose/Calendar.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
package com.kizitonwose.calendar.compose

import androidx.annotation.IntRange
import androidx.compose.foundation.layout.BoxScope
import androidx.compose.foundation.layout.ColumnScope
import androidx.compose.foundation.layout.PaddingValues
Expand Down Expand Up @@ -308,7 +309,7 @@ public fun HeatMapCalendar(
* @param modifier the modifier to apply to this calendar.
* @param state the state object to be used to control or observe the calendar's properties.
* Examples: `startYear`, `endYear`, `firstDayOfWeek`, `firstVisibleYear`, `outDateStyle`.
* @param columns the number of months columns in each year on the calendar.
* @param monthColumns the number of month columns in each year. Must be from 1 to 12.
* @param calendarScrollPaged the scrolling behavior of the calendar. When `true`, the calendar will
* snap to the nearest year after a scroll or swipe action. When `false`, the calendar scrolls normally.
* @param userScrollEnabled whether the scrolling via the user gestures or accessibility actions
Expand All @@ -319,10 +320,11 @@ public fun HeatMapCalendar(
* content after it has been clipped, which is not possible via [modifier] param. You can use it
* to add a padding before the first year or after the last one. If you want to add a spacing
* between each year, use the [yearContainer] composable or the [yearBodyContentPadding] parameter.
* @param yearBodyContentPadding a padding around the year body content. Alternatively, you can
* also provide a [yearBody] with the desired padding to achieve the same result.
* @param monthVerticalSpacing the vertical spacing between month rows.
* @param monthHorizontalSpacing the horizontal spacing between month columns.
* @param yearBodyContentPadding a padding around the year body content, this is the grid in which
* the months in each year are shown, excluding the year header and footer. Alternatively, you can
* provide a [yearBody] with the desired padding to achieve the same result.
* @param monthVerticalSpacing the vertical spacing between month rows in each year.
* @param monthHorizontalSpacing the horizontal spacing between month columns in each year.
* @param contentHeightMode Determines how the height of the month and day content is calculated.
* @param isMonthVisible Determines if a month is shown on the calendar grid. For example, you can
* use this to hide all past months.
Expand Down Expand Up @@ -361,7 +363,7 @@ public fun HeatMapCalendar(
public fun HorizontalYearCalendar(
modifier: Modifier = Modifier,
state: YearCalendarState = rememberYearCalendarState(),
columns: Int = 3,
@IntRange(from = 1, to = 12) monthColumns: Int = 3,
calendarScrollPaged: Boolean = true,
userScrollEnabled: Boolean = true,
reverseLayout: Boolean = false,
Expand All @@ -383,7 +385,7 @@ public fun HorizontalYearCalendar(
): Unit = YearCalendar(
modifier = modifier,
state = state,
columns = columns,
monthColumns = monthColumns,
calendarScrollPaged = calendarScrollPaged,
userScrollEnabled = userScrollEnabled,
isHorizontal = true,
Expand Down Expand Up @@ -411,7 +413,7 @@ public fun HorizontalYearCalendar(
* @param modifier the modifier to apply to this calendar.
* @param state the state object to be used to control or observe the calendar's properties.
* Examples: `startYear`, `endYear`, `firstDayOfWeek`, `firstVisibleYear`, `outDateStyle`.
* @param columns the number of months columns in each year on the calendar.
* @param monthColumns the number of month columns in each year. Must be from 1 to 12.
* @param calendarScrollPaged the scrolling behavior of the calendar. When `true`, the calendar will
* snap to the nearest year after a scroll or swipe action. When `false`, the calendar scrolls normally.
* @param userScrollEnabled whether the scrolling via the user gestures or accessibility actions
Expand All @@ -422,10 +424,11 @@ public fun HorizontalYearCalendar(
* content after it has been clipped, which is not possible via [modifier] param. You can use it
* to add a padding before the first year or after the last one. If you want to add a spacing
* between each year, use the [yearContainer] composable or the [yearBodyContentPadding] parameter.
* @param yearBodyContentPadding a padding around the year body content. Alternatively, you can
* also provide a [yearBody] with the desired padding to achieve the same result.
* @param monthVerticalSpacing the vertical spacing between month rows.
* @param monthHorizontalSpacing the horizontal spacing between month columns.
* @param yearBodyContentPadding a padding around the year body content, this is the grid in which
* the months in each year are shown, excluding the year header and footer. Alternatively, you can
* provide a [yearBody] with the desired padding to achieve the same result.
* @param monthVerticalSpacing the vertical spacing between month rows in each year.
* @param monthHorizontalSpacing the horizontal spacing between month columns in each year.
* @param contentHeightMode Determines how the height of the month and day content is calculated.
* @param isMonthVisible Determines if a month is shown on the calendar grid. For example, you can
* use this to hide all past months.
Expand Down Expand Up @@ -464,7 +467,7 @@ public fun HorizontalYearCalendar(
public fun VerticalYearCalendar(
modifier: Modifier = Modifier,
state: YearCalendarState = rememberYearCalendarState(),
columns: Int = 3,
@IntRange(from = 1, to = 12) monthColumns: Int = 3,
calendarScrollPaged: Boolean = true,
userScrollEnabled: Boolean = true,
reverseLayout: Boolean = false,
Expand All @@ -486,7 +489,7 @@ public fun VerticalYearCalendar(
): Unit = YearCalendar(
modifier = modifier,
state = state,
columns = columns,
monthColumns = monthColumns,
calendarScrollPaged = calendarScrollPaged,
userScrollEnabled = userScrollEnabled,
isHorizontal = false,
Expand All @@ -512,7 +515,7 @@ public fun VerticalYearCalendar(
private fun YearCalendar(
modifier: Modifier,
state: YearCalendarState,
columns: Int,
monthColumns: Int,
calendarScrollPaged: Boolean,
userScrollEnabled: Boolean,
isHorizontal: Boolean,
Expand All @@ -533,6 +536,7 @@ private fun YearCalendar(
yearFooter: (@Composable ColumnScope.(CalendarYear) -> Unit)?,
yearContainer: (@Composable LazyItemScope.(CalendarYear, container: @Composable () -> Unit) -> Unit)?,
) {
require(monthColumns in 1..12) { "Param `monthColumns` must be 1..12" }
if (isHorizontal) {
LazyRow(
modifier = modifier,
Expand All @@ -545,7 +549,7 @@ private fun YearCalendar(
YearCalendarMonths(
yearCount = state.calendarInfo.indexCount,
yearData = { offset -> state.store[offset] },
columns = columns,
monthColumns = monthColumns,
monthVerticalSpacing = monthVerticalSpacing,
monthHorizontalSpacing = monthHorizontalSpacing,
yearBodyContentPadding = yearBodyContentPadding,
Expand Down Expand Up @@ -574,7 +578,7 @@ private fun YearCalendar(
YearCalendarMonths(
yearCount = state.calendarInfo.indexCount,
yearData = { offset -> state.store[offset] },
columns = columns,
monthColumns = monthColumns,
monthVerticalSpacing = monthVerticalSpacing,
monthHorizontalSpacing = monthHorizontalSpacing,
yearBodyContentPadding = yearBodyContentPadding,
Expand Down
Loading
Loading