Skip to content

Commit 76561f9

Browse files
committed
alter readme
1 parent eca6ad1 commit 76561f9

File tree

2 files changed

+8
-66
lines changed

2 files changed

+8
-66
lines changed

README.md

Lines changed: 8 additions & 64 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
#Android Image Slider
1+
#Android Image Slider [![Build Status](https://travis-ci.org/daimajia/AndroidImageSlider.svg)](https://travis-ci.org/daimajia/AndroidImageSlider)
22

33
This is an amazing image slider in Android platform. I decide to open source this because there is really not an attractive,and convenient slide widget in Android.
44

@@ -12,13 +12,11 @@ You can easily load image from net,drawable or file. And there are many kind of
1212

1313
##Usage
1414

15-
[Wiki](https://github.com/daimajia/AndroidImageSlider/wiki) is under construction. :-D
16-
1715
Step1: add dependencies in build.gradle.
1816

1917
```groovy
2018
dependencies {
21-
compile 'com.daimajia.slider:library:1.0@aar'
19+
compile 'com.daimajia.slider:library:1.0.1@aar'
2220
}
2321
```
2422

@@ -49,69 +47,15 @@ There are some default indicators, while,if you want to custom your own indicato
4947
android:gravity="center"
5048
/>
5149
```
50+
51+
[Code example](https://github.com/daimajia/AndroidImageSlider/blob/master/demo%2Fsrc%2Fmain%2Fjava%2Fcom%2Fdaimajia%2Fslider%2Fdemo%2FMainActivity.java)
5252

5353
====
5454

55-
##Some Details
56-
57-
###SliderLayout
58-
59-
`SliderLayout` is a compound layout, contains:
60-
61-
- `PagerIndicator` : actually extends from LinearLayout),
62-
- `InfiniteViewPager` : a wrapper of `ViewPager`
63-
- `BaseTransformer` : a slider transformer instance, this can be used to implement effects transform.
64-
- `BaseAnimationInterface`: user custom animation.
65-
66-
####Properties:
67-
68-
- Indicator
69-
- `indicator_visibility` : visibile | invisible
70-
- `auto_cycle` : true | false
71-
- `pager_animation`: Default | Accordion | Background2Foreground | CubeIn | DepthPage | Fade | FlipHorizontal | FlipPage | Foreground2Background | RotateDown | RotateUp | Stack | Tablet | ZoomIn | ZoomOutSlide | ZoomOut
72-
- `pager_animation_span` : the slider animation time length. integer, milliseconds
73-
74-
75-
###PagerIndicator
76-
77-
PagerIndicator is extended from LinearLayout. It is bind with a adapter, detect the adapter item count by `adapter.getCount()` , and then add `ImageView` into the LinearLayout.
78-
79-
There are two kind indicators, `selected` status and `unselected` status.
80-
81-
- Both properties:
82-
83-
- `shape` : oval(default) | rect , the shape of indicator (if you set your custom drawable, then this will not work).
84-
- `visibility` visibile | invisible
85-
86-
- Selected indicator's properties:
87-
- `selected_drawable` : if you set this drawable, then the below settings will not work.
88-
- `selected_color`
89-
- `selected_width`
90-
- `selected_height`
91-
- `selected_padding_left`
92-
- `selected_padding_right`
93-
- `selected_padding_top`
94-
- `selected_padding_bottom`
95-
96-
- Unselected indicator properties:
97-
- `unselected_drawable` : if you set this drawable, then the below settings will not work.
98-
- `unselected_color`
99-
- `unselected_width`
100-
- `unselected_height`
101-
- `unselected_padding_left`
102-
- `unselected_padding_right`
103-
- `unselected_padding_top`
104-
- `unselected_padding_bottom`
105-
106-
###BaseTransformer
107-
108-
A [PageTransformer]((http://stuff.mit.edu/afs/sipb/project/android/docs/reference/android/support/v4/view/ViewPager.PageTransformer.html) ) is invoked whenever a visible/attached page is scrolled. You can add slide animation by `extends BaseTransformer`. And add your animation effect into `onTransform()` method. I supply a lot of [examples](./library/src/main/java/com/daimajia/slider/library/Transformers), if you are not so clear on `PageTransformer`, you can learn from them, and try to make your own.
109-
110-
###BaseAnimationInterface
111-
112-
If you need to manipulate your slide view(for example: add an animation to a target view, when slide animation is finished), to make it simple, I made an interface to help you to concentrate on the view that are animating. You can see [the example](./library/src/main/java/com/daimajia/slider/library/Animations/DescriptionAnimation.java) if you want to make your own.
113-
55+
##Adavanced usage
56+
57+
Please visit [Wiki](https://github.com/daimajia/AndroidImageSlider/wiki)
11458

11559
##About me
11660

117-
A student in China mainland. I love Google, love Android, love everything that interesting. If you get any problems when using this library or you have an internship opportunity, please feel relax to [email me](mailto:[email protected]). :-D
61+
A student in China mainland. I love Google, love Android, love everything that interesting. If you get any problems when using this library or you have an internship opportunity, please feel relax to [email me](mailto:[email protected]). :-D

demo/src/main/java/com/daimajia/slider/demo/MainActivity.java

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -58,11 +58,9 @@ protected void onCreate(Bundle savedInstanceState) {
5858

5959
mDemoSlider.addSlider(textSliderView);
6060
}
61-
6261
mDemoSlider.setPresetTransformer(SliderLayout.Transformer.Accordion);
6362
mDemoSlider.setPresetIndicator(SliderLayout.PresetIndicators.Center_Bottom);
6463
mDemoSlider.setCustomAnimation(new DescriptionAnimation());
65-
6664
ListView l = (ListView)findViewById(R.id.transformers);
6765
l.setAdapter(new TransformerAdapter(this));
6866
l.setOnItemClickListener(new AdapterView.OnItemClickListener() {

0 commit comments

Comments
 (0)