Android SliderView Sample App

This is a sample Android project to demonstrate how to use Android Slider Views library created by sung2063.
The sample app includes using of Horizontal and Vertical CarouselViews and SlideshowView.

💖 Sponsor

Android Slider Views library updates regularly. Your valuable sponsorship helps me contributing more features and maintaining the library. Support me for building more interesting projects! 💜

🎬 GIF Images

Horizontal Carousel	Carousel w/ Custom Indicator	Vertical Carousel

🔢 Instruction

1. Clone the AndroidSliderViewSample repository to your local computer
2. Open the project on Android Studio
3. Run the program either on Android virtual device or your Android device

📖 How To Use Slider Views

1. Setup your Android project setting

Minimum SDK Version: 21 or greater (Update in your app level build.gradle)
Supported Programming Language: Java Add following snippet code in your project level build.gradle.

android {
    compileOptions {
        sourceCompatibility JavaVersion.VERSION_1_8
        targetCompatibility JavaVersion.VERSION_1_8
    }
}

2. Add required library

First, include following jitpack url inside maven block in your project level build.gradle.

allprojects {
    repositories {
        ...
        maven { url 'https://jitpack.io' }
    }
}

Next, add the SliderViews and required libraries in app level build.gradle and sync the gradle file.

implementation 'com.github.sung2063:AndroidSliderViewsLibrary:1.7'
implementation 'com.google.android.material:material:1.1.0'

Now you are ready to use SliderView Library. You can start creating CarouselView and SlideshowView.

CarouselView

CarouselView can be used for your application intro and show multiple images or videos in one layout with scrolling. CarouselView by Sliders library supports both horizontal and vertical scrolls.

First, create a CarouselView in your xml file.

<com.sung2063.sliders.carousel.CarouselView
        android:id="@+id/carousel_view"
        android:layout_width="match_parent"
        android:layout_height="match_parent"
        app:showIndicator="true"
        app:scrollDirection="horizontal"
        app:showSlideNumber="true" />

Set scrollDirection attribution to horizontal for creating horizontal carousel and vertical for vertical carousel.

In your onCreate() method in Activity, create your own custom layouts, add layouts to List, and start the carousel. You can add up to 10 layouts in the CarouselView.

From version 1.6, you can also include sub-title of each slides. In that case, you need to make DescriptiveSlideModel objects that holds slide layout and sub-title and add to List<DescriptiveSlideModel>. Also, do not forget to add app:showSubTitle="true" into your CarouselView in xml. The default is false.

CarouselView carouselView = findViewById(R.id.carousel_view);

// Create your own layouts...
// Create List<ViewGroup> object or List<DescriptiveSlideModel>...
// Add your layouts to list object...

carouselView.setSlideList(layoutList);
carouselView.launch();

Your CarouselView is now displayed on your app! 👏

SlideshowView

SlideshowView can be used to show the multiple layouts by certain period of time. You can set how much time you want to show each layout to the user.

First, create a SlideshowView in your xml file.

<com.sung2063.sliders.slideshow.SlideshowView
        android:id="@+id/slideshow_view"
        android:layout_width="match_parent"
        android:layout_height="match_parent"
        app:showIndicator="true"
        app:delayTimePeriod="5"
        app:showSlideNumber="true" />

In your onCreate() method in Activity, create your own custom layouts, add layouts to List, and start the slideshow. You can add up to 10 layouts in the SlideshowView.

From version 1.6, you can also include sub-title of each slides. In that case, you need to make DescriptiveSlideModel objects that holds slide layout and sub-title and add to List<DescriptiveSlideModel>. Also, do not forget to add app:showSubTitle="true" into your SlideshowView in xml. The default is false.

SlideshowView slideshowView = findViewById(R.id.slideshow_view);

// Create your own layouts...
// Create List<ViewGroup> object or List<DescriptiveSlideModel>...
// Add your layouts to list object...

slideshowView.setSlideList(layoutList);
slideshowView.launch();

Your SlideshowView is now displayed on your app! 👏

Add Callback Action

You can also get callback from slider when it is clicked. On your Activity, create a SliderListener object with implementing own action and pass this object to the view by calling setSliderListener. Here is the snippet code how to implement the callback:

// Create a callback interface
SliderListener sliderListener = position -> {
     // TODO: Do something when slide is clicked
};

// Set callback object to the View
carouselView.setSliderListener(sliderListener);    // If you are using Carousel
slideshowView.setSliderListener(sliderListener);   // If you are using Slideshow

🎨 Attributions

Here are available attributions you can use to modify your slider views.

CarouselView

SlideshowView

📚 Library

AndroidSlidersView library by @sung2063

🌟 Contributor

Sung Hyun Back (@sung2063)