BannerViewPager

Introduction: 🚀这可能是全网最好用的 Banner。简单、高效,一行代码实现循环轮播,一屏三页任意变,指示器样式任你挑。
More: Author   ReportBugs   
Tags:

License MinSdk JitPack JCenter

English | 中文

Tencent Video,QQ Music,KuGou,AliPay,Tmall,TaoBao,YouKu,Himalaya,NetEase Music,Bilibili ect. All of above App's Banner can be implements By BannerViewPager.

Preview

Click here or scan the QR code to download demo apk

QRCode

1.setPageStyle

Sample Click Here

MULTI_PAGE MULTI_PAGE_SCALE MULTI_PAGE_OVERLAP
MULTI_PAGE MULTI_PAGE MULTI_PAGE

2.setIndicatorStyle

BannerViewPager supports three Indicator Styles now. It's also support you to custom indicator style,just need extends BaseIndicatorView or implement the IIndicator and then override methods, you can draw Indicators for whatever you want.

Sample Click Here

CIRCLE DASH ROUND_RECT
CIRCLE DASH NORMAL

3.setIndicatorSlideMode

NORMAL SMOOTH
NORMAL SMOOTH

4.setPageTransformerStyle

Sample Click Here

parameters STACK ROTATE DEPTH ACCORDION
Preview STACK ROTATE_DOWN DEPTH ACCORDION

API

Method Description Default
BannerViewPager setCanLoop(boolean canLoop) set is can loop default value is true
BannerViewPager setAutoPlay(boolean autoPlay) set is atuo play default value true
BannerViewPager setInterval(int interval) set the interval of item switch interval The unit is millisecond,default value 3000ms
BannerViewPager setScrollDuration(int scrollDuration) set page scroll duration set page scroll duration unit is millisecond,default is 500ms
BannerViewPager setRoundRect(int radius) set Round Rectangle for Banner required SDK_INT>=LOLLIPOP(API 21)
BannerViewPager setOnPageClickListener(OnPageClickListener onPageClickListener) set item click listener
BannerViewPager setHolderCreator(HolderCreator\ holderCreator) set Holder Creator You must set HolderCreator for BannerViewPager,or will throw NullPointerException
BannerViewPager setIndicatorVisibility(@Visibility int visibility) indicator visibility default value is VISIBLE,added in version 2.4.2
BannerViewPager setIndicatorStyle(int indicatorStyle) set indicator style enum(CIRCLE, DASH、ROUND_RECT) default CIRCLE
BannerViewPager setIndicatorGravity(int gravity) set indicator gravity enum(CENTER、START、END) default value CENTER
BannerViewPager setIndicatorColor(int normalColor,int checkedColor) set indicator color normalColor:color of indicator dot not selected, default value "#8C6C6D72", checkedColor:color of indicator selected default value is "#8C18171C"
BannerViewPager setIndicatorSlideMode(int slideMode) set indicator slide mode enum(NORMAL、SMOOTH),default value NORMAL
BannerViewPager setIndicatorRadius(int radius) set indicator dot radius default value is 4dp
BannerViewPager setIndicatorRadius(int normalRadius,int checkRadius) set indicator dot radius normalRadius:normal radius of indicator dot, checkedRadius:checked radius of indicator dot,default value is 4dp
BannerViewPager setIndicatorWidth(int indicatorWidth) set indicator dot width,if it's Circle indicator the parameter is diameter of circle default value is 8dp
BannerViewPager setIndicatorWidth(int normalWidth, int checkWidth) set indicator dot width,if is circle style,the width is diameter of circle default is 8dp
BannerViewPager setIndicatorHeight(int indicatorHeight) set indicator hight,it's only used when the indicator style is dash default value is normalIndicatorWidth/2
BannerViewPager setIndicatorGap(int indicatorMargin) set the gap of indicator dot default value is indicator dot width(or the diameter of circle)
BannerViewPager setIndicatorView(IIndicator indicatorView) set custom indicator The custom indicator must extends BaseIndicatorView or implements IIndicator
BannerViewPager setPageTransformerStyle(int style) set transform style
BannerViewPager setCurrentItem(int item) Set the currently selected page. add in v2.3.5
int getCurrentItem() get the current page position added in v2.3.5
BannerViewPager setPageStyle(PageStyle pageStyle) setPageStyle support in v2.4.0. enum(MULTI_PAGE、MULTI_PAGE_SCALE、MULTI_PAGE_OVERLAP)
BannerViewPager setPageMargin(int pageMargin) set item margin added in v2.4.0
BannerViewPager setIndicatorMargin(int left, int top, int right, int bottom) set margin for indicator added in v2.4.1
BannerViewPager setOnPageChangeListener(OnPageChangeListener l) set page change listener for BannerViewPager added in v2.4.3
void startLoop() start loop the method will be called when BannerViewPager was initialized
void stopLoop() stop loop
List\ getList() get data in BannerViewPager
void create(List list) initialize BannerViewPager You must call this method when data is set

Attributes in xml

