[#349] Review: Rename "OverFlow" into "Overflow"

Orange-OpenSource · Dec 6, 2022 · 93cf90c · 93cf90c
1 parent 5a6c671
commit 93cf90c
Show file tree

Hide file tree

Showing 4 changed files with 7 additions and 7 deletions.
diff --git a/changelog.md b/changelog.md
@@ -11,7 +11,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - \[Demo\] Add Snackbar component ([#114](https://github.com/Orange-OpenSource/ods-android/issues/114))
 - \[Demo\] Display an error message below text fields if customization error switch is on ([#338](https://github.com/Orange-OpenSource/ods-android/issues/338))
-- \[Lib\] Add `OdsTopAppBarOverFlowMenuBox` and `OdsDropdownMenu` composables to display an overflow menu in the top app bar ([#349](https://github.com/Orange-OpenSource/ods-android/issues/349))
+- \[Lib\] Add `OdsTopAppBarOverflowMenuBox` and `OdsDropdownMenu` composables to display an overflow menu in the top app bar ([#349](https://github.com/Orange-OpenSource/ods-android/issues/349))
 - \[Lib\] Add `OdsSnackbar` and `OdsSnackbarHost` composable to manage snackbars display ([#114](https://github.com/Orange-OpenSource/ods-android/issues/114))
 - \[Lib\] Add `errorMessage` parameter to `OdsTextField`, `OdsOutlinedTextField`, `OdsPasswordTextField` and `OdsPasswordOutlinedTextField` to allow the display of an error message below text fields ([#338](https://github.com/Orange-OpenSource/ods-android/issues/338))
 - \[Lib\] Add `characterCounter` parameter to `OdsTextField`, `OdsOutlinedTextField`, `OdsPasswordTextField` and `OdsPasswordOutlinedTextField` to allow the display of a character counter below text fields ([#338](https://github.com/Orange-OpenSource/ods-android/issues/338))

diff --git a/demo/src/main/java/com/orange/ods/demo/ui/MainTopAppBar.kt b/demo/src/main/java/com/orange/ods/demo/ui/MainTopAppBar.kt
@@ -22,7 +22,7 @@ import androidx.compose.ui.res.painterResource
 import androidx.compose.ui.res.stringResource
 import com.orange.ods.compose.component.appbar.top.OdsTopAppBar
 import com.orange.ods.compose.component.appbar.top.OdsTopAppBarActionButton
-import com.orange.ods.compose.component.appbar.top.OdsTopAppBarOverFlowMenuBox
+import com.orange.ods.compose.component.appbar.top.OdsTopAppBarOverflowMenuBox
 import com.orange.ods.compose.component.menu.OdsMenuItem
 import com.orange.ods.demo.R
 import com.orange.ods.demo.ui.components.utilities.clickOnElement
@@ -71,7 +71,7 @@ fun MainTopAppBar(
                 }
             }
             if (state.isOverflowMenuEnabled) {
-                OdsTopAppBarOverFlowMenuBox(
+                OdsTopAppBarOverflowMenuBox(
                     overflowIconContentDescription = stringResource(id = R.string.component_app_bars_top_element_overflow_menu),
                     overflowMenuItems = listOf(
                         OdsMenuItem(

diff --git a/docs/components/AppBarsTop.md b/docs/components/AppBarsTop.md
@@ -245,10 +245,10 @@ If you need to have a top app bar with some elevation you can set the `@style/Wi
 ![Overflow menu light](images/app_bar_top_overflow_menu_light.png)  
 ![Overflow menu dark](images/app_bar_top_overflow_menu_dark.png)
 
-You can easily add an overflow menu to your top app bar by using the `OdsTopAppBarOverFlowMenuBox` composable as follow:
+You can easily add an overflow menu to your top app bar by using the `OdsTopAppBarOverflowMenuBox` composable as follow:
 
 ```kotlin
-OdsTopAppBarOverFlowMenuBox(
+OdsTopAppBarOverflowMenuBox(
     overflowIconContentDescription = "more actions",
     overflowMenuItems = listOf(
         OdsMenuItem(

diff --git a/lib/src/main/java/com/orange/ods/compose/component/appbar/top/OdsTopAppBar.kt b/lib/src/main/java/com/orange/ods/compose/component/appbar/top/OdsTopAppBar.kt
@@ -124,7 +124,7 @@ fun OdsTopAppBarActionButton(
  * @param overflowMenuItems The list of the [OdsMenuItem] to display in the menu.
  */
 @Composable
-fun OdsTopAppBarOverFlowMenuBox(
+fun OdsTopAppBarOverflowMenuBox(
     overflowIconContentDescription: String,
     overflowMenuItems: List<OdsMenuItem> = emptyList()
 ) {
@@ -160,7 +160,7 @@ private fun PreviewOdsTopAppBar() = Preview {
                 painter = painterResource(id = android.R.drawable.ic_dialog_info),
                 contentDescription = "Info"
             )
-            OdsTopAppBarOverFlowMenuBox(
+            OdsTopAppBarOverflowMenuBox(
                 overflowIconContentDescription = "more options",
                 overflowMenuItems = listOf(
                     OdsMenuItem(text = "settings", {}),