BannerView

A BannerView for Android.

Base on RecyclerView.
Show image or text.
Support adding any layout.

Screenshots

 

Getting Started

Step 1. Add it in your root build.gradle at the end of repositories:

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

Step 2. Add the dependency:

dependencies {
    implementation 'com.github.mminng:BannerView:1.0.0'
}

Example

Just like using Recyclerview

add BannerView in your layout

ImageBanner

<com.github.mminng.banner.BannerView
    ... />

TextBanner

<com.github.mminng.banner.TextBannerView
    ... />

BannerView

Simple

//create data (String type only)
val simpleData: List<String> = listOf(...)
//create DefaultBannerAdapter(already contains in BannerView)
val defaultAdapter: DefaultBannerAdapter = object : DefaultBannerAdapter() {
        override fun onBind(data: String, view: ImageView) {
            //load image
        }
    }
//set data
defaultAdapter.updateData(simpleData)
//item click
defaultAdapter.setOnItemClickListener { data, position ->
    //do something...
}
//set adapter for BannerView
bannerView.setAdapter(defaultAdapter)
//play
bannerView.play()
//or
bannerView.play(/*duration*/5000)

Custom

//create data
val customData: List<CustomType> = listOf(...)
//class of custom adapter extends from BannerAdapter
class CustomAdapter : BannerAdapter<CustomType>(R.layout.custom_layout) {
    override fun onBindViewHolder(holder: BannerViewHolder, item: CustomType, position: Int) {
        //do your work
        //like holder.findViewById()
    }
}
//create CustomAdapter
val customAdapter = CustomAdapter()
//set data
customAdapter.updateData(customData)
//item click
customAdapter.setOnItemClickListener { data, position ->
    //do something...
}
//set adapter for BannerView
bannerView.setAdapter(customAdapter)
//play
bannerView.play()
//or
bannerView.play(/*duration*/5000)

TextBannerView

Simple

//create DefaultTextBannerAdapter(already contains in BannerView)
//String type only
val defaultAdapter = DefaultTextBannerAdapter()
//DefaultTextBannerAdapter only
defaultAdapter.setTextColor()
//DefaultTextBannerAdapter only
defaultAdapter.setTextSize()
...
//same as (Image)BannerView

Custom

//same as (Image)BannerView

Lifecycle

//addObserver
lifecycle.addObserver(bannerView)
//or
override fun onResume() {
    ...
    bannerView.resume()
}
override fun onPause() {
    ...
    bannerView.stop()
}

Attrs

BannerView

Attrs	Type	Description
app:bannerPadding	dimension	padding left and right
app:bannerReverseLayout	boolean	reverseLayout
app:bannerIndicator	reference	set indicator drawable unselected
app:bannerIndicatorSelected	reference	set indicator drawable selected
app:bannerIndicatorGravity	enum	set indicator gravity center, start or end

TextBannerView

Attrs	Type	Description
app:bannerReverseLayout	boolean	reverseLayout

License

Copyright 2021 mminng

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.