Skip to content

Latest commit

 

History

History
127 lines (102 loc) · 3.6 KB

README-ch.md

File metadata and controls

127 lines (102 loc) · 3.6 KB

UltraRecyclerView

English Document

简介

UltraRecyclerView是一个封装多种特性的RecyclerView。

截图

主要功能

  • 支持横向滑动／纵向滑动
  • 支持分页滑动，并且支持对齐方式（顶部对齐、居中对齐或尾部对齐）和距离
  • 支持循环滚动
  • 支持定时滚动，计时器使用Handler实现
  • BannerView内置指示器，支持设置底部距离、已选/默认的颜色和宽度、高度和内部距离

以上特性支持同时使用。

使用方法

版本请参考mvn repository上的最新版本（目前最新版本是1.0.0），最新的都会发布到 jcenter 上，确保配置了这个仓库源，然后引入依赖：

使用Gradle:

// gradle
implementation 'com.jimmysun:ultrarecyclerview:1.1.0'

或者maven：

// pom.xml in maven
<dependency>
	<groupId>com.jimmysun</groupId>
	<artifactId>ultrarecyclerview</artifactId>
	<version>1.1.0</version>
	<type>pom</type>
</dependency>

在layout中使用UltraRecyclerView：

activity_recycler_view.xml

<com.jimmysun.ultrarecyclerview.UltraRecyclerView
    android:id="@+id/ultra_recycler_view"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    app:orientation="vertical"
    app:alignGravity="start"
    app:alignMargin="0dp"
    app:infiniteLoop="true"/>

或者使用BannerView:

<com.jimmysun.ultrarecyclerview.BannerView
    android:id="@+id/banner_view"
    android:layout_width="match_parent"
    android:layout_height="150dp"
    app:alignGravity="center"
    app:alignMargin="0dp"
    app:infiniteLoop="true"
    app:indicatorGravity="bottom|center_horizontal"
    app:indicatorBottomMargin="8dp"
    app:indicatorLeftMargin="8dp"
    app:indicatorRightMargin="8dp"
    app:indicatorSelectedColor="#FFFFFFFF"
    app:indicatorDefaultColor="#4D868E9E"
    app:indicatorSelectedWidth="10dp"
    app:indicatorDefaultWidth="10dp"
    app:indicatorHeight="2dp"
    app:indicatorMargin="5dp"
    app:indicatorVisibility="visible"/>

可以参考以下步骤使用UltraRecyclerView:

mUltraRecyclerView = findViewById(R.id.ultra_recycler_view);
// 初始化MyAdapter，其继承于RecyclerView.Adapter
mUltraRecyclerView.setAdapter(new MyAdapter(RecyclerView.VERTICAL));
// 设置方向
mUltraRecyclerView.setOrientation(RecyclerView.VERTICAL);
// 设置分页模式，包括对齐方式和距离
mUltraRecyclerView.setPagerSnap(Gravity.START, 0);
// 设置无限循环
mUltraRecyclerView.setInfiniteLoop(true);
// 开启自动滚动
mUltraRecyclerView.startAutoScroll(2000);
mUltraRecyclerView.setAutoScrollSpeed(500);

或者在Java中使用BannerView：

mBannerView = findViewById(R.id.banner_view);
// 初始化MyAdapter，其继承于RecyclerView.Adapter
mBannerView.setAdapter(new MyAdapter(RecyclerView.HORIZONTAL));
// 设置分页模式
mBannerView.setPagerSnap(Gravity.CENTER);
// 设置无限循环
mBannerView.setInfiniteLoop(true);
// 设置指示器的样式
mBannerView.setIndicatorGravity(Gravity.BOTTOM | Gravity.CENTER_HORIZONTAL);
mBannerView.setIndicatorBottomMargin(24);
mBannerView.setIndicatorSelectedColor(Color.GREEN);
mBannerView.setIndicatorDefaultColor(Color.WHITE);

Api接口详情请参考文档

FAQ

  • 如何刷新数据？可以使用如下方法：
    • ultraRecyclerView.refresh();

示例

Demo工程

开源许可证

UltraRecyclerView遵循MIT开源许可证协议。