(All) Cleanup

- Fixes imports
- Adds missing kdocs

Author: maxkeppeler

calendar/src/main/java/com/maxkeppeler/sheets/calendar/CalendarView.kt

@@ -93,10 +93,6 @@ fun CalendarView(
                 yearListState = yearListState,
                 mode = calendarState.mode,
                 cells = calendarState.cells,
-                nextDisabled = calendarState.isNextDisabled,
-                prevDisabled = calendarState.isPrevDisabled,
-                onNext = calendarState::onNext,
-                onPrev = calendarState::onPrevious,
                 onCalendarView = {
                     setupCalendarSelectionView(
                         config = config,

calendar/src/main/java/com/maxkeppeler/sheets/calendar/views/CalendarBaseSelectionComponent.kt

@@ -13,26 +13,20 @@
  *  See the License for the specific language governing permissions and
  *  limitations under the License.
  */
-@file:OptIn(ExperimentalSnapperApi::class, ExperimentalMaterialApi::class)
+@file:OptIn(ExperimentalSnapperApi::class)
 
 package com.maxkeppeler.sheets.calendar.views
 
-import androidx.compose.foundation.gestures.Orientation
 import androidx.compose.foundation.layout.*
 import androidx.compose.foundation.lazy.LazyListScope
 import androidx.compose.foundation.lazy.LazyListState
 import androidx.compose.foundation.lazy.LazyRow
 import androidx.compose.foundation.lazy.grid.GridCells
 import androidx.compose.foundation.lazy.grid.LazyGridScope
 import androidx.compose.foundation.lazy.grid.LazyVerticalGrid
-import androidx.compose.material.ExperimentalMaterialApi
-import androidx.compose.material.FractionalThreshold
-import androidx.compose.material.rememberSwipeableState
-import androidx.compose.material.swipeable
 import androidx.compose.material3.MaterialTheme
 import androidx.compose.material3.Text
 import androidx.compose.runtime.Composable
-import androidx.compose.runtime.LaunchedEffect
 import androidx.compose.ui.Alignment
 import androidx.compose.ui.Modifier
 import androidx.compose.ui.draw.drawWithContent
@@ -44,7 +38,6 @@ import androidx.compose.ui.res.dimensionResource
 import androidx.compose.ui.res.stringResource
 import com.maxkeppeler.sheets.calendar.R
 import com.maxkeppeler.sheets.calendar.models.CalendarDisplayMode
-import com.maxkeppeler.sheets.calendar.models.CalendarSwipeAction
 import dev.chrisbanes.snapper.ExperimentalSnapperApi
 import dev.chrisbanes.snapper.SnapOffsets
 import dev.chrisbanes.snapper.rememberSnapperFlingBehavior
@@ -56,10 +49,6 @@ import com.maxkeppeler.sheets.core.R as RC
  * @param yearListState The state of the year list selection view.
  * @param cells The amount of cells / columns that are used for the calendar grid view.
  * @param mode The display mode of the dialog.
- * @param nextDisabled Whenever the navigation to the next period is disabled.
- * @param prevDisabled Whenever the navigation to the previous period is disabled.
- * @param onPrev The listener that is invoked when the navigation to the previous period is invoked.
- * @param onNext The listener that is invoked when the navigation to the next period is invoked.
  * @param onCalendarView The content that will be displayed if the [CalendarDisplayMode] is in [CalendarDisplayMode.CALENDAR].
  * @param onMonthView The content that will be displayed if the [CalendarDisplayMode] is in [CalendarDisplayMode.MONTH].
  * @param onYearView The content that will be displayed if the [CalendarDisplayMode] is in [CalendarDisplayMode.YEAR].
@@ -70,48 +59,15 @@ internal fun CalendarBaseSelectionComponent(
     yearListState: LazyListState,
     cells: Int,
     mode: CalendarDisplayMode,
-    nextDisabled: Boolean,
-    prevDisabled: Boolean,
-    onPrev: () -> Unit,
-    onNext: () -> Unit,
     onCalendarView: LazyGridScope.() -> Unit,
     onMonthView: LazyGridScope.() -> Unit,
     onYearView: LazyListScope.() -> Unit
 ) {
 
-    val swipeableState = rememberSwipeableState(CalendarSwipeAction.NONE)
-    val anchors = mapOf(
-        0f to CalendarSwipeAction.NEXT,
-        150f to CalendarSwipeAction.NONE,
-        300f to CalendarSwipeAction.PREV
-    )
-
-    when (swipeableState.currentValue) {
-        CalendarSwipeAction.NEXT -> {
-            LaunchedEffect(swipeableState.currentValue) {
-                if (!nextDisabled) onNext()
-                swipeableState.snapTo(CalendarSwipeAction.NONE)
-            }
-        }
-        CalendarSwipeAction.PREV -> {
-            LaunchedEffect(swipeableState.currentValue) {
-                if (!prevDisabled) onPrev()
-                swipeableState.snapTo(CalendarSwipeAction.NONE)
-            }
-        }
-        CalendarSwipeAction.NONE -> Unit
-    }
-
     val baseModifier = modifier
         .fillMaxWidth()
         .padding(top = dimensionResource(RC.dimen.scd_normal_100))
 
-    val gridDateModifier = baseModifier.swipeable(
-        state = swipeableState,
-        anchors = anchors,
-        thresholds = { _, _ -> FractionalThreshold(0.5f) },
-        orientation = Orientation.Horizontal
-    )
     val gridYearModifier = baseModifier
         .graphicsLayer { alpha = 0.99F }
         .drawWithContent {
@@ -137,7 +93,7 @@ internal fun CalendarBaseSelectionComponent(
         CalendarDisplayMode.CALENDAR -> {
             LazyVerticalGrid(
                 columns = GridCells.Fixed(cells),
-                modifier = gridDateModifier,
+                modifier = baseModifier,
                 userScrollEnabled = false,
             ) {
                 onCalendarView()

color/src/main/java/com/maxkeppeler/sheets/color/models/MultipleColors.kt

@@ -23,27 +23,76 @@ import androidx.annotation.ColorInt
 import androidx.annotation.ColorRes
 import androidx.core.content.ContextCompat
 
+/**
+ * Holds various colors of a specific type.
+ * @param colorsInt colors as packed color int, AARRGGBB.
+ * @param colorsRes colors as resource references, R.color.the_color.
+ * @param colorsHex color as String value, #RRGGBB or #AARRGGBB.
+ */
 sealed class MultipleColors(
     @ColorInt private var colorsInt: Array<Int>? = null,
     @ColorRes private var colorsRes: Array<Int>? = null,
     private var colorsHex: Array<String>? = null,
 ) {
 
+    /**
+     * Define a variety of color integers.
+     */
     class ColorsRes : MultipleColors {
+
+        /**
+         * Define dynamic amount of colors.
+         * @param colors The color integers
+         */
         constructor(@ColorRes vararg colors: Int) : super(colorsRes = colors.toTypedArray())
+
+        /**
+         * Define a list of colors.
+         * @param colors The color integers
+         */
         constructor(@ColorRes colors: List<Int>) : super(colorsRes = colors.toTypedArray())
     }
 
+    /**
+     * Define a variety of color resource references.
+     */
     class ColorsInt : MultipleColors {
+
+        /**
+         * Define dynamic amount of colors.
+         * @param colors The color resource references
+         */
         constructor(@ColorInt vararg colors: Int) : super(colorsInt = colors.toTypedArray())
+
+        /**
+         * Define an array of colors.
+         * @param colors The color resource references
+         */
         constructor(@ColorInt colors: List<Int>) : super(colorsInt = colors.toTypedArray())
     }
 
+    /**
+     * Define a variety of color String values.
+     */
     class ColorsHex : MultipleColors {
+
+        /**
+         * Define dynamic amount of colors.
+         * @param colors The color string values.
+         */
         constructor(vararg colors: String) : super(colorsHex = colors.toList().toTypedArray())
+
+        /**
+         * Define an array of colors.
+         * @param colors The color string values.
+         */
         constructor(colors: List<String>) : super(colorsHex = colors.toTypedArray())
     }
 
+    /**
+     * Resolve the defined colors as color integers.
+     * @param context the Context to resolve the colors.
+     */
     fun getColorsAsInt(context: Context): List<Int> {
         return colorsInt?.toList()
             ?: colorsRes?.map { ContextCompat.getColor(context, it) }

core/src/main/java/com/maxkeppeker/sheets/core/CoreDialog.kt

@@ -13,14 +13,10 @@
  *  See the License for the specific language governing permissions and
  *  limitations under the License.
  */
-@file:OptIn(
-    ExperimentalMaterialApi::class, ExperimentalMaterial3Api::class,
-    ExperimentalMaterialApi::class, ExperimentalMaterialApi::class
-)
+@file:OptIn(ExperimentalMaterial3Api::class)
 
 package com.maxkeppeker.sheets.core
 
-import androidx.compose.material.ExperimentalMaterialApi
 import androidx.compose.material3.ExperimentalMaterial3Api
 import androidx.compose.runtime.Composable
 import androidx.compose.ui.window.DialogProperties
@@ -36,7 +32,6 @@ import com.maxkeppeker.sheets.core.views.base.DialogBase
  * @param header The header to be displayed at the top of the dialog.
  * @param body The body content to be displayed inside the dialog.
  * @param onPositiveValid Listener that is invoked to check if the dialog input is valid.
- * @param onClose Listener that is invoked to indicate that the use-case is done and the view should be closed.
  * @param onPositiveValid If the positive button is valid and therefore enabled.
  */
 @ExperimentalMaterial3Api

core/src/main/java/com/maxkeppeker/sheets/core/models/base/BaseBehaviors.kt

@@ -21,11 +21,20 @@ import kotlinx.coroutines.delay
 import kotlinx.coroutines.launch
 
 /**
- * Base configs for dialog-specific configs.
+ * Base behaviors for the use-case views.
  */
-
 object BaseBehaviors {
 
+    /**
+     * A behavior construct for views to handle the automatic selection process when the button view is disabled.
+     *
+     * @param coroutine The coroutine scope that is used to execute the behavior on.
+     * @param selection The base selection that is used to identify if the behavior should be enabled or not.
+     * @param condition A custom additional condition when the button view is not enabled.
+     * @param onDisableInput Listener that is invoked when the input is disabled as it should be blocked based on the behavior.
+     * @param onSelection Listener that is invoked the automatic selection is executed.
+     * @param onFinished Listener that is invoked when the behavior has ended.
+     */
     fun autoFinish(
         coroutine: CoroutineScope,
         selection: BaseSelection,

core/src/main/java/com/maxkeppeker/sheets/core/models/base/SheetState.kt

@@ -15,7 +15,6 @@
  */
 package com.maxkeppeker.sheets.core.models.base
 
-import android.util.Log
 import androidx.compose.runtime.Composable
 import androidx.compose.runtime.getValue
 import androidx.compose.runtime.mutableStateOf
@@ -43,23 +42,29 @@ class SheetState(
     var embedded by mutableStateOf(embedded)
     var reset by mutableStateOf(false)
 
+    /**
+     * Display the dialog / view.
+     */
     fun show() {
         visible = true
     }
 
+    /**
+     * Hide the dialog / view.
+     */
     fun hide() {
         visible = false
         reset = true
         onDismissRequest?.invoke(this)
         onCloseRequest?.invoke(this)
     }
 
-    private fun invokeReset() {
-        reset = true
+    internal fun clearReset() {
+        reset = false
     }
 
-    fun clearReset() {
-        reset = false
+    private fun invokeReset() {
+        reset = true
     }
 
     // Closed
@@ -70,9 +75,10 @@ class SheetState(
         onCloseRequest?.invoke(this)
     }
 
-    // Use case finished
+    /**
+     * Finish the use-case view.
+     */
     fun finish() {
-        Log.d("SheetState", "finish")
         /*
             We don't want to remove the view itself,
             but inform through the state that the use-case is done.
@@ -87,7 +93,6 @@ class SheetState(
     }
 
     internal fun markAsEmbedded() {
-        Log.d("SheetState", "markAsEmbedded")
         embedded = false
     }
 

core/src/main/java/com/maxkeppeker/sheets/core/utils/BaseUtils.kt

@@ -15,11 +15,6 @@
  */
 package com.maxkeppeker.sheets.core.utils
 
-import androidx.compose.runtime.Stable
-import androidx.compose.ui.Modifier
-import androidx.compose.ui.semantics.semantics
-import androidx.compose.ui.semantics.testTag
-
 /**
  * Joins multiple test tags together into a sequence.
  * @param testTags The test tags you apply to the element.

core/src/main/java/com/maxkeppeker/sheets/core/utils/TestTags.kt

@@ -15,6 +15,9 @@
  */
 package com.maxkeppeker.sheets.core.utils
 
+/**
+ * Test tags that used for the compose UI tests.
+ */
 object TestTags {
 
     /*

core/src/main/java/com/maxkeppeker/sheets/core/views/BaseTypeState.kt

@@ -20,10 +20,16 @@ import androidx.compose.runtime.mutableStateOf
 import androidx.compose.runtime.setValue
 import java.io.Serializable
 
+/**
+ * The base class for the use-case view states.
+ */
 abstract class BaseTypeState : Serializable {
 
     open var inputDisabled by mutableStateOf(false)
 
+    /**
+     * Disables the input for the use-case view state.
+     */
     fun disableInput() {
         inputDisabled = true
     }

info/src/main/java/com/maxkeppeler/sheets/info/InfoDialog.kt

@@ -13,14 +13,10 @@
  *  See the License for the specific language governing permissions and
  *  limitations under the License.
  */
-@file:OptIn(
-    ExperimentalMaterialApi::class, ExperimentalMaterial3Api::class,
-    ExperimentalMaterialApi::class
-)
+@file:OptIn(ExperimentalMaterial3Api::class)
 
 package com.maxkeppeler.sheets.info
 
-import androidx.compose.material.ExperimentalMaterialApi
 import androidx.compose.material3.ExperimentalMaterial3Api
 import androidx.compose.runtime.Composable
 import androidx.compose.ui.window.DialogProperties