-
Notifications
You must be signed in to change notification settings - Fork 79
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
9cbecde
commit 69a0f55
Showing
1 changed file
with
1 addition
and
92 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,92 +1 @@ | ||
| <h1 align="center"> Carousel Recyclerview </h1> | ||
|
|
||
| <p align="center"> | ||
| Create carousel effect in recyclerview with the CarouselRecyclerview in a simple way. | ||
| </p> | ||
| </br> | ||
| <p align="center"> | ||
| <a href="https://opensource.org/licenses/Apache-2.0"><img alt="License" src="https://img.shields.io/badge/License-Apache%202.0-blue.svg"/></a> | ||
| <a href="http://developer.android.com/index.html"><img alt="License" src="https://img.shields.io/badge/platform-android-green.svg"/></a> | ||
| <a href="https://android-arsenal.com/api?level=16"><img alt="License" src="https://img.shields.io/badge/API-16%2B-brightgreen.svg"/></a> | ||
| </p> | ||
| </br> | ||
|
|
||
|  | ||
|
|
||
| ## Usage | ||
|
|
||
| ### Basic Example for Kotlin | ||
| Here is a basic example of implementing carousel recyclerview in koltin files (activity or fragment) with attribute. | ||
|
|
||
| ```kotlin | ||
| val carouselRecyclerview = findViewById<CarouselRecyclerview>(R.id.recycler) | ||
| carouselRecyclerview.adapter = adapter | ||
|
|
||
| ``` | ||
| ### Basic Example for XML | ||
| Here is a basic example of implementing carousel recyclerview in layout xml. | ||
|
|
||
| ```xml | ||
| <com.jackandphantom.carouselrecyclerview.CarouselRecyclerview | ||
| android:layout_width="match_parent" | ||
| android:layout_height="wrap_content" | ||
| android:id="@+id/recycler"/> | ||
| ``` | ||
|
|
||
| Property infinite and 3D on Item enabled |Property infinite and alpha on Item enabled | | ||
| | :---------------: | :---------------: | | ||
| | <img src="./preview/3ditem.gif" align="center" width="70%"/> | <img src="./preview/alpha.gif" align="center" width="70%"/> | | ||
|
|
||
| ## API Methods | ||
|
|
||
| Method | Description | Default | ||
| ---|--- |--- | ||
| fun set3DItem(is3DItem: Boolean) | Make the view tilt according to their position, middle position does not tilt. | false | ||
| fun setInfinite(isInfinite: Boolean) | Create the loop of the given view means there is no start or end, but provided position in the interface will be correct. | false | ||
| fun setFlat(isFlat: Boolean) | Make the flat layout in the layout manager of the reyclerview | false | ||
| fun setAlpha(isAlpha: Boolean) | Set the alpha for each item depends on the position in the layout manager | false | ||
| fun setIntervalRatio(ratio: Float) | Set the interval ratio which is gap between items (views) in layout manager | 0.5f (value of gap, it should in range (0.4f - 1f)) | ||
| fun getCarouselLayoutManager(): CarouselLayoutManager | Get the carousel layout manager instance | | ||
| fun getSelectedPosition(): Int | Get selected position from the layout manager | center view Positoin | ||
|
|
||
| ## API Methods Usage | ||
| ```Kotlin | ||
| val carouselRecyclerview = findViewById<CarouselRecyclerview>(R.id.recycler) | ||
| carouselRecyclerview.adapter = adapter | ||
| carouselRecyclerview.set3DItem(true) | ||
| carouselRecyclerview.setInfinite(true) | ||
| carouselRecyclerview.setAlpha(true) | ||
| carouselRecyclerview.setFlat(true) | ||
| val carouselLayoutManager = carouselRecyclerview.getCarouselLayoutManager() | ||
| val currentlyCenterPosition = carouselRecyclerview.getSelectedPosition() | ||
|
|
||
| ``` | ||
| ## Item Position Listener | ||
| You can listen to the position whenever the scroll happens you will get notified about the position, following are codes for listener | ||
|
|
||
| ```Kotlin | ||
| carouselRecyclerview.setItemSelectListener(object : OnSelected { | ||
| override fun onItemSelected(position: Int) { | ||
| //Cente item | ||
| } | ||
| }) | ||
|
|
||
| ``` | ||
|
|
||
|
|
||
| ## License | ||
| ```xml | ||
| Copyright 2021 Sparrow007 (Ankit kumar) | ||
|
|
||
| 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. | ||
| ``` | ||
| Update Soon.... |