Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/r0adkll/Slidr

Easily add slide to dismiss functionality to an Activity
https://github.com/r0adkll/Slidr

android java library swipe-gestures

Last synced: about 1 month ago
JSON representation

Easily add slide to dismiss functionality to an Activity

Lists

README 

        
# Deprecated

This library is no longer supported as the modern convention of building Android apps switches from multi-Activity to single-Activity. If you are looking for similar behavior look into supporting Android's new [predictive back handling](https://developer.android.com/guide/navigation/custom-back/predictive-back-gesture)



Slidr

================

[![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.r0adkll/slidableactivity/badge.svg?style=flat)](https://maven-badges.herokuapp.com/maven-central/com.r0adkll/slidableactivity) [![Android Arsenal](https://img.shields.io/badge/Android%20Arsenal-Slidr-brightgreen.svg?style=flat)](https://android-arsenal.com/details/1/1364)

[![Build Status](https://travis-ci.org/r0adkll/Slidr.svg?branch=master)](https://travis-ci.org/r0adkll/Slidr)



Easily add slide-to-dismiss functionality to your Activity by calling `Slidr.attach(this)` in your `onCreate(..)` method.



![Slidr Example](images/slidr_gif.gif "Gif Example")



## Usage



An example usage:



```java

public class ExampleActivity extends  {



	@Override

	public void onCreate(Bundle savedInstanceState){

		super.onCreate(savedInstanceState);

		setContentView(R.layout.activity_example);

		int primary = getResources().getColor(R.color.primaryDark);

		int secondary = getResources().getColor(R.color.secondaryDark);

		Slidr.attach(this, primary, secondary);

	}



}

```



or



```java

public class ExampleActivity extends  {



	@Override

	public void onCreate(Bundle savedInstanceState){

		super.onCreate(savedInstanceState);

		setContentView(R.layout.activity_example);

        	Slidr.attach(this);

	}



}

```



## Fragments

The activity must extend FragmentActivity.

Set the background to the main container of the activity in the xml `background="@android:color/transparent"`.

Add the following code to the Fragment:



```java

// This interface is needed to see if the fragment

// is resuming after creation (Slidr to be attached) or

// simply from the background (app was paused before).

SlidrInterface slidrInterface;



@Override

public void onResume() {

    super.onResume();

    if(slidrInterface == null)

        slidrInterface = Slidr.replace(getView().findViewById(R.id.content_container), new SlidrConfig.Builder().position(SlidrPosition.LEFT).build());

}

```

In the xml of the fragment's view, the root view must be a FrameLayout with the same background set to the activity before. Add a child viewgroup to it with the id content_container. E.g.:



```xml



    

    

	

		...other stuff



    



```

Remember: you have to add new Fragments with:  



```java 

getSupportFragmentManager().beginTransaction()

	.add(R.id.fragment_container, YourFragmentClass.newInstance())

	.commit();

```



where fragment_container is the id of a FrameLayout inside the activity's xml.



## Configuring



```java

SlidrConfig config = new SlidrConfig.Builder()

	.primaryColor(getResources().getColor(R.color.primary)

	.secondaryColor(getResources().getColor(R.color.secondary)

	.position(SlidrPosition.LEFT|RIGHT|TOP|BOTTOM|VERTICAL|HORIZONTAL)

	.sensitivity(1f)

	.scrimColor(Color.BLACK)

	.scrimStartAlpha(0.8f)

	.scrimEndAlpha(0f)

	.velocityThreshold(2400)

	.distanceThreshold(0.25f)

	.edge(true|false)

	.edgeSize(0.18f) // The % of the screen that counts as the edge, default 18%

	.listener(new SlidrListener(){...})

	.build();



Slidr.attach(this, config);



```



---



`Slidr.attach(...)` will return a `SlidrInterface` which gives you access to two methods:



```java

SlidrInterface.lock();

SlidrInterface.unlock();

```



These methods lock or unlock the slidable touch interface.



The theme that you use for your sliding activity must have these attributes set:



```xml

true  

@android:color/transparent

```



Then in the layout of your activity you must give it a background like this;



```xml



    ...

```



## Including in your project



Include this line in your gradle build file:



```groovy

implementation 'com.r0adkll:slidableactivity:2.1.0'

```



## Author



-	Drew Heavner, **[r0adkll](http://r0adkll.com)**



## License



	Copyright (c) 2014 Drew Heavner



	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.