Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/VictorAlbertos/SwipeCoordinator
A coordinator layout for Android views to animate and typify touch events as swipe gestures
https://github.com/VictorAlbertos/SwipeCoordinator
Last synced: 3 months ago
JSON representation
A coordinator layout for Android views to animate and typify touch events as swipe gestures
- Host: GitHub
- URL: https://github.com/VictorAlbertos/SwipeCoordinator
- Owner: VictorAlbertos
- License: apache-2.0
- Created: 2016-10-22T12:13:10.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2020-08-09T10:36:44.000Z (about 4 years ago)
- Last Synced: 2024-06-16T01:32:54.389Z (5 months ago)
- Language: Java
- Size: 638 KB
- Stars: 253
- Watchers: 12
- Forks: 40
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
- awesome-github-android-ui - SwipeCoordinator - 简化动画滑动视图进程 (进度条)
README
# SwipeCoordinator
[](http://android-arsenal.com/details/1/4556)
SwipeCoordinator simplifies the processs of implementing animated swipeable views. It links a view with its parent as a single behavioural unit constrained by the parent boundaries. SwipeCoordinator supports both *left-to-right* and *top-to-bottom* direction.
## SetUp
Add to top level *gradle.build* file
```gradle
allprojects {
repositories {
maven { url "https://jitpack.io" }
}
}
```
Add to app module *gradle.build* file
```gradle
dependencies {
compile 'com.github.VictorAlbertos:SwipeCoordinator:0.0.2'
}
```
## Usage
Identify the swipeable view with `@id/swipeable_view` attribute. Thew ViewGroup containing the swipeable view can not declare any padding attribute, as such as the swipeable view can not declare any margin. Otherwise the calculations will be misleading.
```xml
```
Create an instance of `SwipeCoordinator` suppliyng as argument constructor the parent layout of the swipeable view, and the expected direction for the swipe gesture.
```java
ViewGroup parentSwipeableView = (ViewGroup) findViewById(R.id.parent_swipeable_view);
SwipeCoordinator swipeCoordinator =
new SwipeCoordinator(parentSwipeableView, SwipeDirection.LEFT_TO_RIGHT);
```
### ActionUpSwipeListener
`ActionUpSwipeListener` signals the `MotionEvent` `ACTION_UP` of the swipeable view providing a `boolean` as a flag to indicate if the action took place surpassing the threshold value. This callback is the place to determine if the user fulfilled the motion event.
```java
swipeCoordinator.setOnActionUpSwipeListener(new SwipeCoordinator.ActionUpSwipeListener() {
@Override public void onActionUp(boolean thresholdReached) {
if (thresholdReached) Toast.makeText(this, "Approved", Toast.LENGTH_SHORT).show();
else Toast.makeText(this, "Pending", Toast.LENGTH_SHORT).show();
}
});
```
### ProgressListener
`ProgressListener` emits the progress of the swipeable view. From 0 to 1, this value represent in percentage the left distance to its fulfilled position. This callback is the perfect place to create animations based on the progress value.
```java
swipeCoordinator.setProgressListener(new SwipeCoordinator.ProgressListener() {
@Override public void onProgress(float progress) {
tvAccepted.setScaleX(progress);
tvAccepted.setScaleY(progress);
tvAccepted.setAlpha(progress);
}
});
```
### Survive to config changes
`SwipeCoordinator` exposes `doSwipe` method. It translates the swipeable view to the fulfilled stage and calls `ProgressListener::onProgress(progress)` with a value of 1.0 to restore all the dependent state views (scale, alpha...).
### Customization
#### Threshold
The value in percentage of the threshold to signal it as reached when the user drops the swipeable view. From 0 to 1, being the default value 0.7.
```java
swipeCoordinator.setThreshold(0.5f);
```
#### Variance percentage
Increment (if number greater than 1.0) or decrement (if number less than 1.0) the duration of the rearrange animation performed when the user drops the swipeable view. Default value is 1.0.
```java
swipeCoordinator.setVariancePercentage(0.5f);
```
### Examples
The module [test-sample](https://github.com/VictorAlbertos/SwipeCoordinator/tree/master/test-sample) contains both example and UI test driven by Espresso.
## Author
**Víctor Albertos**
*
*
*
## Another author's libraries:
* [BreadcrumbsView](https://github.com/VictorAlbertos/BreadcrumbsView): A customizable Android view for paginated forms.
* [Mockery](https://github.com/VictorAlbertos/Mockery): Android and Java library for mocking and testing networking layers with built-in support for Retrofit.
* [ReactiveCache](https://github.com/VictorAlbertos/ReactiveCache): A reactive cache for Android and Java which honors the Observable chain.
* [RxActivityResult](https://github.com/VictorAlbertos/RxActivityResult): A reactive-tiny-badass-vindictive library to break with the OnActivityResult implementation as it breaks the observables chain.