refactor: Set Compose modifier as first optional parameter (#210)

For Jetpack Compose components, update parameters order so that mandatory parameters come before modifier parameters.
mirego · Jan 4, 2024 · d633db0 · d633db0
1 parent 570ea02
commit d633db0
Show file tree

Hide file tree

Showing 18 changed files with 37 additions and 33 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,6 +6,10 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
 ## Upcoming
 
+### Breaking Changes
+
+- [VMD] Change parameters order for some Compose components
+
 ### Updates
 
 - Gradle to `8.4`

diff --git a/trikot-viewmodels-declarative/compose/api/compose.api b/trikot-viewmodels-declarative/compose/api/compose.api
diff --git a/...e/src/main/kotlin/com/mirego/trikot/viewmodels/declarative/compose/viewmodel/VMDButton.kt b/...e/src/main/kotlin/com/mirego/trikot/viewmodels/declarative/compose/viewmodel/VMDButton.kt
@@ -20,8 +20,8 @@ import com.mirego.trikot.viewmodels.declarative.content.VMDContent
 
 @Composable
 fun <C : VMDContent> VMDButton(
-    modifier: Modifier = Modifier,
     viewModel: VMDButtonViewModel<C>,
+    modifier: Modifier = Modifier,
     contentAlignment: Alignment = Alignment.Center,
     propagateMinConstraints: Boolean = false,
     interactionSource: MutableInteractionSource = remember { MutableInteractionSource() },

diff --git a/...src/main/kotlin/com/mirego/trikot/viewmodels/declarative/compose/viewmodel/VMDCheckbox.kt b/...src/main/kotlin/com/mirego/trikot/viewmodels/declarative/compose/viewmodel/VMDCheckbox.kt
@@ -22,9 +22,9 @@ import com.mirego.trikot.viewmodels.declarative.content.VMDNoContent
 
 @Composable
 fun VMDCheckbox(
+    viewModel: VMDToggleViewModel<VMDNoContent>,
     modifier: Modifier = Modifier,
     componentModifier: Modifier = Modifier,
-    viewModel: VMDToggleViewModel<VMDNoContent>,
     interactionSource: MutableInteractionSource = remember { MutableInteractionSource() },
     colors: CheckboxColors = CheckboxDefaults.colors()
 ) {

diff --git a/...om/mirego/trikot/viewmodels/declarative/compose/viewmodel/VMDCircularProgressIndicator.kt b/...om/mirego/trikot/viewmodels/declarative/compose/viewmodel/VMDCircularProgressIndicator.kt
@@ -20,8 +20,8 @@ import com.mirego.trikot.viewmodels.declarative.compose.extensions.observeAsStat
 
 @Composable
 fun VMDCircularProgressIndicator(
-    modifier: Modifier = Modifier,
     viewModel: VMDProgressViewModel,
+    modifier: Modifier = Modifier,
     color: Color = MaterialTheme.colors.primary,
     strokeWidth: Dp = ProgressIndicatorDefaults.StrokeWidth,
     backgroundColor: Color = Color.Transparent,

diff --git a/.../kotlin/com/mirego/trikot/viewmodels/declarative/compose/viewmodel/VMDLabeledComponent.kt b/.../kotlin/com/mirego/trikot/viewmodels/declarative/compose/viewmodel/VMDLabeledComponent.kt
@@ -9,9 +9,9 @@ import androidx.compose.ui.Modifier
 
 @Composable
 fun VMDLabeledComponent(
-    modifier: Modifier = Modifier,
     label: @Composable RowScope.() -> Unit,
-    content: @Composable RowScope.() -> Unit
+    content: @Composable RowScope.() -> Unit,
+    modifier: Modifier = Modifier
 ) {
     Row(
         modifier = modifier,

diff --git a/...c/main/kotlin/com/mirego/trikot/viewmodels/declarative/compose/viewmodel/VMDLazyColumn.kt b/...c/main/kotlin/com/mirego/trikot/viewmodels/declarative/compose/viewmodel/VMDLazyColumn.kt
@@ -21,8 +21,8 @@ import com.mirego.trikot.viewmodels.declarative.content.VMDIdentifiableContent
 
 @Composable
 fun <C : VMDIdentifiableContent> VMDLazyColumn(
-    modifier: Modifier = Modifier,
     viewModel: VMDListViewModel<C>,
+    modifier: Modifier = Modifier,
     state: LazyListState = rememberLazyListState(),
     contentPadding: PaddingValues = PaddingValues(0.dp),
     reverseLayout: Boolean = false,

diff --git a/.../src/main/kotlin/com/mirego/trikot/viewmodels/declarative/compose/viewmodel/VMDLazyRow.kt b/.../src/main/kotlin/com/mirego/trikot/viewmodels/declarative/compose/viewmodel/VMDLazyRow.kt
@@ -21,8 +21,8 @@ import com.mirego.trikot.viewmodels.declarative.content.VMDIdentifiableContent
 
 @Composable
 fun <C : VMDIdentifiableContent> VMDLazyRow(
-    modifier: Modifier = Modifier,
     viewModel: VMDListViewModel<C>,
+    modifier: Modifier = Modifier,
     state: LazyListState = rememberLazyListState(),
     contentPadding: PaddingValues = PaddingValues(0.dp),
     reverseLayout: Boolean = false,

diff --git a/.../com/mirego/trikot/viewmodels/declarative/compose/viewmodel/VMDLinearProgressIndicator.kt b/.../com/mirego/trikot/viewmodels/declarative/compose/viewmodel/VMDLinearProgressIndicator.kt
@@ -19,8 +19,8 @@ import com.mirego.trikot.viewmodels.declarative.compose.extensions.observeAsStat
 
 @Composable
 fun VMDLinearProgressIndicator(
-    modifier: Modifier = Modifier,
     viewModel: VMDProgressViewModel,
+    modifier: Modifier = Modifier,
     color: Color = MaterialTheme.colors.primary,
     backgroundColor: Color = color.copy(alpha = ProgressIndicatorDefaults.IndicatorBackgroundOpacity)
 ) {

diff --git a/...ose/src/main/kotlin/com/mirego/trikot/viewmodels/declarative/compose/viewmodel/VMDList.kt b/...ose/src/main/kotlin/com/mirego/trikot/viewmodels/declarative/compose/viewmodel/VMDList.kt
@@ -24,8 +24,8 @@ import com.mirego.trikot.viewmodels.declarative.content.VMDIdentifiableContent
 @Deprecated("Use either VMDLazyColumn instead")
 @Composable
 fun <C : VMDIdentifiableContent> VMDList(
-    modifier: Modifier = Modifier,
     viewModel: VMDListViewModel<C>,
+    modifier: Modifier = Modifier,
     state: LazyListState = rememberLazyListState(),
     contentPadding: PaddingValues = PaddingValues(0.dp),
     reverseLayout: Boolean = false,

diff --git a/...e/src/main/kotlin/com/mirego/trikot/viewmodels/declarative/compose/viewmodel/VMDSwitch.kt b/...e/src/main/kotlin/com/mirego/trikot/viewmodels/declarative/compose/viewmodel/VMDSwitch.kt
@@ -22,9 +22,9 @@ import com.mirego.trikot.viewmodels.declarative.content.VMDNoContent
 
 @Composable
 fun VMDSwitch(
+    viewModel: VMDToggleViewModel<VMDNoContent>,
     modifier: Modifier = Modifier,
     componentModifier: Modifier = Modifier,
-    viewModel: VMDToggleViewModel<VMDNoContent>,
     interactionSource: MutableInteractionSource = remember { MutableInteractionSource() },
     colors: SwitchColors = SwitchDefaults.colors()
 ) {

diff --git a/...ose/src/main/kotlin/com/mirego/trikot/viewmodels/declarative/compose/viewmodel/VMDText.kt b/...ose/src/main/kotlin/com/mirego/trikot/viewmodels/declarative/compose/viewmodel/VMDText.kt
@@ -22,8 +22,8 @@ import com.mirego.trikot.viewmodels.declarative.compose.extensions.observeAsStat
 
 @Composable
 fun VMDText(
-    modifier: Modifier = Modifier,
     viewModel: VMDTextViewModel,
+    modifier: Modifier = Modifier,
     color: Color = Color.Unspecified,
     fontSize: TextUnit = TextUnit.Unspecified,
     fontStyle: FontStyle? = null,

diff --git a/...rc/main/kotlin/com/mirego/trikot/viewmodels/declarative/compose/viewmodel/VMDTextField.kt b/...rc/main/kotlin/com/mirego/trikot/viewmodels/declarative/compose/viewmodel/VMDTextField.kt
@@ -25,8 +25,8 @@ import com.mirego.trikot.viewmodels.declarative.compose.viewmodel.internal.Forma
 
 @Composable
 fun VMDTextField(
-    modifier: Modifier = Modifier,
     viewModel: VMDTextFieldViewModel,
+    modifier: Modifier = Modifier,
     textStyle: TextStyle = LocalTextStyle.current,
     placeHolderStyle: TextStyle = LocalTextStyle.current,
     label: @Composable (() -> Unit)? = null,

diff --git a/...trikot/viewmodels/declarative/compose/viewmodel/material3/VMDCircularProgressIndicator.kt b/...trikot/viewmodels/declarative/compose/viewmodel/material3/VMDCircularProgressIndicator.kt
@@ -20,8 +20,8 @@ import com.mirego.trikot.viewmodels.declarative.compose.extensions.observeAsStat
 
 @Composable
 fun VMDCircularProgressIndicator(
-    modifier: Modifier = Modifier,
     viewModel: VMDProgressViewModel,
+    modifier: Modifier = Modifier,
     color: Color = MaterialTheme.colorScheme.primary,
     strokeWidth: Dp = ProgressIndicatorDefaults.CircularStrokeWidth,
     trackColor: Color = ProgressIndicatorDefaults.circularTrackColor,

diff --git a/...o/trikot/viewmodels/declarative/compose/viewmodel/material3/VMDLinearProgressIndicator.kt b/...o/trikot/viewmodels/declarative/compose/viewmodel/material3/VMDLinearProgressIndicator.kt
@@ -18,8 +18,8 @@ import com.mirego.trikot.viewmodels.declarative.compose.extensions.observeAsStat
 
 @Composable
 fun VMDLinearProgressIndicator(
-    modifier: Modifier = Modifier,
     viewModel: VMDProgressViewModel,
+    modifier: Modifier = Modifier,
     color: Color = ProgressIndicatorDefaults.linearColor,
     trackColor: Color = ProgressIndicatorDefaults.linearTrackColor
 ) {

diff --git a/.../kotlin/com/mirego/trikot/viewmodels/declarative/compose/viewmodel/material3/VMDSwitch.kt b/.../kotlin/com/mirego/trikot/viewmodels/declarative/compose/viewmodel/material3/VMDSwitch.kt
@@ -23,9 +23,9 @@ import com.mirego.trikot.viewmodels.declarative.content.VMDNoContent
 
 @Composable
 fun VMDSwitch(
+    viewModel: VMDToggleViewModel<VMDNoContent>,
     modifier: Modifier = Modifier,
     componentModifier: Modifier = Modifier,
-    viewModel: VMDToggleViewModel<VMDNoContent>,
     interactionSource: MutableInteractionSource = remember { MutableInteractionSource() },
     colors: SwitchColors = SwitchDefaults.colors()
 ) {

diff --git a/...in/kotlin/com/mirego/trikot/viewmodels/declarative/compose/viewmodel/material3/VMDText.kt b/...in/kotlin/com/mirego/trikot/viewmodels/declarative/compose/viewmodel/material3/VMDText.kt
@@ -22,8 +22,8 @@ import com.mirego.trikot.viewmodels.declarative.compose.extensions.observeAsStat
 
 @Composable
 fun VMDText(
-    modifier: Modifier = Modifier,
     viewModel: VMDTextViewModel,
+    modifier: Modifier = Modifier,
     color: Color = Color.Unspecified,
     fontSize: TextUnit = TextUnit.Unspecified,
     fontStyle: FontStyle? = null,

diff --git a/...tlin/com/mirego/trikot/viewmodels/declarative/compose/viewmodel/material3/VMDTextField.kt b/...tlin/com/mirego/trikot/viewmodels/declarative/compose/viewmodel/material3/VMDTextField.kt
@@ -25,8 +25,8 @@ import com.mirego.trikot.viewmodels.declarative.compose.viewmodel.internal.Forma
 
 @Composable
 fun VMDTextField(
-    modifier: Modifier = Modifier,
     viewModel: VMDTextFieldViewModel,
+    modifier: Modifier = Modifier,
     textStyle: TextStyle = LocalTextStyle.current,
     placeHolderStyle: TextStyle = LocalTextStyle.current,
     label: @Composable (() -> Unit)? = null,