CardStackView

Paging

To implement paging (loading more items as the user swipes), use one of the following methods:

1. Use DiffUtil.
2. Manually call RecyclerView.Adapter.notifyItemRangeInserted(int position, int itemCount).

Caution: Do NOT call RecyclerView.Adapter.notifyDataSetChanged for paging, as it resets the top position and can cause performance issues.

Reloading

To reload the entire dataset, you can call RecyclerView.Adapter.notifyDataSetChanged.

To use CardStackView, you need to initialize it with a CardStackLayoutManager and a CardStackAdapter. This is typically done in your Activity or Fragment after finding the view by its ID.

val cardStackView = findViewById<CardStackView>(R.id.card_stack_view)
cardStackView.layoutManager = CardStackLayoutManager()
cardStackView.adapter = CardStackAdapter()

You can add overlay views (e.g., for showing 'Like' or 'Dislike' labels) by including a FrameLayout in your RecyclerView item layout. The library looks for specific layout IDs to identify the overlay position.

Supported Layout IDs:

• left_overlay (Left)
• right_overlay (Right)
• top_overlay (Top)
• bottom_overlay (Bottom)

You can control the alpha change rate of these overlays by setting a custom interpolator via CardStackLayoutManager.setOverlayInterpolator(interpolator).

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

    <!-- Set your left overlay -->

</FrameLayout>

Add the following dependency to your build.gradle file to include CardStackView in your Android project:

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

Use these methods for advanced navigation within the stack:

• CardStackView.smoothScrollToPosition(int position): Scrolls to the specified position with an animation.
• CardStackView.scrollToPosition(int position): Scrolls to the specified position immediately without animation.

To respond to user interactions and card lifecycle events, implement the CardStackListener interface. The following methods are available:

• onCardDragging(Direction direction, float ratio): Called continuously while the card is being dragged. direction indicates the swipe direction, and ratio represents the progress of the drag.
• onCardSwiped(Direction direction): Called when the card has been successfully swiped.
• onCardRewound(): Called when the card is returned to the stack (rewound).
• onCardCanceled(): Called when the card drag is canceled (e.g., dragged less than the threshold).
• onCardAppeared(View view, int position): Called when a specific card view appears on screen.
• onCardDisappeared(View view, int position): Called when a specific card view disappears from the screen.

You can trigger a single swipe programmatically using CardStackView.swipe(). You can also customize the swipe animation using SwipeAnimationSetting.Builder() and applying it via CardStackLayoutManager.setSwipeAnimationSetting(setting).

CardStackView.swipe()

// With custom animation
val setting = SwipeAnimationSetting.Builder()
        .setDirection(Direction.Right)
        .setDuration(Duration.Normal.duration)
        .setInterpolator(AccelerateInterpolator())
        .build()
CardStackLayoutManager.setSwipeAnimationSetting(setting)
CardStackView.swipe()

You can rewind the stack programmatically using CardStackView.rewind(). Custom rewind animations can be configured via RewindAnimationSetting.Builder() and applied using CardStackLayoutManager.setRewindAnimationSetting(setting).

CardStackView.rewind()

// With custom animation
val setting = RewindAnimationSetting.Builder()
        .setDirection(Direction.Bottom)
        .setDuration(Duration.Normal.duration)
        .setInterpolator(DecelerateInterpolator())
        .build()
CardStackLayoutManager.setRewindAnimationSetting(setting)
CardStackView.rewind()