From 22026ebfed79785f4ad9b1725c3c5cb328f9a5e2 Mon Sep 17 00:00:00 2001
From: jingbin <770413277@qq.com>
Date: Sun, 27 Sep 2020 15:58:07 +0800
Subject: [PATCH] update README.md
---
README.md | 76 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 76 insertions(+)
diff --git a/README.md b/README.md
index 635909d..e075df2 100644
--- a/README.md
+++ b/README.md
@@ -29,6 +29,82 @@ dependencies {
- 2.可设置右边距的轮播图，也可支持左右都有间距的轮播图
- 3.支持正常轮播图，并往回轮播或者循环轮播
+#### 属性解释
+
+| 属性 | 类型 | 默认值 | 属性说明 |
+| ---- | ---- | ---- | --- |
+| delay_time | integer | 2000ms | 延迟多少毫秒开始滚动 |
+| scroll_time | integer | 800ms | 滚动一页需要多少毫秒|
+| is_auto_play | boolean | true | 是否自动滚动 |
+| is_loop | boolean | true | 是否无限滚动，false则滚动到最后一个时停止滚动 |
+| is_back_loop | boolean |true|**滑到到最后一个时，是否返回滑动，false则循环播放**|
+| indicator_width | dimension | DisplayWidth / 80 | 指示器的宽度 |
+| indicator_height | dimension | DisplayWidth / 80 | 指示器的高度 |
+| indicator_margin | dimension | 10dp | 指示器距banner最底部的距离 |
+| indicator_padding | dimension | 5dp | 指示器之间的左右边距 |
+| indicator_drawable_selected | reference | gray_radius.xml | 选中的指示器样式 |
+| indicator_drawable_unselected | reference | white_radius.xml | 未选中的指示器样式 |
+| page_left_margin | dimension | 0 | banner距屏幕的左边距 |
+| page_right_margin | dimension | 0 | banner距屏幕的右边距 |
+
+其他方法：
+
+ - `setIndicatorGravity(int type)`: 设置指示器的位置 (BannerConfig.LEFT/CENTER/RIGHT)，默认居中`CENTER`
+ - `setBannerStyle(int bannerStyle)`: 设置指示器样式 (默认`BannerConfig.CIRCLE_INDICATOR`)
+ - NOT_INDICATOR: 取消指示器
+ - CIRCLE_INDICATOR: 自带的指示器
+ - CUSTOM_INDICATOR: 手动设置的指示器，不规定指示器宽高，随指示器自身的宽高
+
+#### 使用示例
+```xml
+
+```
+
+```java
+banner.setPageRightMargin(dip2px(this, 59))
+ .setBannerAnimation(ScaleRightTransformer.class)
+ .setOffscreenPageLimit(list.size())
+ .setDelayTime(3000)
+ .setPages(list, new HolderCreator() {
+ @Override
+ public SBannerViewHolder createViewHolder() {
+ return new CustomViewHolder();
+ }
+ })
+ .start();
+banner.setOnBannerClickListener(new OnBannerClickListener() {
+ @Override
+ public void onBannerClick(int position) {
+
+ }
+});
+
+
+class CustomViewHolder implements SBannerViewHolder {
+
+ private TextView mTextView;
+
+ @Override
+ public View createView(Context context) {
+ View view = LayoutInflater.from(context).inflate(R.layout.banner_item, null);
+ mTextView = (TextView) view.findViewById(R.id.text);
+ return view;
+ }
+
+ @Override
+ public void onBind(Context context, int position, BannerItemBean data) {
+
+ }
+}
+```
+
#### 混淆
```java
-keep class me.jingbin.sbanner.** {*;}