# banner

**Repository Path**: vimeo/banner

## Basic Information

- **Project Name**: banner
- **Description**: Banner is an open source Android library that allows developers to easily create an ad rotation effect widget like those made in Tmall，Taobao apps.
- **Primary Language**: Kotlin
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 1
- **Created**: 2021-03-18
- **Last Updated**: 2025-08-27

## Categories & Tags

**Categories**: Uncategorized

**Tags**: View, Compose, Library

## README

# Banner

[![](https://jitpack.io/v/com.sunzn/banner.svg)](https://jitpack.io/#com.sunzn/banner)
[![](https://img.shields.io/badge/License-Apache%202.0-orange.svg)](http://www.apache.org/licenses/LICENSE-2.0.html)

Banner is an open source Android library that allows developers to easily create an ad rotation effect widget like those made in Tmall, Taobao apps.

### ScreenShot
![sample](./screen/001.gif)
![sample](./screen/002.gif)

### Gradle

#### 1. Add the JitPack repository to your build file.

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

#### 2. Add the dependency.

```groovy
dependencies {
    implementation 'com.sunzn.banner:banner:2.4.4'
}
```

### Attribute

| Attribute         | Describe                               | Additional                                         |
| ----------------- | -------------------------------------- | -------------------------------------------------- |
| banner_inch       | Milliseconds per inch                  | The greater the value, the slower the slide        |
| banner_interval   | Waiting time before next slide         | The greater the value, the longer the wait         |
| indicator_show    | Whether to display the indicator       | True display, false not displayed                  |
| indicator_gain    | Indicator drawable when gets the focus | Support color, svg and image reference             |
| indicator_miss    | Indicator drawable when lost the focus | Support color, svg and image reference             |
| indicator_size    | Indicator icon size                    | The larger the value, the larger the icon          |
| indicator_space   | Indicator icon spacing                 | The larger the value, the larger the icon interval |
| indicator_margin  | Indicator_margin                       | The larger the value, the larger the margin        |
| indicator_gravity | Indicator_gravity                      | Default center, support left, right                |

### How to use

#### 1. Add Banner view to your layout.

```xml
    <com.sunzn.banner.library.Banner
        android:id="@+id/banner"
        android:layout_width="match_parent"
        android:layout_height="120dp"
        app:indicator_gravity="right"
        app:indicator_gain="@drawable/svg_indicator_icon_gain"
        app:indicator_miss="@drawable/svg_indicator_icon_miss" />
```

#### 2. Create a java bean class.

```java
    private class Bean {

        String url;

        Bean(String url) {
            this.url = url;
        }

        String getUrl() {
            return url;
        }
        
    }
```

#### 3. Set Banner data and set OnItemClickListener, OnItemBindListener.

```groovy
    Banner<Bean> banner = findViewById(R.id.banner);

    banner.setBannerData(beans);
    banner.setOnItemClickListener(new Banner.OnItemClickListener<Bean>() {
        @Override
        public void onItemClick(int position, Bean item) {
            // TODO
        }
    });
    banner.setOnItemBindListener(new Banner.OnItemBindListener<Bean>() {
        @Override
        public void onItemBind(int position, Bean item, ImageView view) {
            Glide.with(view).load(item.getUrl()).into(view);
        }
    });
```

### License
```
    Copyright [2017-2024] sunzn

    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.
```