CardStackView

Additional

Language
Java
Version
N/A
Created
Mar 20, 2016
Updated
Dec 9, 2018
Owner
Yuya Kaido (yuyakaido)
Contributors
Yuya Kaido (yuyakaido)
TakahisaKurimura (t-kurimura)
Sroka
sinsaitou
katsuya-yamada-eureka
5
Activity
Badge
Generate
Download
Source code
APK file

Announcement

CardStackView

Overview

Contents

Setup

CardStackLayoutManager manager = new CardStackLayoutManager();
CardStackAdapter adapter = new CardStackAdapter();
CardStackView cardStackView = findViewById(R.id.card_stack_view);
cardStackView.setLayoutManager(manager);
cardStackView.setAdapter(adapter);

Features

Manual Swipe

Automatic Swipe

CardStackView.swipe();

You can set custom swipe animation.

SwipeAnimationSetting setting = new SwipeAnimationSetting.Builder()
    .setDirection(Direction.Right)
    .setDuration(200)
    .setInterpolator(new AccelerateInterpolator())
    .build();
CardStackLayoutManager.setSwipeAnimationSetting(setting);
CardStackView.swipe();

Cancel

Manual swipe is canceled when the card is dragged less than threshold.

Rewind

CardStackView.rewind();

You can set custom rewind animation.

RewindAnimationSetting setting = new RewindAnimationSetting.Builder()
    .setDirection(Direction.Bottom)
    .setDuration(200)
    .setInterpolator(new DecelerateInterpolator())
    .build();
CardStackLayoutManager.setRewindAnimationSetting(setting);
CardStackView.rewind();

Overlay

Value Sample
Left
Right

Put overlay view in your item layout of RecyclerView.

<FrameLayout
    android:id="@+id/left_overlay"
    android:layout_width="match_parent"
    android:layout_height="match_parent">

    <!-- Set your left overlay -->

</FrameLayout>
Value Layout ID
Left left_overlay
Right right_overlay
Top top_overlay
Bottom bottom_overlay

Paging

You can implement paging by using following two ways.

  1. Use DiffUtil.
  2. Call RecyclerView.Adapter.notifyItemRangeInserted manually.

Caution

You should not call RecyclerView.Adapter.notifyDataSetChanged for paging because this method will reset top position and maybe occur a perfomance issue.

Reloading

You can implement reloading by calling RecyclerView.Adapter.notifyDataSetChanged.

Stack From

Default Value Sample
None
Top
Bottom
Left
Right
CardStackLayoutManager.setStackFrom(StackFrom.None);

Visible Count

Default Value Sample
2
3
4
CardStackLayoutManager.setVisibleCount(3);

Translation Interval

Default Value Sample
4dp
8dp
12dp
CardStackLayoutManager.setTranslationInterval(8f);

Scale Interval

Default Value Sample
95%
90%
CardStackLayoutManager.setScaleInterval(0.95f);

Max Degree

Default Value Sample
20°
CardStackLayoutManager.setMaxDegree(20f);

Swipe Direction

Default Value Sample
Horizontal
Vertical
Freedom
CardStackLayoutManager.setDirections(Direction.HORIZONTAL);

Swipe Threshold

Default Value Sample
30%
10%
CardStackLayoutManager.setSwipeThreshold(0.3f);

Swipe Restriction

CanScrollHorizontal CanScrollVertical Sample
true true
true false
false true
false false
CardStackLayoutManager.setCanScrollHorizontal(true);
CardStackLayoutManager.setCanScrollVertical(true);

Public Interfaces

Basic usages

Method Description
CardStackView.swipe() You can swipe once by calling this method.
CardStackView.rewind() You can rewind once by calling this method.
CardStackLayoutManager.getTopPosition() You can get position displayed on top.
CardStackLayoutManager.setStackFrom(StackFrom stackFrom) You can set StackFrom.
CardStackLayoutManager.setTranslationInterval(float translationInterval) You can set TranslationInterval.
CardStackLayoutManager.setScaleInterval(float scaleInterval) You can set ScaleInterval.
CardStackLayoutManager.setSwipeThreshold(float swipeThreshold) You can set SwipeThreshold.
CardStackLayoutManager.setMaxDegree(float maxDegree) You can set MaxDegree.
CardStackLayoutManager.setDirections(List directions) You can set Direction.
CardStackLayoutManager.setCanScrollHorizontal(boolean canScrollHorizontal) You can set CanScrollHorizontal.
CardStackLayoutManager.setCanScrollVertical(boolean canScrollVertical) You can set CanScrollVertical.
CardStackLayoutManager.setSwipeAnimationSetting(SwipeAnimationSetting swipeAnimationSetting) You can set SwipeAnimationSetting.
CardStackLayoutManager.setRewindAnimationSetting(RewindAnimationSetting rewindAnimationSetting) You can set RewindAnimationSetting.

Advanced usages

Method Description
CardStackView.smoothScrollToPosition(int position) You can scroll any position with animation.
CardStackView.scrollToPosition(int position) You can scroll any position without animation.

Callbacks

Method Description
CardStackListener.onCardDragging(Direction direction, float ratio) This method is called while the card is dragging.
CardStackListener.onCardSwiped(Direction direction) This method is called when the card is swiped.
CardStackListener.onCardRewound() This method is called when the card is rewinded.
CardStackListener.onCardCanceled() This method is called when the card is dragged less than threshold.

Migration Guide

Migration of Features

1.x 2.x
Move to Origin Cancel
Reverse Rewind
ElevationEnabled Stack From
TranslationDiff Translation Interval
ScaleDiff Scale Interval
SwipeEnabled Swipe Restriction

Migration of Callbacks

1.x 2.x
CardStackView.CardEventListener CardStackListener
onCardDragging(float percentX, float percentY) onCardDragging(Direction direction, float ratio)
onCardSwiped(SwipeDirection direction) onCardSwiped(Direction direction)
onCardReversed() onCardRewound()
onCardMovedToOrigin() onCardCanceled()
onCardClicked(int index) This method is no longer provided. Please implement in your item of RecyclerView.

Installation

LatestVersion is

dependencies {
    implementation "com.yuyakaido.android:card-stack-view:${LatestVersion}"
}

License

Copyright 2018 yuyakaido

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.