Skip to content

Latest commit

 

History

History
318 lines (230 loc) · 13 KB

README_CN.md

File metadata and controls

318 lines (230 loc) · 13 KB

ViewPagerIndicator

License MinSdk latestVersion Android Arsenal

English | 中文

预览

QRCode

目前,该库已经可以支持多种指示器样式和多种滑动模式,同时,也支持Drawable指示器和自定义指示器

IndicatorView

属性 CIRCLE DASH ROUND_RECT
NORMAL CIRCLE_NORMAL DASH_NORMAL ROUND_RECT_NORMAL
SMOOTH CIRCLE_SMOOTH DASH_SMOOTH ROUND_RECT_SMOOTH
WORM CIRCLE_WORM DASH_WORM ROUND_WORM
COLOR CIRCLE_COLOR DASH_COLOR ROUND_COLOR
SCALE CIRCLE_SCALE DASH_SCALE ROUND_SCALE

API

Method Description Default
setOrientation(int) 设置指示器的方向,可选值(INDICATOR_HORIZONTAL/INDICATOR_VERTICAL) 默认值为INDICATOR_HORIZONTAL
setIndicatorStyle(Int) 设置指示器样式 枚举类型(CIRCLE;DASH;ROUND_RECT) 默认值:CIRCLE
setSliderColor(normalColor: Int,selectedColor: Int) 设置指示器滑块颜色 normalColor:未选中时的滑块颜色, 默认值:"#8C18171C", checkedColor:选中时滑块颜色,默认值:"#6C6D72"
setSlideMode(slideMode: Int) 设置滑块滑动模式 枚举类型(NORMAL;SMOOTH;WORM;COLOR;SCALE),默认值:NORMAL
setSliderWidth(indicatorWidth:Int) 设置滑块宽度,如果是圆形指示器则为滑块直径 默认值:8dp
setSliderWidth(normalWidth Int , checkWidth Int) 设置滑块宽度,如果是圆形指示器则为滑块直径 默认值 8dp
setIndicatorHeight(indicatorHeight Int) 设置指示器高度,只有在DASH和ROUND_RECT样式下有效 默认值为:normalIndicatorWidth/2
setSliderGap(indicatorMargin Int ) 设置滑块之间的间距 默认值为滑块宽度或者直径
setupWithViewPager(ViewPager) indicator与ViewPager关联
setupWithViewPager(ViewPager2) indicator与ViewPager2关联

XML Attrs

Attributes format description
vpi_slider_checked_color color 设置选中时滑块颜色,默认值为"#6C6D72"
vpi_slider_normal_color color 设置未选中时滑块颜色,默认值为"#8C18171C"
vpi_slider_radius dimension 设置指示器滑块半径或者宽度. 如果是CIRCLE样式,该值为滑块半径,如果是DASH或者ROUND_RECT样式,该值为滑块宽度的1/2
vpi_orientation enum 设置滑动方向(horizontal/vertical)
vpi_slide_mode enum 设置滑动模式(normal/smooth/worm/scale/color)
vpi_style enum 设置指示器滑块样式(circle/dash/round_rect)

如何使用

添加依赖

在项目的gradle中添加如下依赖:

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

在模块的gradle中添加如下依赖:

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

latestVersion:latestVersion

1.IndicatorView

到目前为止IndicatorView已经可以支持三种indicator样式以及五种滑动样式,具体使用步骤如下:

(1).在layout.xml文件中添加如下代码:

    <RelativeLayout
            android:layout_width="match_parent"
            android:layout_height="@dimen/dp_200"
            tools:context=".MainActivity">

            <androidx.viewpager.widget.ViewPager
                android:id="@+id/banner_view"
                android:layout_width="match_parent"
                android:layout_height="match_parent" />

            <com.zhpan.indicator.IndicatorView
                android:id="@+id/indicator_view"
                android:layout_width="wrap_content"
                android:layout_height="wrap_content"
                android:layout_alignParentBottom="true"
                android:layout_centerHorizontal="true"
                android:layout_margin="@dimen/dp_10" />

    </RelativeLayout>