Attributes format description
bvp_interval integer set page switch interval
bvp_scroll_duration integer set page scroll duration
bvp_can_loop boolean set is can loop
bvp_auto_play boolean set is can auto play
bvp_indicator_checked_color color set checked color for indicator
bvp_indicator_normal_color color set normal color for indicator
bvp_indicator_radius dimension if it's circle style the value is radius of circle,if the indicator style is DASH or ROUND_RECT the value is width/2
bvp_round_corner dimension set round corner for banner
bvp_page_margin dimension set item margin
bvp_reveal_width dimension it's only used when the page style is MULTI_PAGE/MULTI_PAGE_SCALE/MULTI_PAGE_OVERLAP,the value is two side item reveal width
bvp_indicator_style enum indicator style. enum(circle/dash)
bvp_indicator_slide_mode enum indicator slide mode.enum(normal/smooth)
bvp_indicator_gravity enum indicator gravity. enum(center/start/end)
bvp_page_style enum page style. enum(normal/multi_page/multi_page_overlap/multi_page_scale)
bvp_transformer_style enum transform style. enum(normal/depth/stack/accordion)
bvp_indicator_visibility enum indicator visibility(visible/gone/invisible)

Usage

1.Gradle dependency

If you have migrated to Androidx,please add it in your root build.gradle at the end of repositories:

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

Then add the dependency in your app build.gradle

implementation 'com.github.zhpanvip:BannerViewPager:latestVersion'

Androidx latestVersion:latestVersion

If you are still using android support library,you can add the dependency in your app build.gradle:

implementation 'com.zhpan.library:bannerview:latestVersion'

Android support latestVersion: latestVersion

2.Add BannerViewPager in layout.xml

    <com.zhpan.bannerview.BannerViewPager
            android:id="@+id/banner_view"
            android:layout_width="match_parent"
            android:layout_margin="10dp"
            android:layout_height="160dp" />

3.The layout of banner item:

    <RelativeLayout xmlns:android="http://schemas.android.com/apk/res/android"
        android:layout_width="match_parent"
        android:layout_height="wrap_content">

        <ImageView
            android:id="@+id/banner_image"
            android:layout_width="match_parent"
            android:layout_height="match_parent"
            android:scaleType="centerCrop" />

        <LinearLayout
            android:layout_width="match_parent"
            android:layout_height="wrap_content"
            android:layout_alignParentBottom="true"
            android:background="#66000000"
            android:gravity="center_vertical">

            <TextView
                android:id="@+id/tv_describe"
                android:layout_width="wrap_content"
                android:layout_height="match_parent"
                android:layout_gravity="center_vertical"
                android:layout_marginStart="15dp"
                android:gravity="center_vertical"
                android:paddingTop="5dp"
                android:paddingBottom="5dp"
                android:textColor="#FFFFFF"
                android:textSize="16sp" />
        </LinearLayout>

    </RelativeLayout>

4.Set ViewHolder for BannerViewPager,you must implements ViewHolder:

    public class NetViewHolder implements ViewHolder<BannerData> {

        @Override
        public int getLayoutId() {
            return R.layout.item_net;
        }

        @Override
        public void onBind(View itemView, BannerData data, int position, int size) {
            CornerImageView imageView = itemView.findViewById(R.id.banner_image);
            imageView.setRoundCorner(BannerUtils.dp2px(5));
            ImageLoaderOptions options = new ImageLoaderOptions.Builder()
                    .into(imageView).load(data.getImagePath())
                    .placeHolder(R.drawable.placeholder).build();
            ImageLoaderManager.getInstance().loadImage(options);
        }
    }

5.Use BannerViewPager in Activity or Fragment:

Kotlin:

    private lateinit var mViewPager: BannerViewPager<CustomBean, CustomPageViewHolder>

    private fun initViewPager() {
            mBannerViewPager = findViewById(R.id.bannerView)
            mBannerViewPager.setCanLoop(false)
                .setIndicatorSlideMode(IndicatorSlideMode.SMOOTH)
                .setIndicatorMargin(0, 0, 0, ConvertUtils.dp2px(40f))
                .setIndicatorGravity(IndicatorGravity.CENTER)
                .setHolderCreator { CustomPageViewHolder() }
                .setOnPageChangeListener(
                    object : OnPageChangeListenerAdapter() {
                        override fun onPageSelected(position: Int) {
                            pageSelect(position)
                        }
                    }
                )
                .create(res.toList())
        }

Java:

    private BannerViewPager<BannerData, NetViewHolder> mBannerViewPager;
    ...
    private void initViewPager() {
             mBannerViewPager = findViewById(R.id.banner_view);
             mBannerViewPager.showIndicator(true)
                .setInterval(3000)
                .setCanLoop(false)
                .setAutoPlay(true)
                .setRoundCorner(DpUtils.dp2px(7))
                .setIndicatorColor(Color.parseColor("#935656"), Color.parseColor("#FF4C39"))
                .setIndicatorGravity(IndicatorGravity.END)
                .setScrollDuration(1000).setHolderCreator(NetViewHolder::new)
                .setOnPageClickListener(position -> {
                    BannerData bannerData = mBannerViewPager.getList().get(position);
                    Toast.makeText(NetworkBannerActivity.this,
                            "点击了图片" + position + " " + bannerData.getDesc(), Toast.LENGTH_SHORT).show();

                }).create(mList);
        }

