Skip to content

ouattararomuald/android-image-slider

Repository files navigation

CircleCI

Image Slider

An image slider for android that let you pick the image loader library that best suits your needs.

Usage

Create a simple slider with the following code:

activity_main.xml

<com.ouattararomuald.slider.ImageSlider
  android:id="@+id/image_slider"
  android:layout_width="match_parent"
  android:layout_height="wrap_content"
/>

MainActivity.kt

class MainActivity : AppCompatActivity() {
  
  companion object {
    private const val SLIDE_NUMBER = 10
  }

  private lateinit var imageSlider: ImageSlider
  private val imageUrls = arrayListOf(
    "http://i.imgur.com/CqmBjo5.jpg", 
    "http://i.imgur.com/zkaAooq.jpg", 
    "http://i.imgur.com/0gqnEaY.jpg"
  )

  override fun onCreate(savedInstanceState: Bundle?) {
    super.onCreate(savedInstanceState)
    setContentView(R.layout.activity_main)

    imageSlider = findViewById(R.id.image_slider)
    imageSlider.adapter = SliderAdapter(
      this,
      PicassoImageLoaderFactory(),
      imageUrls = imageUrls,
      descriptions = Data.generateDescriptions(imageUrls.size)
    )
  }
}

Slider comes with Picasso as dependency to load images. If you want to use another library, you must extend ImageLoader#Factory and pass your factory to SliderAdapter (see Wiki).

Download

Download the latest AAR or grab via Gradle:

implementation 'com.ouattararomuald:slider-coil:3.0.1' // If you use Coil
implementation 'com.ouattararomuald:slider-glide:3.0.1' // If you use Glide
implementation 'com.ouattararomuald:slider-picasso:3.0.1' // If you use Picasso

If you want to use another image loading library include:

implementation 'com.ouattararomuald:slider:3.0.1'

and create you custom ImageLoader by implementing ImageLoader#Factory (see glide-loader or picasso-loader).

or Maven:

<!-- If you use Coil -->
<dependency>
  <groupId>com.ouattararomuald</groupId>
  <artifactId>slider-coil</artifactId>
  <version>3.0.1</version>
</dependency>
<!-- If you use Glide -->
<dependency>
  <groupId>com.ouattararomuald</groupId>
  <artifactId>slider-glide</artifactId>
  <version>3.0.1</version>
</dependency>
<!-- If you use Picasso -->
<dependency>
  <groupId>com.ouattararomuald</groupId>
  <artifactId>slider-picasso</artifactId>
  <version>3.0.1</version>
</dependency>
<!-- If you want a custom image loader -->
<dependency>
  <groupId>com.ouattararomuald</groupId>
  <artifactId>slider</artifactId>
  <version>3.0.1</version>
</dependency>

Snapshots of the development version are available in Sonatype's snapshots repository.

Contributing

Contributions you say? Yes please!

Bug report?

If at all possible, please attach a minimal sample project or code which reproduces the bug. Screenshots are also a huge help if the problem is visual.

Send a pull request!

If you're fixing a bug, please add a failing test or code that can reproduce the issue.

Build steps

  1. Build artifacts with ./gradlew assemble
  2. Run Tests ./gradlew test
  3. Run Instrumented Test ./gradlew :sample:connectedAndroidTest
  4. Run Android Lint ./gradlew lint
  5. Run Kotlin Lint ./gradlew detekt

License

Copyright 2018 Ouattara Gninlikpoho Romuald

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.