[#607] Review: Reorder parameters of OdsLinearProgressIndicator and O…

…dsCircularProgressIndicator
Orange-OpenSource · Sep 8, 2023 · 616f62f · 616f62f
1 parent f602ba7
commit 616f62f
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 7 deletions.
diff --git a/changelog.md b/changelog.md
@@ -24,7 +24,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - \[Lib\] Update `OdsIconButton`, `OdsIconToggleButton`and `OdsIconToggleButtonsRow` APIs ([#599](https://github.com/Orange-OpenSource/ods-android/issues/599))
 - \[Lib\] Update `OdsAlertDialog` API ([#605](https://github.com/Orange-OpenSource/ods-android/issues/605))
 - \[Lib\] Update `OdsFloatingActionButton` and `OdsExtendedFloatingActionButton` APIs ([#611](https://github.com/Orange-OpenSource/ods-android/issues/611))
-- \[Lib\] Update `OdsLinearProgressIndicator` API ([#607](https://github.com/Orange-OpenSource/ods-android/issues/607))
+- \[Lib\] Update `OdsLinearProgressIndicator` and `OdsCircularProgressIndicator` APIs ([#607](https://github.com/Orange-OpenSource/ods-android/issues/607))
 
 ### Fixed
 

diff --git a/...n/java/com/orange/ods/compose/component/progressindicator/OdsCircularProgressIndicator.kt b/...n/java/com/orange/ods/compose/component/progressindicator/OdsCircularProgressIndicator.kt
@@ -33,17 +33,17 @@ import com.orange.ods.extension.orElse
  * @see androidx.compose.material.CircularProgressIndicator
  *
  * @param modifier The modifier applied to this progress indicator
- * @param label The label displayed below the circular progress
  * @param progress The progress of this progress indicator, where 0.0 represents no progress and 1.0
  * represents full progress. Values outside of this range are coerced into the range. If set to `null`,
  * the progress indicator is indeterminate.
+ * @param label The label displayed below the circular progress
  */
 @Composable
 @OdsComposable
 fun OdsCircularProgressIndicator(
     modifier: Modifier = Modifier,
-    label: String? = null,
-    progress: Float? = null
+    progress: Float? = null,
+    label: String? = null
 ) {
     Column(horizontalAlignment = Alignment.CenterHorizontally, modifier = modifier)
     {

diff --git a/...ain/java/com/orange/ods/compose/component/progressindicator/OdsLinearProgressIndicator.kt b/...ain/java/com/orange/ods/compose/component/progressindicator/OdsLinearProgressIndicator.kt
@@ -50,22 +50,22 @@ import com.orange.ods.extension.orElse
  * @see androidx.compose.material.LinearProgressIndicator
  *
  * @param modifier The modifier applied to this progress indicator
- * @param showCurrentValue To indicated if we have or not the current value
  * @param progress The value of this progress indicator, where 0.0 represents no progress and 1.0
  * represents full progress. Values outside of this range are coerced into the range. If set to `null`,
  * the progress indicator is indeterminate.
  * @param label The label displayed above the linear progress
  * @param icon The icon displayed above the linear progress
+ * @param showCurrentValue Indicates whether the current value is displayed
  */
 @OptIn(ExperimentalComposeUiApi::class)
 @Composable
 @OdsComposable
 fun OdsLinearProgressIndicator(
     modifier: Modifier = Modifier,
-    showCurrentValue: Boolean = false,
     progress: Float? = null,
     label: String? = null,
-    icon: OdsLinearProgressIndicatorIcon? = null
+    icon: OdsLinearProgressIndicatorIcon? = null,
+    showCurrentValue: Boolean = false
 ) {
     Column(
         modifier = modifier