6.startLoop and stopLoop

If the version you used is later than 2.5.0,you don't need care of startLoop and stopLoop in Activity or Fragment .But the two methods is still public.

If you set auto play for BannerViewPager,you must to call stopLoop() in onDestroy() to avoid memory leak

    @Override
    protected void onDestroy() {
        super.onDestroy();
        if (mBannerViewPager != null)
            mViewpager.stopLoop();
    }

Or you can stop Loop in onStop() and startLoop in onResume() to improve performance:

    @Override
    protected void onStop() {
        super.onStop();
        if (mBannerViewPager != null)
            mBannerViewPager.stopLoop();
    }

    @Override
    protected void onResume() {
        super.onResume();
        if (mBannerViewPager != null)
            mBannerViewPager.startLoop();
    }

7.Custom IndicatorView

The example will implement an custom IndicatorView as the below gif shown .

Custom IndicatorView Style
NORMAL

(1)Custom View and extends BaseIndicatorView

public class FigureIndicatorView extends BaseIndicatorView {

    private int radius = DpUtils.dp2px(20);

    private int backgroundColor = Color.parseColor("#88FF5252");

    private int textColor = Color.WHITE;

    private int textSize=DpUtils.dp2px(13);

    public FigureIndicatorView(Context context) {
        this(context, null);
    }

    public FigureIndicatorView(Context context, @Nullable AttributeSet attrs) {
        this(context, attrs, 0);
    }

    public FigureIndicatorView(Context context, @Nullable AttributeSet attrs, int defStyleAttr) {
        super(context, attrs, defStyleAttr);
        mPaint = new Paint();
    }

    @Override
    protected void onMeasure(int widthMeasureSpec, int heightMeasureSpec) {
        super.onMeasure(widthMeasureSpec, heightMeasureSpec);
        setMeasuredDimension(2 * radius, 2 * radius);
    }

    @Override
    protected void onDraw(Canvas canvas) {
        super.onDraw(canvas);
        mPaint.setColor(backgroundColor);
        canvas.drawCircle(getWidth() / 2, getHeight() / 2, radius, mPaint);
        mPaint.setColor(textColor);
        mPaint.setTextSize(textSize);
        String text = currentPosition + 1 + "/" + pageSize;
        int textWidth = (int) mPaint.measureText(text);
        Paint.FontMetricsInt fontMetricsInt = mPaint.getFontMetricsInt();
        int baseline = (getMeasuredHeight() - fontMetricsInt.bottom + fontMetricsInt.top) / 2 - fontMetricsInt.top;
        canvas.drawText(text, (getWidth() - textWidth) / 2, baseline, mPaint);
    }

    public void setRadius(int radius) {
        this.radius = radius;
    }

    @Override
    public void setBackgroundColor(@ColorInt int backgroundColor) {
        this.backgroundColor = backgroundColor;
    }

    public void setTextSize(int textSize) {
        this.textSize = textSize;
    }

    public void setTextColor(int textColor) {
        this.textColor = textColor;
    }
}

(2)Set custom indicator for BannerViewPager

    FigureIndicatorView indicatorView = new FigureIndicatorView(mContext);
    indicatorView.setRadius(BannerUtils.dp2px(18));
    indicatorView.setTextSize(BannerUtils.dp2px(13));
    indicatorView.setBackgroundColor(Color.parseColor("#aa118EEA"));

    mViewPager.setIndicatorGravity(IndicatorGravity.END)
              .setIndicatorView(indicatorView)
              .setHolderCreator(() -> new ImageResourceViewHolder(0))
              .create(mDrawableList);

TODO

  • [x] Optimization and Refactoring IndicatorView(2.0.1)

  • [x] Fix a bug which page frozen sometimes when sliding in version 2.1.0 (2.1.0.1)

  • [x] Set Transform Style Supported(2.1.2)

  • [x] Migrate to Androidx(2.2.0)

  • [x] indicator smooth slide Supported(2.2.2)

  • [x] Dash IndicatorView Supported(2.3.+)

  • [x] MULTI_PAGE Style Supported(2.4.0)

  • [x] Optimize code and improve performance in version 2.4.3

  • [x] Refactor Indicator again (2.5.0)

  • [x] Fix issue #34 which Indicator smooth slide problem(2.6.1).
  • [ ] Migrate to ViewPager2 (3.0.0)

If you have any question you can scan the QR code to join the QQ group to communicate.

QQ 交流群 60902509

More details

《打造一个丝滑般自动轮播无限循环 Android 库》

《BannerViewPager 源码解析》

《剖析 BannerViewPager 中 Indicator 的设计思想》

Thanks

banner

Android-ConvenientBanner

ViewPagerTransforms

玩 Android

License

Copyright 2019 zhpanvip

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.
Apps
About Me
Google+: Trinea trinea
GitHub: Trinea