SimpleCarousel for Android

SimpleCarousel is an Android library contains components for carousel UI.

Installation

Add following dependency to download this library:

dependencies {
    // CarouselLayoutManager and core components
    implementation("com.cheonjaeung.simplecarousel.android:simplecarousel:<version>")

    // CarouselPager and pager components (supported 0.5.0 or later version)
    implementation("com.cheonjaeung.simplecarousel.android:simplecarousel-pager:<version>")
}

Getting Started

carousel-sample_crop.mp4

You can just set the CarouselLayoutManager to make your RecyclerView work as a carousel. It can be set programmatically or as a XML attribute.

<androidx.recyclerview.widget.RecyclerView
    android:id="@+id/recyclerView"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    app:layoutManager="com.cheonjaeung.simplecarousel.android.CarouselLayoutManager" />

val recyclerView = findViewById<RecyclerView>(R.id.recyclerView)
recyclerView.layoutManager = CarouselLayoutManager()

There is circular mode in the CarouselLayoutManager, enabled as default. When it is enabled, the layout manager places first/last item next to last/first item. You can set circular programmatically.

val layoutManager = CarouselLayoutManager()
layoutManager.circular = true

Pager

pager-sample_crop.mp4

This library provides pager components via simplecarousel-pager artifact. In this artifact, there is a View named CarouselPager. Place this view in your layout.

<com.cheonjaeung.simplecarousel.android.pager.CarouselPager
    android:id="@+id/pager"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    android:orientation="horizontal" />

Attributes

Name	Type	Description
android:orientation	horizontal or vertical	Orientation of the pager
circular	boolean	Enable circular mode if true
userInputEnabled	boolean	Enable user input if true

The CarouselPager uses RecyclerView.Adapter like ViewPager2. Set an adapter to your CarouselPager.

val carouselPager = findViewById<CarouselPager>(R.id.pager)
carouselPager.adapter = ExampleAdapter()

Pager Events

CarouselPager uses ViewPager2's OnPageChangeCallback and PageTransformer. Callbacks and transformers can be used for both views. But if a callback is designed for ViewPager2, it can't used for CarouselPager. For example, MarginPageTransformer uses ViewPager2 internally. You must use CarouselMarginPageTransformer instead of MarginPageTransformer.

CarouselFragmentStateAdapter

FragmentStateAdapter of ViewPager2 library supports only ViewPager2. Instead of it, this library provides CarouselFragmentStateAdapter for using fragments as pager items.

License

SimpleCarousel is licensed under the Apache License 2.0.

Copyright 2024 Cheon Jaeung

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

    https://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.