https://github.com/saket/flick

Flick dismiss all the things!
https://github.com/saket/flick

flick gestures

Last synced: 1 day ago
JSON representation

Flick dismiss all the things!

• Host: GitHub
• URL: https://github.com/saket/flick
• Owner: saket
• License: apache-2.0
• Created: 2018-08-02T15:54:51.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2021-03-08T17:37:49.000Z (almost 4 years ago)
• Last Synced: 2025-01-13T04:06:58.987Z (9 days ago)
• Topics: flick, gestures
• Language: Kotlin
• Homepage:
• Size: 8.66 MB
• Stars: 467
• Watchers: 4
• Forks: 20
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# Flick

![Flick in action](https://github.com/saket/Flick/blob/master/screenshots/flick_demo.gif)

Flick is a tiny library for flick dismissing images (or anything actually). You can read the announcement [blog post](http://saket.me/?p=707) to learn how Flick was created.

```

implementation 'me.saket:flick:1.7.0'

```

## Usage

The [sample project](https://github.com/saket/Flick/tree/master/sample/src/main/java/me/saket/flick/sample) contains best practices for using Flick. You can [download its APK from here](https://github.com/saket/Flick/releases) for trying it out on your phone.

```xml

  

```

Flick requires you to manually provide the content dimensions instead of it relying on the content View's dimensions. This is useful for scalable `ImageViews`, where the height will always be set to match-parent, but the actual image may or may not be consuming the entire space.

```kotlin

val callbacks = object : FlickCallbacks {

  override fun onMove(@FloatRange(from = -1.0, to = 1.0) moveRatio: Float) {

    // The content is being moved around. Updating the

    // background dimming is a good usecase for this callback.

  }

  override fun onFlickDismiss(animationDuration: Long) {

    // The content was been flicked and the Activity should

    // be dismissed once the flick animation is complete.

    flickDismissLayout.postDelayed({ finish() }, animationDuration)

  }

}

val contentSizeProvider = ContentSizeProvider2 { imageView.zoomedImageHeight() },

flickDismissLayout.gestureListener = FlickGestureListener(context, contentSizeProvider, callbacks)

```

**Intercepting flicks**

For usecases where the content can be scrolled further in the direction of the gesture, Flick exposes a way for intercepting flick detection,

```kotlin

// Block flick gestures if the image can pan further.

gestureListener.gestureInterceptor = { scrollY ->

  val isScrollingUpwards = scrollY < 0

  val directionInt = if (isScrollingUpwards) -1 else +1

  val canPanFurther = imageView.canScrollVertically(directionInt)

  when {

    canPanFurther -> InterceptResult.INTERCEPTED

    else -> InterceptResult.IGNORED

  }

}

```

## License

```

Copyright 2019 Saket Narayan.

Licensed under the Apache License, Version 2.0 (the "License");

you may not use this file except in compliance with the License.

You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software

distributed under the License is distributed on an "AS IS" BASIS,

WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

See the License for the specific language governing permissions and

limitations under the License.

```