[#271] Rename OdsChoiceChipsFlowRowScope<T>.ChoiceChip to OdsChoiceCh…

…ipsFlowRowScope<T>.OdsChoiceChip
Orange-OpenSource · Oct 6, 2022 · 12d20db · 12d20db
1 parent 24b8cf0
commit 12d20db
Show file tree

Hide file tree

Showing 7 changed files with 42 additions and 41 deletions.
diff --git a/changelog.md b/changelog.md
@@ -19,6 +19,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - \[Demo\] Expand components customization bottom sheets by default ([#284](https://github.com/Orange-OpenSource/ods-android/issues/284))
 - \[Lib\] Cards and buttons composables have been renamed to match with Jetpack compose SDK naming ([#267](https://github.com/Orange-OpenSource/ods-android/issues/267))
 - \[Lib\] `OdsButtonContainedStyle` has been renamed into `OdsButtonStyle` ([#260](https://github.com/Orange-OpenSource/ods-android/issues/260))
+- \[Lib\] Rename `ChoiceChip` to `OdsChoiceChip` ([#271](https://github.com/Orange-OpenSource/ods-android/issues/271))
 
 ### Fixed
 

diff --git a/demo/src/main/java/com/orange/ods/demo/ui/components/chips/Chip.kt b/demo/src/main/java/com/orange/ods/demo/ui/components/chips/Chip.kt
@@ -22,8 +22,8 @@ import androidx.compose.ui.platform.LocalContext
 import androidx.compose.ui.res.dimensionResource
 import androidx.compose.ui.res.painterResource
 import androidx.compose.ui.res.stringResource
-import com.orange.ods.compose.component.chip.ChoiceChip
 import com.orange.ods.compose.component.chip.OdsChip
+import com.orange.ods.compose.component.chip.OdsChoiceChip
 import com.orange.ods.compose.component.chip.OdsChoiceChipsFlowRow
 import com.orange.ods.demo.R
 import com.orange.ods.demo.ui.components.chips.ChipCustomizationState.ChipType
@@ -47,9 +47,9 @@ fun Chip() {
                 modifier = Modifier.padding(horizontal = dimensionResource(id = R.dimen.ods_screen_horizontal_margin)),
                 outlinedChips = true
             ) {
-                ChoiceChip(textRes = R.string.component_chip_type_input, value = ChipType.Input)
-                ChoiceChip(textRes = R.string.component_chip_type_choice, value = ChipType.Choice)
-                ChoiceChip(textRes = R.string.component_chip_type_action, value = ChipType.Action)
+                OdsChoiceChip(textRes = R.string.component_chip_type_input, value = ChipType.Input)
+                OdsChoiceChip(textRes = R.string.component_chip_type_choice, value = ChipType.Choice)
+                OdsChoiceChip(textRes = R.string.component_chip_type_action, value = ChipType.Action)
             }
 
             if (chipCustomizationState.isInputChip) {
@@ -59,9 +59,9 @@ fun Chip() {
                     modifier = Modifier.padding(horizontal = dimensionResource(id = R.dimen.ods_screen_horizontal_margin)),
                     outlinedChips = true
                 ) {
-                    ChoiceChip(textRes = R.string.component_element_none, value = LeadingElement.None)
-                    ChoiceChip(textRes = R.string.component_element_avatar, value = LeadingElement.Avatar)
-                    ChoiceChip(textRes = R.string.component_element_icon, value = LeadingElement.Icon)
+                    OdsChoiceChip(textRes = R.string.component_element_none, value = LeadingElement.None)
+                    OdsChoiceChip(textRes = R.string.component_element_avatar, value = LeadingElement.Avatar)
+                    OdsChoiceChip(textRes = R.string.component_element_icon, value = LeadingElement.Icon)
                 }
             } else {
                 chipCustomizationState.resetLeadingElement()
@@ -95,7 +95,7 @@ private fun Chip(chipCustomizationState: ChipCustomizationState) {
     if (chipCustomizationState.isChoiceChip) {
         OdsChoiceChipsFlowRow(selectedChip = chipCustomizationState.choiceChipIndexSelected, outlinedChips = chipCustomizationState.isOutlined) {
             for (index in 1..4) {
-                ChoiceChip(
+                OdsChoiceChip(
                     text = "${getChipText(chipType = chipCustomizationState.chipType.value)} $index",
                     value = index,
                     enabled = chipCustomizationState.isEnabled

diff --git a/demo/src/main/java/com/orange/ods/demo/ui/components/chips/ChipFilter.kt b/demo/src/main/java/com/orange/ods/demo/ui/components/chips/ChipFilter.kt
@@ -25,7 +25,7 @@ import androidx.compose.ui.res.dimensionResource
 import androidx.compose.ui.res.painterResource
 import androidx.compose.ui.res.stringResource
 import com.google.accompanist.flowlayout.FlowRow
-import com.orange.ods.compose.component.chip.ChoiceChip
+import com.orange.ods.compose.component.chip.OdsChoiceChip
 import com.orange.ods.compose.component.chip.OdsChoiceChipsFlowRow
 import com.orange.ods.compose.component.chip.OdsFilterChip
 import com.orange.ods.demo.R
@@ -48,8 +48,8 @@ fun ChipFilter() {
                 modifier = Modifier.padding(horizontal = dimensionResource(id = R.dimen.ods_screen_horizontal_margin)),
                 outlinedChips = true
             ) {
-                ChoiceChip(textRes = R.string.component_element_none, value = ChipCustomizationState.LeadingElement.None)
-                ChoiceChip(textRes = R.string.component_element_avatar, value = ChipCustomizationState.LeadingElement.Avatar)
+                OdsChoiceChip(textRes = R.string.component_element_none, value = ChipCustomizationState.LeadingElement.None)
+                OdsChoiceChip(textRes = R.string.component_element_avatar, value = ChipCustomizationState.LeadingElement.Avatar)
             }
 
             CheckboxListItem(labelRes = R.string.component_state_outlined, checked = chipCustomizationState.outlinedChecked)

diff --git a/demo/src/main/java/com/orange/ods/demo/ui/components/lists/ComponentLists.kt b/demo/src/main/java/com/orange/ods/demo/ui/components/lists/ComponentLists.kt
@@ -30,7 +30,7 @@ import androidx.compose.ui.res.dimensionResource
 import androidx.compose.ui.res.painterResource
 import androidx.compose.ui.res.stringResource
 import androidx.compose.ui.unit.dp
-import com.orange.ods.compose.component.chip.ChoiceChip
+import com.orange.ods.compose.component.chip.OdsChoiceChip
 import com.orange.ods.compose.component.chip.OdsChoiceChipsFlowRow
 import com.orange.ods.compose.component.control.OdsCheckbox
 import com.orange.ods.compose.component.control.OdsSwitch
@@ -67,9 +67,9 @@ private fun ComponentListsBottomSheetContent(listItemCustomizationState: ListIte
         modifier = Modifier.padding(horizontal = dimensionResource(id = R.dimen.ods_screen_horizontal_margin)),
         outlinedChips = true
     ) {
-        ChoiceChip(textRes = R.string.component_list_item_size_single_line, value = ListItemCustomizationState.ItemSize.SingleLine)
-        ChoiceChip(textRes = R.string.component_list_item_size_two_line, value = ListItemCustomizationState.ItemSize.TwoLine)
-        ChoiceChip(textRes = R.string.component_list_item_size_three_line, value = ListItemCustomizationState.ItemSize.ThreeLine)
+        OdsChoiceChip(textRes = R.string.component_list_item_size_single_line, value = ListItemCustomizationState.ItemSize.SingleLine)
+        OdsChoiceChip(textRes = R.string.component_list_item_size_two_line, value = ListItemCustomizationState.ItemSize.TwoLine)
+        OdsChoiceChip(textRes = R.string.component_list_item_size_three_line, value = ListItemCustomizationState.ItemSize.ThreeLine)
     }
 
     Subtitle(textRes = R.string.component_list_leading, withHorizontalPadding = true)
@@ -78,11 +78,11 @@ private fun ComponentListsBottomSheetContent(listItemCustomizationState: ListIte
         modifier = Modifier.padding(horizontal = dimensionResource(id = R.dimen.ods_screen_horizontal_margin)),
         outlinedChips = true
     ) {
-        ChoiceChip(textRes = R.string.component_list_leading_none, value = ListItemCustomizationState.Leading.None)
-        ChoiceChip(textRes = R.string.component_list_leading_icon, value = ListItemCustomizationState.Leading.Icon)
-        ChoiceChip(textRes = R.string.component_list_leading_circular_image, value = ListItemCustomizationState.Leading.CircularImage)
-        ChoiceChip(textRes = R.string.component_list_leading_square_image, value = ListItemCustomizationState.Leading.SquareImage)
-        ChoiceChip(textRes = R.string.component_list_leading_wide_image, value = ListItemCustomizationState.Leading.WideImage)
+        OdsChoiceChip(textRes = R.string.component_list_leading_none, value = ListItemCustomizationState.Leading.None)
+        OdsChoiceChip(textRes = R.string.component_list_leading_icon, value = ListItemCustomizationState.Leading.Icon)
+        OdsChoiceChip(textRes = R.string.component_list_leading_circular_image, value = ListItemCustomizationState.Leading.CircularImage)
+        OdsChoiceChip(textRes = R.string.component_list_leading_square_image, value = ListItemCustomizationState.Leading.SquareImage)
+        OdsChoiceChip(textRes = R.string.component_list_leading_wide_image, value = ListItemCustomizationState.Leading.WideImage)
     }
 
     Subtitle(textRes = R.string.component_list_trailing, withHorizontalPadding = true)
@@ -92,7 +92,7 @@ private fun ComponentListsBottomSheetContent(listItemCustomizationState: ListIte
         outlinedChips = true
     ) {
         listItemCustomizationState.trailings.forEach { trailing ->
-            ChoiceChip(textRes = trailing.textResId, value = trailing)
+            OdsChoiceChip(textRes = trailing.textResId, value = trailing)
         }
     }
 

diff --git a/demo/src/main/java/com/orange/ods/demo/ui/components/tabs/ComponentTabs.kt b/demo/src/main/java/com/orange/ods/demo/ui/components/tabs/ComponentTabs.kt
@@ -29,7 +29,7 @@ import androidx.compose.ui.res.stringResource
 import androidx.compose.ui.text.style.TextAlign
 import com.google.accompanist.pager.ExperimentalPagerApi
 import com.google.accompanist.pager.HorizontalPager
-import com.orange.ods.compose.component.chip.ChoiceChip
+import com.orange.ods.compose.component.chip.OdsChoiceChip
 import com.orange.ods.compose.component.chip.OdsChoiceChipsFlowRow
 import com.orange.ods.demo.R
 import com.orange.ods.demo.ui.components.Variant
@@ -80,17 +80,17 @@ fun ComponentTabs(variant: Variant, updateTopAppBarTabs: (TabsConfiguration) ->
                 modifier = Modifier.padding(horizontal = dimensionResource(id = R.dimen.ods_screen_horizontal_margin)),
                 outlinedChips = true
             ) {
-                ChoiceChip(
+                OdsChoiceChip(
                     textRes = R.string.component_tab_icon_leading,
                     value = TabsCustomizationState.TabIconType.Leading,
                     enabled = tabsCustomizationState.isTabIconCustomizationEnabled
                 )
-                ChoiceChip(
+                OdsChoiceChip(
                     textRes = R.string.component_tab_icon_top,
                     value = TabsCustomizationState.TabIconType.Top,
                     enabled = tabsCustomizationState.isTabIconCustomizationEnabled
                 )
-                ChoiceChip(
+                OdsChoiceChip(
                     textRes = R.string.component_element_none,
                     value = TabsCustomizationState.TabIconType.None,
                     enabled = tabsCustomizationState.isTabIconCustomizationEnabled

diff --git a/demo/src/main/java/com/orange/ods/demo/ui/components/textfields/ComponentTextField.kt b/demo/src/main/java/com/orange/ods/demo/ui/components/textfields/ComponentTextField.kt
@@ -28,7 +28,7 @@ import androidx.compose.ui.res.stringResource
 import com.google.accompanist.pager.ExperimentalPagerApi
 import com.google.accompanist.pager.HorizontalPager
 import com.google.accompanist.pager.rememberPagerState
-import com.orange.ods.compose.component.chip.ChoiceChip
+import com.orange.ods.compose.component.chip.OdsChoiceChip
 import com.orange.ods.compose.component.chip.OdsChoiceChipsFlowRow
 import com.orange.ods.compose.component.tab.OdsTab
 import com.orange.ods.compose.component.tab.OdsTabRow
@@ -128,11 +128,11 @@ private fun ComponentCustomizationContent(textFieldCustomizationState: TextField
         modifier = Modifier.padding(horizontal = dimensionResource(id = R.dimen.spacing_m)),
         outlinedChips = true
     ) {
-        ChoiceChip(textRes = R.string.component_text_field_input_type_single_line, value = TextFieldCustomizationState.InputType.SingleLine)
-        ChoiceChip(textRes = R.string.component_text_field_input_type_multiline, value = TextFieldCustomizationState.InputType.Multiline)
+        OdsChoiceChip(textRes = R.string.component_text_field_input_type_single_line, value = TextFieldCustomizationState.InputType.SingleLine)
+        OdsChoiceChip(textRes = R.string.component_text_field_input_type_multiline, value = TextFieldCustomizationState.InputType.Multiline)
         // Note: TextArea chip is disabled cause there is no parameter allowing text area in Jetpack Compose sdk for now
         // https://issuetracker.google.com/issues/122476634
-        ChoiceChip(
+        OdsChoiceChip(
             textRes = R.string.component_text_field_input_type_text_area,
             value = TextFieldCustomizationState.InputType.TextArea,
             enabled = false
@@ -147,9 +147,9 @@ private fun ComponentCustomizationContent(textFieldCustomizationState: TextField
         modifier = Modifier.padding(horizontal = dimensionResource(id = R.dimen.spacing_m)),
         outlinedChips = true
     ) {
-        ChoiceChip(textRes = R.string.component_element_none, value = TextFieldCustomizationState.TrailingElement.None)
-        ChoiceChip(textRes = R.string.component_element_icon, value = TextFieldCustomizationState.TrailingElement.Icon)
-        ChoiceChip(textRes = R.string.component_element_text, value = TextFieldCustomizationState.TrailingElement.Text)
+        OdsChoiceChip(textRes = R.string.component_element_none, value = TextFieldCustomizationState.TrailingElement.None)
+        OdsChoiceChip(textRes = R.string.component_element_icon, value = TextFieldCustomizationState.TrailingElement.Icon)
+        OdsChoiceChip(textRes = R.string.component_element_text, value = TextFieldCustomizationState.TrailingElement.Text)
     }
 
     SwitchListItem(labelRes = R.string.component_text_field_character_counter, checked = textFieldCustomizationState.characterCounter)
@@ -166,7 +166,7 @@ private fun KeyboardCustomizationContent(textFieldCustomizationState: TextFieldC
         outlinedChips = true
     ) {
         TextFieldCustomizationState.SoftKeyboardType.values().forEach { softKeyboardType ->
-            ChoiceChip(text = stringResource(id = softKeyboardType.labelRes), value = softKeyboardType)
+            OdsChoiceChip(text = stringResource(id = softKeyboardType.labelRes), value = softKeyboardType)
         }
     }
 
@@ -179,7 +179,7 @@ private fun KeyboardCustomizationContent(textFieldCustomizationState: TextFieldC
         outlinedChips = true
     ) {
         TextFieldCustomizationState.SoftKeyboardAction.values().forEach { softKeyboardAction ->
-            ChoiceChip(text = stringResource(id = softKeyboardAction.labelRes), value = softKeyboardAction)
+            OdsChoiceChip(text = stringResource(id = softKeyboardAction.labelRes), value = softKeyboardAction)
         }
     }
 
@@ -194,9 +194,9 @@ private fun DisplayTypeCustomization(displayType: MutableState<TextFieldCustomiz
         modifier = Modifier.padding(horizontal = dimensionResource(id = R.dimen.spacing_m)),
         outlinedChips = true
     ) {
-        ChoiceChip(textRes = R.string.component_state_default, value = TextFieldCustomizationState.DisplayType.Default)
-        ChoiceChip(textRes = R.string.component_state_error, value = TextFieldCustomizationState.DisplayType.Error)
-        ChoiceChip(textRes = R.string.component_state_disabled, value = TextFieldCustomizationState.DisplayType.Disabled)
+        OdsChoiceChip(textRes = R.string.component_state_default, value = TextFieldCustomizationState.DisplayType.Default)
+        OdsChoiceChip(textRes = R.string.component_state_error, value = TextFieldCustomizationState.DisplayType.Error)
+        OdsChoiceChip(textRes = R.string.component_state_disabled, value = TextFieldCustomizationState.DisplayType.Disabled)
     }
 }
 

diff --git a/lib/src/main/java/com/orange/ods/compose/component/chip/OdsChoiceChipsFlowRow.kt b/lib/src/main/java/com/orange/ods/compose/component/chip/OdsChoiceChipsFlowRow.kt
@@ -24,7 +24,7 @@ import com.orange.ods.R
 import com.orange.ods.compose.component.OdsComponentApi
 
 /**
- * Displays a full width [FlowRow] containing customized choice chips [OdsChoiceChipsFlowRowScope.ChoiceChip].
+ * Displays a full width [FlowRow] containing customized choice chips [OdsChoiceChipsFlowRowScope.OdsChoiceChip].
  *
  * @param selectedChip The selected chips value state.
  * @param modifier Modifier to be applied to the flow row.
@@ -57,7 +57,7 @@ fun <T> OdsChoiceChipsFlowRow(
 @ExperimentalMaterialApi
 @Composable
 @OdsComponentApi
-fun <T> OdsChoiceChipsFlowRowScope<T>.ChoiceChip(text: String, value: T, enabled: Boolean = true) {
+fun <T> OdsChoiceChipsFlowRowScope<T>.OdsChoiceChip(text: String, value: T, enabled: Boolean = true) {
     OdsChip(
         text = text,
         selected = selectedChip.value == value,
@@ -75,8 +75,8 @@ fun <T> OdsChoiceChipsFlowRowScope<T>.ChoiceChip(text: String, value: T, enabled
  */
 @ExperimentalMaterialApi
 @Composable
-fun <T> OdsChoiceChipsFlowRowScope<T>.ChoiceChip(@StringRes textRes: Int, value: T, enabled: Boolean = true) {
-    ChoiceChip(text = stringResource(id = textRes), value = value, enabled = enabled)
+fun <T> OdsChoiceChipsFlowRowScope<T>.OdsChoiceChip(@StringRes textRes: Int, value: T, enabled: Boolean = true) {
+    OdsChoiceChip(text = stringResource(id = textRes), value = value, enabled = enabled)
 }
 
 /**