feat: rename APIs parameters for homogenization purpose (#479)

Author: paulinea

app/src/main/java/com/orange/ouds/app/ui/components/ComponentCode.kt

@@ -42,6 +42,6 @@ fun FunctionCall.Builder.contentDescriptionArgument(@StringRes id: Int) {
 
 fun FunctionCall.Builder.onClickArgument(init: Code.Builder.() -> Unit = {}) = lambdaArgument("onClick", init)
 
-fun FunctionCall.Builder.textArgument(text: String?) = typedArgument("text", text)
+fun FunctionCall.Builder.labelArgument(label: String?) = typedArgument("label", label)
 
 fun FunctionCall.Builder.enabledArgument(boolean: Boolean) = typedArgument("enabled", boolean)

app/src/main/java/com/orange/ouds/app/ui/components/button/ButtonDemoScreen.kt

@@ -26,9 +26,9 @@ import com.orange.ouds.app.ui.components.Component
 import com.orange.ouds.app.ui.components.coloredBoxCall
 import com.orange.ouds.app.ui.components.contentDescriptionArgument
 import com.orange.ouds.app.ui.components.enabledArgument
+import com.orange.ouds.app.ui.components.labelArgument
 import com.orange.ouds.app.ui.components.onClickArgument
 import com.orange.ouds.app.ui.components.painterArgument
-import com.orange.ouds.app.ui.components.textArgument
 import com.orange.ouds.app.ui.utilities.composable.CodeSnippet
 import com.orange.ouds.app.ui.utilities.composable.CustomizationBottomSheetScaffold
 import com.orange.ouds.app.ui.utilities.composable.CustomizationChoiceChips
@@ -88,9 +88,9 @@ fun ButtonDemoScreen() = DemoScreen(rememberButtonDemoState()) {
                 onSelectionChange = { id -> layout = ButtonDemoState.Layout.entries[id] }
             )
             CustomizationTextField(
-                label = stringResource(R.string.app_components_common_text_label),
-                value = text,
-                onValueChange = { value -> text = value })
+                label = stringResource(R.string.app_components_common_label_label),
+                value = label,
+                onValueChange = { value -> label = value })
         }
     ) {
         DetailScreenDescription(
@@ -125,7 +125,7 @@ private fun ButtonDemo(state: ButtonDemoState) {
         when (layout) {
             ButtonDemoState.Layout.TextOnly -> {
                 OudsButton(
-                    text = text,
+                    label = label,
                     onClick = {},
                     enabled = enabled,
                     style = style,
@@ -135,7 +135,7 @@ private fun ButtonDemo(state: ButtonDemoState) {
             ButtonDemoState.Layout.IconAndText -> {
                 OudsButton(
                     icon = icon,
-                    text = text,
+                    label = label,
                     onClick = {},
                     enabled = enabled,
                     style = style,
@@ -168,7 +168,7 @@ private fun ButtonDemoCodeSnippet(state: ButtonDemoState, modifier: Modifier = M
                         }
                     }
                     if (layout in listOf(ButtonDemoState.Layout.TextOnly, ButtonDemoState.Layout.IconAndText)) {
-                        textArgument(text)
+                        labelArgument(label)
                     }
                     onClickArgument()
                     enabledArgument(enabled)

app/src/main/java/com/orange/ouds/app/ui/components/button/ButtonDemoState.kt

@@ -26,18 +26,18 @@ import com.orange.ouds.core.component.OudsButtonDefaults
 
 @Composable
 fun rememberButtonDemoState(
-    text: String = stringResource(id = R.string.app_components_button_label),
+    label: String = stringResource(id = R.string.app_components_button_label),
     enabled: Boolean = true,
     onColoredBox: Boolean = false,
     style: OudsButton.Style = OudsButtonDefaults.Style,
     hierarchy: OudsButton.Hierarchy = OudsButtonDefaults.Hierarchy,
     layout: ButtonDemoState.Layout = ButtonDemoState.Layout.TextOnly
-) = rememberSaveable(text, enabled, style, hierarchy, layout, saver = ButtonDemoState.Saver) {
-    ButtonDemoState(text, enabled, onColoredBox, style, hierarchy, layout)
+) = rememberSaveable(label, enabled, style, hierarchy, layout, saver = ButtonDemoState.Saver) {
+    ButtonDemoState(label, enabled, onColoredBox, style, hierarchy, layout)
 }
 
 class ButtonDemoState(
-    text: String,
+    label: String,
     enabled: Boolean,
     onColoredBox: Boolean,
     style: OudsButton.Style,
@@ -48,7 +48,7 @@ class ButtonDemoState(
     companion object {
 
         val Saver = run {
-            val textKey = "text"
+            val labelKey = "label"
             val enabledKey = "enabled"
             val onColoredBoxKey = "onColoredBox"
             val styleKey = "style"
@@ -57,7 +57,7 @@ class ButtonDemoState(
             mapSaver(
                 save = { state ->
                     mapOf(
-                        textKey to state.text,
+                        labelKey to state.label,
                         enabledKey to state.enabled,
                         onColoredBoxKey to state.onColoredBox,
                         styleKey to state.style,
@@ -67,7 +67,7 @@ class ButtonDemoState(
                 },
                 restore = { map ->
                     ButtonDemoState(
-                        map[textKey] as String,
+                        map[labelKey] as String,
                         map[enabledKey] as Boolean,
                         map[onColoredBoxKey] as Boolean,
                         map[styleKey] as OudsButton.Style,
@@ -79,7 +79,7 @@ class ButtonDemoState(
         }
     }
 
-    var text: String by mutableStateOf(text)
+    var label: String by mutableStateOf(label)
 
     var enabled: Boolean by mutableStateOf(enabled)
 

app/src/main/java/com/orange/ouds/app/ui/components/checkbox/CheckboxItemDemoScreen.kt

@@ -26,9 +26,9 @@ import com.orange.ouds.app.ui.components.controlitem.ControlItemEnabledCustomiza
 import com.orange.ouds.app.ui.components.controlitem.ControlItemErrorCustomization
 import com.orange.ouds.app.ui.components.controlitem.ControlItemHelperTextCustomization
 import com.orange.ouds.app.ui.components.controlitem.ControlItemIconCustomization
-import com.orange.ouds.app.ui.components.controlitem.ControlItemInvertedCustomization
+import com.orange.ouds.app.ui.components.controlitem.ControlItemReversedCustomization
 import com.orange.ouds.app.ui.components.controlitem.ControlItemReadOnlyCustomization
-import com.orange.ouds.app.ui.components.controlitem.ControlItemTextCustomization
+import com.orange.ouds.app.ui.components.controlitem.ControlItemLabelCustomization
 import com.orange.ouds.app.ui.components.controlitem.controlItemArguments
 import com.orange.ouds.app.ui.components.onClickArgument
 import com.orange.ouds.app.ui.utilities.composable.CodeSnippet
@@ -49,11 +49,11 @@ fun CheckboxItemDemoScreen(indeterminate: Boolean = false) = DemoScreen(remember
         bottomSheetContent = {
             ControlItemIconCustomization()
             ControlItemDividerCustomization()
-            ControlItemInvertedCustomization()
+            ControlItemReversedCustomization()
             ControlItemEnabledCustomization()
             ControlItemReadOnlyCustomization()
             ControlItemErrorCustomization()
-            ControlItemTextCustomization()
+            ControlItemLabelCustomization()
             ControlItemHelperTextCustomization()
         }
     ) {
@@ -91,11 +91,11 @@ private fun CheckboxItemDemo(state: CheckboxItemDemoState) {
                             CheckboxIdentifier.Second -> checkedValues.copy(second = value)
                         }
                     },
-                    text = text,
+                    label = label,
                     helperText = helperText,
                     icon = if (icon) OudsControlItem.Icon(painterResource(id = R.drawable.ic_heart)) else null,
                     divider = divider,
-                    inverted = inverted,
+                    reversed = reversed,
                     enabled = enabled,
                     readOnly = readOnly,
                     error = error
@@ -123,11 +123,11 @@ private fun IndeterminateCheckboxItemDemo(state: CheckboxItemDemoState) {
                             }
                         }
                     },
-                    text = text,
+                    label = label,
                     helperText = helperText,
                     icon = if (icon) OudsControlItem.Icon(painterResource(id = R.drawable.ic_heart)) else null,
                     divider = divider,
-                    inverted = inverted,
+                    reversed = reversed,
                     enabled = enabled,
                     readOnly = readOnly,
                     error = error

app/src/main/java/com/orange/ouds/app/ui/components/checkbox/CheckboxItemDemoState.kt

@@ -32,40 +32,40 @@ fun rememberCheckboxItemDemoState(
     ), // only used for indeterminate checkbox item demo
     icon: Boolean = false,
     divider: Boolean = false,
-    inverted: Boolean = false,
+    reversed: Boolean = false,
     enabled: Boolean = true,
     readOnly: Boolean = false,
     error: Boolean = false,
-    text: String = stringResource(id = R.string.app_components_common_text_label),
+    label: String = stringResource(id = R.string.app_components_common_label_label),
     helperText: String? = null
 ) = rememberSaveable(
     checkedValues,
     toggleableStateValues,
     icon,
     divider,
-    inverted,
+    reversed,
     enabled,
     readOnly,
     error,
-    text,
+    label,
     helperText,
     saver = CheckboxItemDemoState.Saver
 ) {
-    CheckboxItemDemoState(checkedValues, toggleableStateValues, icon, divider, inverted, enabled, readOnly, error, text, helperText)
+    CheckboxItemDemoState(checkedValues, toggleableStateValues, icon, divider, reversed, enabled, readOnly, error, label, helperText)
 }
 
 class CheckboxItemDemoState(
     checkedValues: Pair<Boolean, Boolean>,
     toggleableStateValues: Pair<ToggleableState, ToggleableState>,
     icon: Boolean,
     divider: Boolean,
-    inverted: Boolean,
+    reversed: Boolean,
     enabled: Boolean,
     readOnly: Boolean,
     error: Boolean,
-    text: String,
+    label: String,
     helperText: String?
-) : ControlItemDemoState(icon, divider, inverted, enabled, readOnly, error, text, helperText) {
+) : ControlItemDemoState(icon, divider, reversed, enabled, readOnly, error, label, helperText) {
     companion object {
         val Saver = run {
             val checkedValuesKey = "checkedValues"
@@ -77,11 +77,11 @@ class CheckboxItemDemoState(
                         toggleableStateValuesKey to state.toggleableStateValues,
                         IconKey to state.icon,
                         DividerKey to state.divider,
-                        InvertedKey to state.inverted,
+                        ReversedKey to state.reversed,
                         EnabledKey to state.enabled,
                         ReadOnlyKey to state.readOnly,
                         ErrorKey to state.error,
-                        TextKey to state.text,
+                        LabelKey to state.label,
                         HelperTextKey to state.helperText
                     )
                 },
@@ -92,11 +92,11 @@ class CheckboxItemDemoState(
                         map[toggleableStateValuesKey] as Pair<ToggleableState, ToggleableState>,
                         map[IconKey] as Boolean,
                         map[DividerKey] as Boolean,
-                        map[InvertedKey] as Boolean,
+                        map[ReversedKey] as Boolean,
                         map[EnabledKey] as Boolean,
                         map[ReadOnlyKey] as Boolean,
                         map[ErrorKey] as Boolean,
-                        map[TextKey] as String,
+                        map[LabelKey] as String,
                         map[HelperTextKey] as String?
                     )
                 }

app/src/main/java/com/orange/ouds/app/ui/components/controlitem/ControlItemDemoElements.kt

@@ -16,8 +16,8 @@ import androidx.compose.runtime.Composable
 import androidx.compose.ui.res.stringResource
 import com.orange.ouds.app.R
 import com.orange.ouds.app.ui.components.enabledArgument
+import com.orange.ouds.app.ui.components.labelArgument
 import com.orange.ouds.app.ui.components.painterArgument
-import com.orange.ouds.app.ui.components.textArgument
 import com.orange.ouds.app.ui.utilities.FunctionCall
 import com.orange.ouds.app.ui.utilities.composable.CustomizationSwitchListItem
 import com.orange.ouds.app.ui.utilities.composable.CustomizationTextField
@@ -42,11 +42,11 @@ fun <T : ControlItemDemoState> T.ControlItemDividerCustomization() {
 }
 
 @Composable
-fun <T : ControlItemDemoState> T.ControlItemInvertedCustomization() {
+fun <T : ControlItemDemoState> T.ControlItemReversedCustomization() {
     CustomizationSwitchListItem(
-        label = stringResource(R.string.app_components_controlItem_inverted_label),
-        checked = inverted,
-        onCheckedChange = { inverted = it },
+        label = stringResource(R.string.app_components_controlItem_reversed_label),
+        checked = reversed,
+        onCheckedChange = { reversed = it },
     )
 }
 
@@ -81,11 +81,11 @@ fun <T : ControlItemDemoState> T.ControlItemErrorCustomization() {
 }
 
 @Composable
-fun <T : ControlItemDemoState> T.ControlItemTextCustomization() {
+fun <T : ControlItemDemoState> T.ControlItemLabelCustomization() {
     CustomizationTextField(
-        label = stringResource(R.string.app_components_common_text_label),
-        value = text,
-        onValueChange = { value -> text = value }
+        label = stringResource(R.string.app_components_common_label_label),
+        value = label,
+        onValueChange = { value -> label = value }
     )
 }
 
@@ -99,15 +99,15 @@ fun <T : ControlItemDemoState> T.ControlItemHelperTextCustomization() {
 }
 
 fun FunctionCall.Builder.controlItemArguments(state: ControlItemDemoState) = with(state) {
-    textArgument(text)
+    labelArgument(label)
     if (!helperText.isNullOrBlank()) typedArgument("helperText", helperText)
     if (icon) {
         constructorCallArgument<OudsControlItem.Icon>("icon") {
             painterArgument(R.drawable.ic_heart)
         }
     }
     if (!divider) typedArgument("divider", divider)
-    if (inverted) typedArgument("inverted", inverted)
+    if (reversed) typedArgument("reversed", reversed)
     if (!enabled) enabledArgument(enabled)
     if (readOnly) typedArgument("readOnly", readOnly)
     if (error) typedArgument("error", error)

app/src/main/java/com/orange/ouds/app/ui/components/controlitem/ControlItemDemoState.kt

@@ -20,31 +20,31 @@ import androidx.compose.runtime.setValue
 abstract class ControlItemDemoState(
     icon: Boolean,
     divider: Boolean,
-    inverted: Boolean,
+    reversed: Boolean,
     enabled: Boolean,
     readOnly: Boolean,
     error: Boolean,
-    text: String,
+    label: String,
     helperText: String?
 ) {
     companion object {
         const val IconKey = "icon"
         const val DividerKey = "divider"
-        const val InvertedKey = "inverted"
+        const val ReversedKey = "reversed"
         const val EnabledKey = "enabled"
         const val ReadOnlyKey = "readOnly"
         const val ErrorKey = "error"
-        const val TextKey = "text"
+        const val LabelKey = "label"
         const val HelperTextKey = "helperText"
     }
 
     var icon: Boolean by mutableStateOf(icon)
     var divider: Boolean by mutableStateOf(divider)
-    var inverted: Boolean by mutableStateOf(inverted)
+    var reversed: Boolean by mutableStateOf(reversed)
     var enabled: Boolean by mutableStateOf(enabled)
     var readOnly: Boolean by mutableStateOf(readOnly)
     var error: Boolean by mutableStateOf(error)
-    var text: String by mutableStateOf(text)
+    var label: String by mutableStateOf(label)
     var helperText: String? by mutableStateOf(helperText)
 
     val enabledSwitchEnabled: Boolean