# WaveSideBar

**Repository Path**: android_locker/WaveSideBar

## Basic Information

- **Project Name**: WaveSideBar
- **Description**: No description available
- **Primary Language**: Android
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-12-17
- **Last Updated**: 2021-12-17

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# WaveSideBar

You can use WaveSideBar in the contacts page of your application.  
Refer to [AlexLiuSheng/AnimSideBar](https://github.com/AlexLiuSheng/AnimSideBar).

## Screenshot
![Screenshot](screenshot/gif.gif)

## Include the WaveSideBar to Your Project
With gradle:

```groovy
dependencies {
   compile 'com.gjiazhe:wavesidebar:1.3'
}
```

## Use WaveSideBar in Layout File
```xml
<com.gjiazhe.wavesidebar.WaveSideBar
        android:id="@+id/side_bar"
        android:layout_width="match_parent"
        android:layout_height="match_parent"
        android:paddingRight="8dp"
        app:sidebar_position="right"
        app:sidebar_max_offset="80dp"
        app:sidebar_lazy_respond="false"
        app:sidebar_text_color="#8D6E63"
        app:sidebar_text_size="14sp"
        app:sidebar_text_alignment="center"/>
```

## Description of Attributes
|       Attributes       |           Format           |  Default   |               Description                |
| :--------------------: | :------------------------: | :--------: | :--------------------------------------: |
|   sidebar_text_color   |           color            | Color.GRAY |         Text color of side bar.          |
|   sidebar_text_size    |         dimension          |    14sp    |          Text size of side bar.          |
|   sidebar_max_offset   |         dimension          |    80dp    |       Offset of the selected item.       |
|    sidebar_position    |    enum  {right,  left}    |   right    | Be placed on left or right in the view.  |
| sidebar_text_alignment | enum {center, left, right} |   center   |           Alignment of items.            |
|  sidebar_lazy_respond  |          boolean           |   false    | If __true__, the listener will not be called until the finger __up__. If __false__, the listener will be called when the finger __down__, __move__ and __up__. |

You can set these attributes in the layout file, or in the java code:
```java
WaveSideBar sideBar = (WaveSideBar) findViewById(R.id.side_bar);
sideBar.setTextColor(Color.BLACK);
sideBar.setMaxOffset(100);
sideBar.setPosition(WaveSideBar.POSITION_LEFT);
sideBar.setTextAlign(WaveSideBar.TEXT_ALIGN_CENTER);
sideBar.setLazyRespond(true);
```

## Set the Listener to Observe WaveSideBar
```java
WaveSideBar sideBar = (WaveSideBar) findViewById(R.id.side_bar);
sideBar.setOnSelectIndexItemListener(new WaveSideBar.OnSelectIndexItemListener() {
    @Override
    public void onSelectIndexItem(String index) {
        Log.d("WaveSideBar", index);
        // Do something here ....
    }
});
```

## Customize the indexes
Use **setIndexItems** to Customize the indexes.
```java
sideBar.setIndexItems("あ", "か", "さ", "た", "な", "は", "ま", "や", "ら", "わ");
```

<img src="screenshot/japanese1.png" width="400">
<img src="screenshot/japanese2.png" width="400">

## Use Left Hand?
Use **setPosition** to change the position of side bar.
```java
sideBar.setPosition(WaveSideBar.POSITION_LEFT);
```

<img src="screenshot/position_left.png" width="400">

## Lazy respond
use **setLazyRespond** to set whether the side bar should respond lazily to your touch events. 
```java
sideBar.setLazyRespond(true);
```
![Screenshot](screenshot/lazy_respond.gif)