Skip to content

Latest commit

 

History

History
116 lines (96 loc) · 3.53 KB

README.md

File metadata and controls

116 lines (96 loc) · 3.53 KB
Raw

BumbleCardSwipe

Jetpack Compose Modifier that allows you to achieve bumble like swipe gesture

Demo

WhatsApp.Video.2023-11-01.at.7.24.48.PM.mp4

How to enable swipe gesture

  • Follow the below steps to use the bumble like swipe gesture

1. Add dependency

Kotlin Scripts

  • Add the below to your app build.gradle :
  dependencies {
    .....
    implementation("com.github.PratyushSingh07:BumbleCardSwipe:1.0.0")\
  }
  • After you have done this make sure to add the below snippet to your settings.gradle:
  dependencyResolutionManagement {
    repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
    repositories {
        mavenCentral()
        maven {
            setUrl("https://jitpack.io")
        }
    }
}

Groovy

  • Add the dependency to your app build.gradle:
  dependencies {
	        implementation 'com.github.PratyushSingh07:BumbleCardSwipe:Tag'
	}
  • Add below snippet in your root build.gradle at the end of repositories:
    dependencyResolutionManagement {
		repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
		repositories {
			mavenCentral()
			maven { url 'https://jitpack.io' }
		}
	}

2. Usage

  • Add the Modifier.swipeableCard() into your @Composable function to enable Bumble like card gestures:
Box(
   modifier = Modifier
       .fillMaxSize()
       .swipeableCard(
           onSwipe = { direction ->
               println("The card was swiped towards $direction")
           }
       )
)
  • onSwipe is used when the card has been completely swiped off the screen
  • Modifier.swipeableCard() has another attribute besides onSwipe that allows user to enable a spring like effect in case the swipe was canceled
  • To enable it you need to use the below snippet:
 Box(
    modifier = Modifier
        .fillMaxSize()
        .swipeableCard(
            onSwipe = { direction ->
                println("The card was swiped towards $direction")
            },
            enableSpringEffect = true
        )
)
  • By default the spring effect is set to false hence you have to set it to true in case you want to use it
  • Under the hood spring effect uses spring(dampingRatio = Spring.DampingRatioMediumBouncy) to produce the spring effect

Developers

License

MIT License

Copyright (c) 2023 Pratyush Singh

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.