(2) 为IndicatorView配置参数以及关联ViewPager/ViewPager2:

         indicatorView.apply {
                             setSliderColor(normalColor, checkedColor)
                             setSliderWidth(resources.getDimension(R.dimen.dp_10))
                             setSliderHeight(resources.getDimension(R.dimen.dp_5))
                             setSlideMode(IndicatorSlideMode.WORM)
                             setIndicatorStyle(IndicatorStyle.CIRCLE)
                             setPageSize(view_pager2!!.adapter!!.itemCount)
                             notifyDataChanged()
                         }
         view_pager2.registerOnPageChangeCallback(object : ViewPager2.OnPageChangeCallback() {
             override fun onPageScrolled(position: Int, positionOffset: Float, positionOffsetPixels: Int) {
                 super.onPageScrolled(position, positionOffset, positionOffsetPixels)
                 indicatorView.onPageScrolled(position, positionOffset, positionOffsetPixels)
             }

             override fun onPageSelected(position: Int) {
                 super.onPageSelected(position)
                 indicatorView.onPageSelected(position)
             }
         })

或者:

        val indicatorView = findViewById<IndicatorView>(R.id.indicator_view2)
        indicatorView.apply {
                    setSliderColor(normalColor, checkedColor)
                    setSliderWidth(resources.getDimension(R.dimen.dp_10))
                    setSliderHeight(resources.getDimension(R.dimen.dp_5))
                    setSlideMode(IndicatorSlideMode.WORM)
                    setIndicatorStyle(IndicatorStyle.CIRCLE)
                    setupWithViewPager(view_pager2)
                }

2.自定义Indicator样式

DrawableIndicator

Bitmap Drawable Vector Drawable
NORMAL NORMAL

DrawableIndicator是一个自定义的Indicator,位于Sample中,使用DrawableIndicator可以设置bitmap drawable或者vector drawable,可以自定义drawable的大小,具体使用步骤如下:

(1) Add IndicatorView in layout.xml

    <RelativeLayout
            android:layout_width="match_parent"
            android:layout_height="@dimen/dp_200"
            tools:context=".MainActivity">

            <androidx.viewpager.widget.ViewPager
                android:id="@+id/banner_view"
                android:layout_width="match_parent"
                android:layout_height="match_parent" />

            <com.zhpan.viewpagerindicator.DrawableIndicator
                android:id="@+id/indicator_view"
                android:layout_width="wrap_content"
                android:layout_height="wrap_content"
                android:layout_alignParentBottom="true"
                android:layout_centerHorizontal="true"
                android:layout_margin="@dimen/dp_10" />

    </RelativeLayout>

(2) DrawableIndicator与ViewPager/ViewPager2关联:

        val drawableIndicator = findViewById<DrawableIndicator>(R.id.indicator_view)
        val dp20 = resources.getDimensionPixelOffset(R.dimen.dp_20)
        drawableIndicator.apply {
                    setIndicatorGap(resources.getDimensionPixelOffset(R.dimen.dp_2_5))
                    setIndicatorDrawable(R.drawable.heart_empty, R.drawable.heart_red)
                    setIndicatorSize(dp20, dp20, dp20, dp20)
                    setupWithViewPager(view_pager2)
                }

FigureIndicatorView

这是一个演示如何实现自定义指示器的例子,例子将实现一个如下图的indicator样式

Custom IndicatorView Style
NORMAL

(1)自定义View并继承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)自定义的indicator与ViewPager/ViewPager2关联

    val indicatorView = findViewById<FigureIndicatorView>(R.id.indicator_view)
    indicatorView.setBackgroundColor(Color.parseColor("#aa118EEA"))
    indicatorView.setTextSize(IndicatorUtils.dp2px(13f))
    indicatorView.setupWithViewPager(viewPager)

FAQ

如有问题可以加入QQ群交流

QQ群 微信群
QQ Group WeChat

Sponsor

更多详情

《聊一聊ViewPagerIndicator重构的一些经验》

License

Copyright 2020 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.