Add min/max week (#116)

* Add min/max week

* Update detekt

* Add documentation

* Update github actions

Author: boguszpawlowski

.github/workflows/check.yml

@@ -1,16 +1,17 @@
 name: Check
 on:
   pull_request:
+
 jobs:
   detekt:
     name: Detekt Check
     runs-on: ubuntu-latest
     steps:
       - name: Checkout Repository
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
 
       - name: Cache Gradle
-        uses: actions/cache@v2
+        uses: actions/cache@v4
         with:
           path: |
             ~/.gradle/caches/
@@ -29,15 +30,16 @@ jobs:
 
       - name: Stop Gradle
         run: ./gradlew --stop
+
   unit-tests:
     name: Unit Tests
     runs-on: ubuntu-latest
     steps:
       - name: Checkout Repository
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
 
       - name: Cache Gradle
-        uses: actions/cache@v2
+        uses: actions/cache@v4
         with:
           path: |
             ~/.gradle/caches/
@@ -56,16 +58,17 @@ jobs:
 
       - name: Stop Gradle
         run: ./gradlew --stop
+
   ui-tests:
     name: FTL UI Tests
     needs: [unit-tests, detekt]
     runs-on: ubuntu-latest
     steps:
       - name: Checkout Repository
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
 
       - name: Cache Gradle
-        uses: actions/cache@v2
+        uses: actions/cache@v4
         with:
           path: |
             ~/.gradle/caches/
@@ -88,7 +91,7 @@ jobs:
           credentials_json: ${{ secrets.GCLOUD_AUTH_KEY }}
 
       - name: Set up Cloud SDK
-        uses: google-github-actions/setup-gcloud@v0
+        uses: google-github-actions/setup-gcloud@v2
 
       - name: Use gcloud CLI
         run: gcloud info
@@ -101,15 +104,16 @@ jobs:
 
       - name: Stop Gradle
         run: ./gradlew --stop
+
   compatibility-check:
     name: Compatibility Check
     runs-on: ubuntu-latest
     steps:
       - name: Checkout Repository
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
 
       - name: Cache Gradle
-        uses: actions/cache@v2
+        uses: actions/cache@v4
         with:
           path: |
             ~/.gradle/caches/

.github/workflows/publish-snapshot.yml

@@ -1,4 +1,4 @@
-name: Publish Snaphot
+name: Publish Snapshot
 on:
   workflow_dispatch:
   push:
@@ -7,16 +7,16 @@ on:
 
 jobs:
   deploy-maven-snapshot:
-    name: Deploy To Maven Snaphot
+    name: Deploy To Maven Snapshot
     runs-on: ubuntu-latest
     steps:
       - name: Checkout Repository
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
         with:
-          fetch-depth: '0'
+          fetch-tags: true
 
       - name: Cache Gradle
-        uses: actions/cache@v2
+        uses: actions/cache@v4
         with:
           path: |
             ~/.gradle/caches/

.github/workflows/publish.yml

@@ -11,12 +11,12 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout Repository
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
         with:
-          fetch-depth: '0'
+          fetch-tags: true
 
       - name: Cache Gradle
-        uses: actions/cache@v2
+        uses: actions/cache@v4
         with:
           path: |
             ~/.gradle/caches/

README.md

@@ -20,24 +20,16 @@ Library is available on Maven Central repository.
 ```
 Snapshots are available on [Sonatype’s snapshots repository](https://s01.oss.sonatype.org/content/repositories/snapshots/io/github/boguszpawlowski/composecalendar/).
 
-## Compose versions
-| Compose Version 	 | Compose Calendar Version 	 |
-|-------------------|----------------------------|
-| 1.0.0           	 | 0.3.0                    	 |
-| 1.1.0           	 | 0.5.1                    	 |
-| 1.2.0           	 | 0.6.0                    	 |
-| 1.2.1           	 | 1.0.2                    	 |
-| 1.3.1           	 | 1.1.0                    	 |
-
 ## Supported features
 - Selection (single, multiple or a range of days)
-- Every day as first day of week
+- Chose day as first day of week
 - Showing/hiding adjacent months
 - Month and week headers
 - Customizable month container
 - Fully customizable day content
 - Horizontal swipe for changing a current month
 - Month / Week mode
+- Min / Max Month (or Week) 
 
 ## Basic Usage
 
@@ -144,6 +136,10 @@ Apart from rendering your own components inside the calendar, you can modify it
 - `showAdjacentMonths` - whenever to render days from adjacent months. Defaults to `true`.
 - `firstDayOfWeek` - you can pass the `DayOfWeek` which you want you week to start with. It defaults to the first day of week of the `Locale.default()`.
 - `horizontalScrollEnabled` - a Boolean flag which enables month to be changed by a horizontal swipe. Defaults to `true`.
+- `minMonth` - a `YearMonth` object representing the minimum month that can be shown in the calendar. By default there is no minimum month.
+- `maxMonth` - a `YearMonth` object representing the maximum month that can be shown in the calendar. By default there is no maximum month.
+
+> :exclamation: You cannot set `minMonth` to be lower than `maxMonth` and vice versa. If you do so, the calendar state won't change.
 
 Apart from this, `Calendar` you can pass a `Modifier` object like in any other composable.
 
@@ -213,6 +209,9 @@ Selection modes are represented by `SelectionMode` enum, with following values:
 - `Period` - selectable period - implemented by `start` and `end` dates. - selection will contain all dates between start and the end date.
 This implementation of SelectionState also allows for handling side-effects and vetoing the state change via `confirmSelectionChange` callback.
 
+## Week Calendar
+Apart from the default calendar, there is also a week calendar, which shows a single week at a time. It can be used in the same way as the default calendar, and has the same customization options.
+
 ## KotlinX DateTime
 As the core of the library is built on `java.time` library, on Android it requires to use [core libary desugaring](https://developer.android.com/studio/write/java8-support) to be able to access it's API.
 As a result it's features may be unavailable to some project built around different date-time libraries (e.g. kotlinx-datetime). Although the project wont be migrating from `java.time`, as it's the best suited for it, there is a separate `kotlinx-datetime` artifact for those who need to use the library from a codebase based on it. It doesn't consist of a separate version of `ComposeCalendar` features, but offers a small bunch of utilities, that will enable you to create your own wrapper, as briefly presented in `KotlinDateTimeSample`. If the provided functionality, doesn't match your use-case, please submit an issue.

buildSrc/src/main/kotlin/Dependencies.kt

@@ -84,7 +84,7 @@ object Material {
 }
 
 object DetektLib {
-  const val Version = "1.21.0"
+  const val Version = "1.23.4"
 
   const val PluginId = "io.gitlab.arturbosch.detekt"
   const val Plugin = "io.gitlab.arturbosch.detekt:detekt-gradle-plugin:$Version"

library/api/library.api

@@ -76,8 +76,8 @@ public final class io/github/boguszpawlowski/composecalendar/WeekCalendarKt {
 	public static final fun SelectableWeekCalendar (Landroidx/compose/ui/Modifier;Ljava/time/DayOfWeek;Ljava/time/LocalDate;ZZLio/github/boguszpawlowski/composecalendar/WeekCalendarState;Lkotlin/jvm/functions/Function4;Lkotlin/jvm/functions/Function4;Lkotlin/jvm/functions/Function4;Landroidx/compose/runtime/Composer;II)V
 	public static final fun StaticWeekCalendar (Landroidx/compose/ui/Modifier;Ljava/time/DayOfWeek;Ljava/time/LocalDate;ZLio/github/boguszpawlowski/composecalendar/WeekCalendarState;ZLkotlin/jvm/functions/Function4;Lkotlin/jvm/functions/Function4;Lkotlin/jvm/functions/Function4;Landroidx/compose/runtime/Composer;II)V
 	public static final fun WeekCalendar (Lio/github/boguszpawlowski/composecalendar/WeekCalendarState;Landroidx/compose/ui/Modifier;Ljava/time/LocalDate;Ljava/time/DayOfWeek;ZZLkotlin/jvm/functions/Function4;Lkotlin/jvm/functions/Function4;Lkotlin/jvm/functions/Function4;Landroidx/compose/runtime/Composer;II)V
-	public static final fun rememberSelectableWeekCalendarState (Ljava/time/DayOfWeek;Lio/github/boguszpawlowski/composecalendar/week/Week;Ljava/util/List;Lio/github/boguszpawlowski/composecalendar/selection/SelectionMode;Lkotlin/jvm/functions/Function1;Lio/github/boguszpawlowski/composecalendar/header/WeekState;Lio/github/boguszpawlowski/composecalendar/selection/DynamicSelectionState;Landroidx/compose/runtime/Composer;II)Lio/github/boguszpawlowski/composecalendar/WeekCalendarState;
-	public static final fun rememberWeekCalendarState (Ljava/time/DayOfWeek;Lio/github/boguszpawlowski/composecalendar/week/Week;Lio/github/boguszpawlowski/composecalendar/header/WeekState;Landroidx/compose/runtime/Composer;II)Lio/github/boguszpawlowski/composecalendar/WeekCalendarState;
+	public static final fun rememberSelectableWeekCalendarState (Ljava/time/DayOfWeek;Lio/github/boguszpawlowski/composecalendar/week/Week;Lio/github/boguszpawlowski/composecalendar/week/Week;Lio/github/boguszpawlowski/composecalendar/week/Week;Ljava/util/List;Lio/github/boguszpawlowski/composecalendar/selection/SelectionMode;Lkotlin/jvm/functions/Function1;Lio/github/boguszpawlowski/composecalendar/header/WeekState;Lio/github/boguszpawlowski/composecalendar/selection/DynamicSelectionState;Landroidx/compose/runtime/Composer;II)Lio/github/boguszpawlowski/composecalendar/WeekCalendarState;
+	public static final fun rememberWeekCalendarState (Ljava/time/DayOfWeek;Lio/github/boguszpawlowski/composecalendar/week/Week;Lio/github/boguszpawlowski/composecalendar/week/Week;Lio/github/boguszpawlowski/composecalendar/week/Week;Lio/github/boguszpawlowski/composecalendar/header/WeekState;Landroidx/compose/runtime/Composer;II)Lio/github/boguszpawlowski/composecalendar/WeekCalendarState;
 }
 
 public final class io/github/boguszpawlowski/composecalendar/WeekCalendarState {
@@ -159,15 +159,19 @@ public final class io/github/boguszpawlowski/composecalendar/header/MonthStateKt
 public abstract interface class io/github/boguszpawlowski/composecalendar/header/WeekState {
 	public static final field Companion Lio/github/boguszpawlowski/composecalendar/header/WeekState$Companion;
 	public abstract fun getCurrentWeek ()Lio/github/boguszpawlowski/composecalendar/week/Week;
+	public abstract fun getMaxWeek ()Lio/github/boguszpawlowski/composecalendar/week/Week;
+	public abstract fun getMinWeek ()Lio/github/boguszpawlowski/composecalendar/week/Week;
 	public abstract fun setCurrentWeek (Lio/github/boguszpawlowski/composecalendar/week/Week;)V
+	public abstract fun setMaxWeek (Lio/github/boguszpawlowski/composecalendar/week/Week;)V
+	public abstract fun setMinWeek (Lio/github/boguszpawlowski/composecalendar/week/Week;)V
 }
 
 public final class io/github/boguszpawlowski/composecalendar/header/WeekState$Companion {
 	public final fun Saver ()Landroidx/compose/runtime/saveable/Saver;
 }
 
 public final class io/github/boguszpawlowski/composecalendar/header/WeekStateKt {
-	public static final fun WeekState (Lio/github/boguszpawlowski/composecalendar/week/Week;)Lio/github/boguszpawlowski/composecalendar/header/WeekState;
+	public static final fun WeekState (Lio/github/boguszpawlowski/composecalendar/week/Week;Lio/github/boguszpawlowski/composecalendar/week/Week;Lio/github/boguszpawlowski/composecalendar/week/Week;)Lio/github/boguszpawlowski/composecalendar/header/WeekState;
 }
 
 public final class io/github/boguszpawlowski/composecalendar/selection/DynamicSelectionHandler {
@@ -223,6 +227,7 @@ public final class io/github/boguszpawlowski/composecalendar/week/Week {
 	public static final field $stable I
 	public static final field Companion Lio/github/boguszpawlowski/composecalendar/week/Week$Companion;
 	public fun <init> (Ljava/util/List;)V
+	public final fun compareTo (Lio/github/boguszpawlowski/composecalendar/week/Week;)I
 	public final fun component1 ()Ljava/util/List;
 	public final fun copy (Ljava/util/List;)Lio/github/boguszpawlowski/composecalendar/week/Week;
 	public static synthetic fun copy$default (Lio/github/boguszpawlowski/composecalendar/week/Week;Ljava/util/List;ILjava/lang/Object;)Lio/github/boguszpawlowski/composecalendar/week/Week;
@@ -234,6 +239,7 @@ public final class io/github/boguszpawlowski/composecalendar/week/Week {
 	public final fun getYearMonth ()Ljava/time/YearMonth;
 	public fun hashCode ()I
 	public final fun inc ()Lio/github/boguszpawlowski/composecalendar/week/Week;
+	public final fun minusWeeks (J)Lio/github/boguszpawlowski/composecalendar/week/Week;
 	public final fun plusWeeks (J)Lio/github/boguszpawlowski/composecalendar/week/Week;
 	public fun toString ()Ljava/lang/String;
 }
@@ -243,3 +249,7 @@ public final class io/github/boguszpawlowski/composecalendar/week/Week$Companion
 	public static synthetic fun now$default (Lio/github/boguszpawlowski/composecalendar/week/Week$Companion;Ljava/time/DayOfWeek;ILjava/lang/Object;)Lio/github/boguszpawlowski/composecalendar/week/Week;
 }
 
+public final class io/github/boguszpawlowski/composecalendar/week/WeekKt {
+	public static final fun between (Ljava/time/temporal/ChronoUnit;Lio/github/boguszpawlowski/composecalendar/week/Week;Lio/github/boguszpawlowski/composecalendar/week/Week;)I
+}
+

library/src/main/java/io/github/boguszpawlowski/composecalendar/Calendar.kt

@@ -231,12 +231,14 @@ public fun <T : SelectionState> Calendar(
  * @param initialSelection initial selection of the composable
  * @param initialSelectionMode initial mode of the selection
  * @param confirmSelectionChange callback for optional side-effects handling and vetoing the state change
+ * @param minMonth first month that can be shown
+ * @param maxMonth last month that can be shown
  */
 @Composable
 public fun rememberSelectableCalendarState(
   initialMonth: YearMonth = YearMonth.now(),
-  minMonth: YearMonth = initialMonth.minusMonths(DefaultCalendarMonthRange),
-  maxMonth: YearMonth = initialMonth.plusMonths(DefaultCalendarMonthRange),
+  minMonth: YearMonth = initialMonth.minusMonths(DefaultCalendarPagerRange),
+  maxMonth: YearMonth = initialMonth.plusMonths(DefaultCalendarPagerRange),
   initialSelection: List<LocalDate> = emptyList(),
   initialSelectionMode: SelectionMode = SelectionMode.Single,
   confirmSelectionChange: (newValue: List<LocalDate>) -> Boolean = { true },
@@ -258,12 +260,14 @@ public fun rememberSelectableCalendarState(
  * Helper function for providing a [CalendarState] implementation without a selection mechanism.
  *
  * @param initialMonth initially rendered month
+ * @param minMonth first month that can be shown
+ * @param maxMonth last month that can be shown
  */
 @Composable
 public fun rememberCalendarState(
   initialMonth: YearMonth = YearMonth.now(),
-  minMonth: YearMonth = initialMonth.minusMonths(DefaultCalendarMonthRange),
-  maxMonth: YearMonth = initialMonth.plusMonths(DefaultCalendarMonthRange),
+  minMonth: YearMonth = initialMonth.minusMonths(DefaultCalendarPagerRange),
+  maxMonth: YearMonth = initialMonth.plusMonths(DefaultCalendarPagerRange),
   monthState: MonthState = rememberSaveable(saver = MonthState.Saver()) {
     MonthState(
       initialMonth = initialMonth,
@@ -273,4 +277,4 @@ public fun rememberCalendarState(
   },
 ): CalendarState<EmptySelectionState> = remember { CalendarState(monthState, EmptySelectionState) }
 
-internal const val DefaultCalendarMonthRange = 10000L
+internal const val DefaultCalendarPagerRange = 10_000L

library/src/main/java/io/github/boguszpawlowski/composecalendar/WeekCalendar.kt

@@ -207,16 +207,24 @@ public fun <T : SelectionState> WeekCalendar(
  * @param initialSelection initial selection of the composable
  * @param initialSelectionMode initial mode of the selection
  * @param confirmSelectionChange callback for optional side-effects handling and vetoing the state change
+ * @param minWeek first week that can be shown
+ * @param maxWeek last week that can be shown
  */
 @Composable
 public fun rememberSelectableWeekCalendarState(
   firstDayOfWeek: DayOfWeek = WeekFields.of(Locale.getDefault()).firstDayOfWeek,
   initialWeek: Week = Week.now(firstDayOfWeek),
+  minWeek: Week = initialWeek.minusWeeks(DefaultCalendarPagerRange),
+  maxWeek: Week = initialWeek.plusWeeks(DefaultCalendarPagerRange),
   initialSelection: List<LocalDate> = emptyList(),
   initialSelectionMode: SelectionMode = SelectionMode.Single,
   confirmSelectionChange: (newValue: List<LocalDate>) -> Boolean = { true },
   weekState: WeekState = rememberSaveable(saver = WeekState.Saver()) {
-    WeekState(initialWeek = initialWeek)
+    WeekState(
+      initialWeek = initialWeek,
+      minWeek = minWeek,
+      maxWeek = maxWeek,
+    )
   },
   selectionState: DynamicSelectionState = rememberSaveable(
     saver = DynamicSelectionState.Saver(confirmSelectionChange),
@@ -231,13 +239,21 @@ public fun rememberSelectableWeekCalendarState(
  *
  * @param firstDayOfWeek first day of a week, defaults to current locale's
  * @param initialWeek initially rendered week
+ * @param minWeek first week that can be shown
+ * @param maxWeek last week that can be shown
  */
 @Composable
 public fun rememberWeekCalendarState(
   firstDayOfWeek: DayOfWeek = WeekFields.of(Locale.getDefault()).firstDayOfWeek,
   initialWeek: Week = Week.now(firstDayOfWeek),
+  minWeek: Week = initialWeek.minusWeeks(DefaultCalendarPagerRange),
+  maxWeek: Week = initialWeek.plusWeeks(DefaultCalendarPagerRange),
   weekState: WeekState = rememberSaveable(saver = WeekState.Saver()) {
-    WeekState(initialWeek = initialWeek)
+    WeekState(
+      initialWeek = initialWeek,
+      minWeek = minWeek,
+      maxWeek = maxWeek,
+    )
   },
 ): WeekCalendarState<EmptySelectionState> =
   remember { WeekCalendarState(weekState, EmptySelectionState) }