# RecyclerView.EdgeEffectFactory

Artifact: [androidx.recyclerview:recyclerview](https://developer.android.com/jetpack/androidx/releases/recyclerview) [View Source](https://cs.android.com/search?q=file:androidx/recyclerview/widget/RecyclerView.java+class:androidx.recyclerview.widget.RecyclerView.EdgeEffectFactory) Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/recyclerview#1.0.0)

*** ** * ** ***


```
public class RecyclerView.EdgeEffectFactory
```

<br />

*** ** * ** ***

EdgeEffectFactory lets you customize the over-scroll edge effect for RecyclerViews.

| See also |
|---|---|
| `https://developer.android.com/reference/androidx/recyclerview/widget/RecyclerView#setEdgeEffectFactory(androidx.recyclerview.widget.RecyclerView.EdgeEffectFactory)` |   |

## Summary

| ### Nested types |
|---|
| `@https://developer.android.com/reference/java/lang/annotation/Retention.html(value = https://developer.android.com/reference/java/lang/annotation/RetentionPolicy.html#SOURCE) @https://developer.android.com/reference/androidx/annotation/IntDef(value = ) public annotation https://developer.android.com/reference/androidx/recyclerview/widget/RecyclerView.EdgeEffectFactory.EdgeDirection` |

| ### Constants |
|---|---|
| `static final int` | `https://developer.android.com/reference/androidx/recyclerview/widget/RecyclerView.EdgeEffectFactory#DIRECTION_BOTTOM() = 3` Direction constant for the bottom edge |
| `static final int` | `https://developer.android.com/reference/androidx/recyclerview/widget/RecyclerView.EdgeEffectFactory#DIRECTION_LEFT() = 0` Direction constant for the left edge |
| `static final int` | `https://developer.android.com/reference/androidx/recyclerview/widget/RecyclerView.EdgeEffectFactory#DIRECTION_RIGHT() = 2` Direction constant for the right edge |
| `static final int` | `https://developer.android.com/reference/androidx/recyclerview/widget/RecyclerView.EdgeEffectFactory#DIRECTION_TOP() = 1` Direction constant for the top edge |

| ### Public constructors |
|---|
| `https://developer.android.com/reference/androidx/recyclerview/widget/RecyclerView.EdgeEffectFactory#EdgeEffectFactory()()` |

| ### Protected methods |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/android/widget/EdgeEffect.html` | `https://developer.android.com/reference/androidx/recyclerview/widget/RecyclerView.EdgeEffectFactory#createEdgeEffect(androidx.recyclerview.widget.RecyclerView,int)( @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/recyclerview/widget/RecyclerView view, @https://developer.android.com/reference/androidx/recyclerview/widget/RecyclerView.EdgeEffectFactory.EdgeDirection int direction )` Create a new EdgeEffect for the provided direction. |

## Constants

### DIRECTION_BOTTOM

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/recyclerview#1.0.0)

```
public static final int DIRECTION_BOTTOM = 3
```

Direction constant for the bottom edge

### DIRECTION_LEFT

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/recyclerview#1.0.0)

```
public static final int DIRECTION_LEFT = 0
```

Direction constant for the left edge

### DIRECTION_RIGHT

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/recyclerview#1.0.0)

```
public static final int DIRECTION_RIGHT = 2
```

Direction constant for the right edge

### DIRECTION_TOP

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/recyclerview#1.0.0)

```
public static final int DIRECTION_TOP = 1
```

Direction constant for the top edge

## Public constructors

### EdgeEffectFactory

Added in 1.0.0

```
public EdgeEffectFactory()
```

## Protected methods

### createEdgeEffect

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/recyclerview#1.0.0)

```
protected @NonNull EdgeEffect createEdgeEffect(
    @NonNull RecyclerView view,
    @RecyclerView.EdgeEffectFactory.EdgeDirection int direction
)
```

Create a new EdgeEffect for the provided direction.