Second beta version

germainkevinbusiness · Jun 4, 2022 · 813f239 · 813f239
1 parent f946599
commit 813f239
Show file tree

Hide file tree

Showing 7 changed files with 73 additions and 45 deletions.
diff --git a/README.md b/README.md
@@ -35,7 +35,7 @@ repositories {
 
 ```groovy
 dependencies {
-    implementation 'com.github.germainkevinbusiness:CollapsingTopBarCompose:1.0.0-beta01'
+    implementation 'com.github.germainkevinbusiness:CollapsingTopBarCompose:1.0.0-beta02'
 }
 ```
 
@@ -48,14 +48,13 @@ the [sample app](https://github.com/germainkevinbusiness/CollapsingTopBarCompose
 In order to use a ```CollapsingTopBar```, you first need to create a ```TopBarScrollBehavior```.
 
 ```kotlin
- val scrollBehavior = remember {
-    CollapsingTopBarDefaults.scrollBehavior(
-        isAlwaysCollapsed = false,
-        isExpandedWhenFirstDisplayed = true,
-        collapsedTopBarHeight = 56.dp,
-        expandedTopBarMaxHeight = 156.dp,
-    )
-}
+ val scrollBehavior = rememberCollapsingTopBarScrollBehavior(
+    isAlwaysCollapsed = false,
+    isExpandedWhenFirstDisplayed = true,
+    centeredTitleAndSubtitle = false,
+    collapsedTopBarHeight = 56.dp,
+    expandedTopBarMaxHeight = 256.dp,
+)
 ```
 
 To know when scrolling occurs inside your Layout so the ```CollapsingTopBar``` can collapse or
@@ -80,20 +79,18 @@ So when we put it all together we got:
 
 ```kotlin
 
-val scrollBehavior = remember {
-    CollapsingTopBarDefaults.scrollBehavior(
-        isAlwaysCollapsed = false,
-        isExpandedWhenFirstDisplayed = true,
-        collapsedTopBarHeight = 56.dp,
-        expandedTopBarMaxHeight = 156.dp,
-    )
-}
+val scrollBehavior = rememberCollapsingTopBarScrollBehavior(
+    isAlwaysCollapsed = false,
+    isExpandedWhenFirstDisplayed = true,
+    centeredTitleAndSubtitle = false,
+    collapsedTopBarHeight = 56.dp,
+    expandedTopBarMaxHeight = 256.dp,
+)
 Scaffold(
     modifier = Modifier.nestedScroll(scrollBehavior.nestedScrollConnection),
     topBar = {
         CollapsingTopBar(
             scrollBehavior = scrollBehavior,
-            centeredTitleAndSubtitle = true, // set to false if you want the expanded title and subtitle to be at the left instead
             title = { Text(text = "All contacts") },
             subtitle = { Text(text = "17 contacts") },
         )

diff --git a/app/build.gradle b/app/build.gradle
@@ -11,7 +11,7 @@ android {
         minSdk 21
         targetSdk 32
         versionCode 1
-        versionName "1.0.0-beta01"
+        versionName "1.0.0-beta02"
 
         testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
         vectorDrawables {

diff --git a/app/src/main/java/com/germainkevin/collapsingtopbarcompose/MainActivity.kt b/app/src/main/java/com/germainkevin/collapsingtopbarcompose/MainActivity.kt
@@ -11,13 +11,9 @@ import androidx.compose.foundation.layout.height
 import androidx.compose.foundation.lazy.LazyColumn
 import androidx.compose.material.Scaffold
 import androidx.compose.material.icons.Icons
-import androidx.compose.material.icons.filled.Email
-import androidx.compose.material.icons.filled.Face
-import androidx.compose.material.icons.filled.Favorite
 import androidx.compose.material.icons.filled.Menu
 import androidx.compose.material.rememberScaffoldState
 import androidx.compose.material3.*
-import androidx.compose.runtime.remember
 import androidx.compose.runtime.rememberCoroutineScope
 import androidx.compose.ui.Modifier
 import androidx.compose.ui.input.nestedscroll.nestedScroll
@@ -28,7 +24,7 @@ import androidx.compose.ui.text.font.FontWeight
 import androidx.compose.ui.unit.dp
 import androidx.compose.ui.unit.sp
 import com.germainkevin.collapsingtopbar.CollapsingTopBar
-import com.germainkevin.collapsingtopbar.CollapsingTopBarDefaults
+import com.germainkevin.collapsingtopbar.rememberCollapsingTopBarScrollBehavior
 import com.germainkevin.collapsingtopbarcompose.ui.ContactListNames
 import com.germainkevin.collapsingtopbarcompose.ui.LeftDrawer
 import com.germainkevin.collapsingtopbarcompose.ui.MoreMenuIcons
@@ -64,21 +60,19 @@ class MainActivity : ComponentActivity() {
                     /**
                      * A scrollBehavior determines the behavior of the CollapsingTopBar when it is
                      * being scrolled and also to track the nestedScroll events*/
-                    val scrollBehavior = remember {
-                        CollapsingTopBarDefaults.scrollBehavior(
-                            isAlwaysCollapsed = false,
-                            isExpandedWhenFirstDisplayed = true,
-                            expandedTopBarMaxHeight = 256.dp,
-                        )
-                    }
+                    val scrollBehavior = rememberCollapsingTopBarScrollBehavior(
+                        isAlwaysCollapsed = false,
+                        isExpandedWhenFirstDisplayed = true,
+                        centeredTitleAndSubtitle = false,
+                        expandedTopBarMaxHeight = 256.dp,
+                    )
                     Scaffold(
                         modifier = Modifier.nestedScroll(scrollBehavior.nestedScrollConnection),
                         scaffoldState = scaffoldState,
                         drawerContent = { LeftDrawer(closeLeftDrawer = closeLeftDrawer) },
                         topBar = {
                             CollapsingTopBar(
                                 scrollBehavior = scrollBehavior,
-                                centeredTitleAndSubtitle = false,
                                 title = {
                                     Text(
                                         stringResource(id = R.string.all_contacts),

diff --git a/collapsingtopbar/build.gradle b/collapsingtopbar/build.gradle
@@ -24,7 +24,7 @@ afterEvaluate {
                 // You can then customize attributes of the publication as shown below.
                 groupId = 'com.germainkevin.collapsingtopbarcompose'
                 artifactId = 'collapsingtopbarcompose'
-                version = '1.0.0-beta01'
+                version = '1.0.0-beta02'
             }
         }
     }

diff --git a/collapsingtopbar/src/main/java/com/germainkevin/collapsingtopbar/CollapsingTopBar.kt b/collapsingtopbar/src/main/java/com/germainkevin/collapsingtopbar/CollapsingTopBar.kt
@@ -26,8 +26,6 @@ import androidx.compose.ui.unit.dp
  * This should typically be an [IconButton] or [IconToggleButton].
  * @param actions the actions displayed at the end of the [CollapsingTopBar]. This should typically
  * be [IconButton]s. The default layout here is a [Row], so icons inside will be placed horizontally.
- * @param centeredTitleAndSubtitle Whether the [title] and [subtitle] section should be centered or
- * at the start of the [CollapsingTopBar]
  * @param colors [CollapsingTopBarColors] that will be used to resolve the colors used for this
  * [CollapsingTopBar] in different states. See [CollapsingTopBarDefaults.colors].
  * @param contentPadding The padding of the content inside the [CollapsingTopBar]
@@ -45,7 +43,6 @@ fun CollapsingTopBar(
     subtitle: @Composable (() -> Unit)? = null,
     navigationIcon: @Composable (() -> Unit)? = null,
     actions: @Composable RowScope.() -> Unit = {},
-    centeredTitleAndSubtitle: Boolean = true,
     colors: CollapsingTopBarColors = CollapsingTopBarDefaults.colors(),
     contentPadding: PaddingValues = CollapsingTopBarDefaults.ContentPadding,
     elevation: Dp = 0.dp,

diff --git a/collapsingtopbar/src/main/java/com/germainkevin/collapsingtopbar/CollapsingTopBarDefaults.kt b/collapsingtopbar/src/main/java/com/germainkevin/collapsingtopbar/CollapsingTopBarDefaults.kt
@@ -3,7 +3,7 @@ package com.germainkevin.collapsingtopbar
 import androidx.compose.foundation.layout.PaddingValues
 import androidx.compose.material.contentColorFor
 import androidx.compose.material3.MaterialTheme
-import androidx.compose.runtime.Composable
+import androidx.compose.runtime.*
 import androidx.compose.ui.Modifier
 import androidx.compose.ui.graphics.Color
 import androidx.compose.ui.unit.Dp
@@ -23,6 +23,8 @@ object CollapsingTopBarDefaults {
      * @param isExpandedWhenFirstDisplayed When true, Sets the [CollapsingTopBar] to an expanded
      * state when first displayed on the UI by setting the [CollapsingTopBar]'s height to
      * [expandedTopBarMaxHeight]
+     * @param centeredTitleAndSubtitle Whether the title and subtitle should be centered when
+     * Expanded
      * @param collapsedTopBarHeight The height of the [CollapsingTopBar] when it's collapsed, the
      * default value is [defaultMinimumTopBarHeight]
      * @param expandedTopBarMaxHeight The height of the [CollapsingTopBar] when it's expended,
@@ -31,13 +33,15 @@ object CollapsingTopBarDefaults {
     fun scrollBehavior(
         isAlwaysCollapsed: Boolean = false,
         isExpandedWhenFirstDisplayed: Boolean = true,
+        centeredTitleAndSubtitle: Boolean = true,
         collapsedTopBarHeight: Dp = defaultMinimumTopBarHeight,
         expandedTopBarMaxHeight: Dp = defaultMaximumTopBarHeight,
     ): TopBarScrollBehavior = DefaultBehaviorOnScroll(
-        isAlwaysCollapsed,
-        isExpandedWhenFirstDisplayed,
-        collapsedTopBarHeight,
-        expandedTopBarMaxHeight
+        isAlwaysCollapsed = isAlwaysCollapsed,
+        isExpandedWhenFirstDisplayed = isExpandedWhenFirstDisplayed,
+        centeredTitleAndSubtitle = centeredTitleAndSubtitle,
+        collapsedTopBarHeight = collapsedTopBarHeight,
+        expandedTopBarMaxHeight = expandedTopBarMaxHeight
     )
 
     /**
@@ -50,4 +54,37 @@ object CollapsingTopBarDefaults {
         backgroundColor: Color = MaterialTheme.colorScheme.primary,
         contentColor: Color = contentColorFor(backgroundColor)
     ): CollapsingTopBarColors = DefaultCollapsingTopBarColors(backgroundColor, contentColor)
+}
+
+
+/**
+ * Specifies how the [CollapsingTopBar] should behave when a [Modifier.nestedScroll]
+ * is detected.
+ *
+ * @param isAlwaysCollapsed This will make this [CollapsingTopBar] stay collapsed and stay with
+ * the [collapsedTopBarHeight] height.
+ * @param isExpandedWhenFirstDisplayed When true, Sets the [CollapsingTopBar] to an expanded
+ * state when first displayed on the UI by setting the [CollapsingTopBar]'s height to
+ * [expandedTopBarMaxHeight]
+ * @param centeredTitleAndSubtitle Whether the title and subtitle should be centered when Expanded
+ * @param collapsedTopBarHeight The height of the [CollapsingTopBar] when it's collapsed, the
+ * default value is [defaultMinimumTopBarHeight]
+ * @param expandedTopBarMaxHeight The height of the [CollapsingTopBar] when it's expended, the
+ * default value is [defaultMaximumTopBarHeight]
+ * */
+@Composable
+fun rememberCollapsingTopBarScrollBehavior(
+    isAlwaysCollapsed: Boolean = false,
+    isExpandedWhenFirstDisplayed: Boolean = true,
+    centeredTitleAndSubtitle: Boolean = true,
+    collapsedTopBarHeight: Dp = defaultMinimumTopBarHeight,
+    expandedTopBarMaxHeight: Dp = defaultMaximumTopBarHeight,
+): TopBarScrollBehavior = remember {
+    CollapsingTopBarDefaults.scrollBehavior(
+        isAlwaysCollapsed = isAlwaysCollapsed,
+        isExpandedWhenFirstDisplayed = isExpandedWhenFirstDisplayed,
+        centeredTitleAndSubtitle = centeredTitleAndSubtitle,
+        collapsedTopBarHeight = collapsedTopBarHeight,
+        expandedTopBarMaxHeight = expandedTopBarMaxHeight
+    )
 }
diff --git a/collapsingtopbar/src/main/java/com/germainkevin/collapsingtopbar/TopBarScrollBehavior.kt b/collapsingtopbar/src/main/java/com/germainkevin/collapsingtopbar/TopBarScrollBehavior.kt
@@ -1,15 +1,12 @@
 package com.germainkevin.collapsingtopbar
 
-import androidx.compose.runtime.getValue
-import androidx.compose.runtime.mutableStateOf
-import androidx.compose.runtime.setValue
+import androidx.compose.runtime.*
 import androidx.compose.ui.Modifier
 import androidx.compose.ui.geometry.Offset
 import androidx.compose.ui.input.nestedscroll.NestedScrollConnection
 import androidx.compose.ui.input.nestedscroll.NestedScrollSource
 import androidx.compose.ui.unit.Dp
 
-
 /**
  * Defines how a [CollapsingTopBar] should behave during a [Modifier.nestedScroll] event.
  * */
@@ -45,6 +42,11 @@ interface TopBarScrollBehavior {
      * */
     var isExpandedWhenFirstDisplayed: Boolean
 
+    /**
+     * Whether the title and subtitle should be centered when Expanded
+     * */
+    var centeredTitleAndSubtitle: Boolean
+
     /**
      * Tracks how many times [topBarOffset]'s value is 0.0f. Useful when
      * [isExpandedWhenFirstDisplayed] is set to false, because we want the [CollapsingTopBar] to
@@ -76,6 +78,7 @@ interface TopBarScrollBehavior {
 class DefaultBehaviorOnScroll(
     override var isAlwaysCollapsed: Boolean,
     override var isExpandedWhenFirstDisplayed: Boolean,
+    override var centeredTitleAndSubtitle: Boolean,
     override var collapsedTopBarHeight: Dp,
     override var expandedTopBarMaxHeight: Dp,
 ) : TopBarScrollBehavior {