Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sakebook/multilinedivider
Multi divider in RecyclerView on Android.
https://github.com/sakebook/multilinedivider
android android-library android-ui divide divider itemdecoration java kotlin multi-divider recyclerview
Last synced: about 1 month ago
JSON representation
Multi divider in RecyclerView on Android.
- Host: GitHub
- URL: https://github.com/sakebook/multilinedivider
- Owner: sakebook
- License: apache-2.0
- Created: 2017-04-23T16:26:24.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2022-04-28T21:27:03.000Z (over 2 years ago)
- Last Synced: 2024-11-01T17:51:43.502Z (about 2 months ago)
- Topics: android, android-library, android-ui, divide, divider, itemdecoration, java, kotlin, multi-divider, recyclerview
- Language: Kotlin
- Size: 4.39 MB
- Stars: 13
- Watchers: 3
- Forks: 2
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
MultiLineDivider
============
Multi divider in RecyclerView on Android.
[ ](https://bintray.com/sakebook/maven/MultiLineDivider/_latestVersion) [](https://android-arsenal.com/details/1/5735)
[](https://app.wercker.com/project/byKey/7b5ad7fbfb97759c7d5ef14778e0539a)
|Vertical|Horizontal|
|:---:|:---:|
|||
|Inset|Dash|
|:---:|:---:|
|||
|Grid|FullBleed|
|:---:|:---:|
|||
|Position|Inverted|
|:---:|:---:|
|||
---
- Requirement
- SDK Version __16+__
- (Use from Java)Kotlin Version __1.0.0+__
## Usage
Add dependencies
```gradle
compile 'com.github.sakebook:MultiLineDivider:0.2.0@aar'
// Use from Java
compile "org.jetbrains.kotlin:kotlin-stdlib:kotlin_version"
```
Add to RecyclerView like in addItemDecoration
- Java
```java
MultiLineDivider multiLineDivider = new MultiLineDivider(this, LinearLayout.VERTICAL);
recyclerView.addItemDecoration(multiLineDivider);
```
- Kotlin
```kotlin
val multiLineDivider = MultiLineDivider(this)
recyclerView.addItemDecoration(multiLineDivider)
```
And Implement `VerticalDivider` in ViewHolder
- Java
```java
public class YourViewHolder extends RecyclerView.ViewHolder implements VerticalDivider {
public YourViewHolder(View itemView) {
super(itemView);
}
@Override
public int getHeight() {
return this.itemView.getContext().getResources()
.getDimensionPixelSize(R.dimen.small_margin);
}
@Override
public int getDrawableRes() {
return R.drawable.custom_divider;
}
@Nullable
@Override
// android.support.v4.util.Pair
public Pair getVerticalInset() {
return null;
}
}
```
- Kotlin
```kotlin
class YourViewHolder(view: View): RecyclerView.ViewHolder(view), VerticalDivider {
override val height = view.context.resources.getDimensionPixelSize(R.dimen.small_margin)
override val drawableRes = R.drawable.custom_divider
override val verticalInset: Pair? = null
}
```
## Custom
### If you want to draw Horizontal divider
```java
MultiLineDivider multiLineDivider = new MultiLineDivider(this, LinearLayout.HORIZONTAL);
```
and implements `HorizontalDivider`
### If you __don't__ want to draw divider
Implements `NoDivider`
### If you want to inset in divider
```
@Nullable
@Override
// android.support.v4.util.Pair
public Pair getVerticalInset() {
int insetLeft = (int) resources.getDimension(R.dimen.list_padding);
int insetRight = 0;
return Pair.create(insetLeft, insetRight);
}
```
### If you want to padding in grid
- Java
```java
public class YourViewHolder extends RecyclerView.ViewHolder implements GridDivider {
public YourViewHolder(View itemView) {
super(itemView);
}
@Override
public int getPadding() {
return itemView.getContext().getResources().getDimensionPixelSize(R.dimen.tiny_margin);
}
@Override
public boolean getFullBleed() {
return false;
}
}
```
- Kotlin
```kotlin
class YourViewHolder(view: View): RecyclerView.ViewHolder(view), GridDivider {
override val padding = view.context.resources.getDimensionPixelSize(R.dimen.grid_padding)
override val fullBleed = true
}
```
### If you want to draw divider in specific position
- Java
```java
public class YourViewHolder extends RecyclerView.ViewHolder implements PositionDivider {
public YourViewHolder(View itemView) {
super(itemView);
}
@NotNull
@Override
public List getPositions() {
return Arrays.asList(2, 12, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 32, 42); // include "2"
}
@Override
public boolean getInverted() {
return false;
}
}
```
- Kotlin
```kotlin
class YourViewHolder(view: View): RecyclerView.ViewHolder(view), PositionDivider {
override val positions = listOf(2, 12, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 32, 42)
override val inverted = false
}
```
### If you __don't__ want to draw divider in specific position
Implements `PositionDivider` with `inverted` true
### If you want to draw custom divider in specific position
Implements `PositionDivider` and `VerticalDivider` or `HorizontalDivider`
## ProGuard
If you are using ProGuard you might need to add the following option:
```
-keep class com.sakebook.android.library.multilinedevider.*{ *; }
```
Sample in project [sample/](https://github.com/sakebook/MultiLineDivider/tree/master/sample)
## LICENSE
```
Copyright (C) 2017 Shinya Sakemoto
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.
```