Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sangcomz/StickyTimeLine
:book:StickyTimeLine is timeline view for android.
https://github.com/sangcomz/StickyTimeLine
android horizontal kotlin sticky stickyheader timeline timelineview vertical
Last synced: about 1 month ago
JSON representation
:book:StickyTimeLine is timeline view for android.
- Host: GitHub
- URL: https://github.com/sangcomz/StickyTimeLine
- Owner: sangcomz
- License: apache-2.0
- Created: 2017-11-20T07:27:30.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2024-03-29T16:16:21.000Z (9 months ago)
- Last Synced: 2024-11-01T23:05:29.472Z (about 2 months ago)
- Topics: android, horizontal, kotlin, sticky, stickyheader, timeline, timelineview, vertical
- Language: Kotlin
- Homepage:
- Size: 15.9 MB
- Stars: 582
- Watchers: 17
- Forks: 76
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome-kotlin - StickyTimeLine - Timeline view for Android. (Libraries / Android)
README
# StickyTimeLine
[](https://search.maven.org/artifact/io.github.sangcomz/StickyTimeLine)
StickyTimeLine is timeline view for android.
## What's New? :tada:
- [Improvement] lib version update
## Result Screen
Feel free to send me a pull request with your app and I'll link you here:
| Sample
| AlleysMap
| StockRoom
|
|:---------------------------------:|:--------------------------------:|:--------------------------------:|
| 
|
|
|
## How to Use
### Gradle
[](https://search.maven.org/artifact/io.github.sangcomz/StickyTimeLine)
```groovy
dependencies {
implementation 'io.github.sangcomz:StickyTimeLine:x.x.x'
}
```
### Usage
#### activity_main.xml
```xml
```
#### MainActivity.kt
```kotlin
class MainActivity : AppCompatActivity() {
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
setContentView(R.layout.activity_main)
val recyclerView: TimeLineRecyclerView = findViewById(R.id.recycler_view)
//Currently only LinearLayoutManager is supported.
recyclerView.layoutManager = LinearLayoutManager(this,
LinearLayoutManager.VERTICAL,
false)
//Get data
val singerList = getSingerList()
//Add RecyclerSectionItemDecoration.SectionCallback
recyclerView.addItemDecoration(getSectionCallback(singerList))
//Set Adapter
recyclerView.adapter = SingerAdapter(layoutInflater,
singerList,
R.layout.recycler_row)
}
//Get data method
private fun getSingerList(): List = SingerRepo().singerList
//Get SectionCallback method
private fun getSectionCallback(singerList: List): RecyclerSectionItemDecoration.SectionCallback {
return object : RecyclerSectionItemDecoration.SectionCallback {
//In your data, implement a method to determine if this is a section.
override fun isSection(position: Int): Boolean =
singerList[position].debuted != singerList[position - 1].debuted
//Implement a method that returns a SectionHeader.
override fun getSectionHeader(position: Int): SectionInfo? =
SectionInfo(singerList[position].debuted, singerList[position].group)
}
}
}
```
#### JavaExampleActivity.java
```java
public class JavaExampleActivity extends AppCompatActivity {
private Drawable icFinkl, icBuzz, icWannaOne, icGirlsGeneration, icSolo;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
initDrawable();
TimeLineRecyclerView recyclerView = findViewById(R.id.recycler_view);
recyclerView.setLayoutManager(new LinearLayoutManager(this,
RecyclerView.VERTICAL,
false));
List singerList = getSingerList();
recyclerView.addItemDecoration(getSectionCallback(singerList));
recyclerView.setAdapter(new SingerAdapter(getLayoutInflater(), singerList, R.layout.recycler_row));
}
private RecyclerSectionItemDecoration.SectionCallback getSectionCallback(final List singerList) {
return new RecyclerSectionItemDecoration.SectionCallback() {
@Nullable
@Override
public SectionInfo getSectionHeader(int position) {
Singer singer = singerList.get(position);
Drawable dot;
switch (singer.getGroup()) {
case "FIN.K.L": {
dot = icFinkl;
break;
}
case "Girls' Generation": {
dot = icGirlsGeneration;
break;
}
case "Buzz": {
dot = icBuzz;
break;
}
case "Wanna One": {
dot = icWannaOne;
break;
}
default: {
dot = icSolo;
}
}
return new SectionInfo(singer.getDebuted(), singer.getGroup(), dot);
}
@Override
public boolean isSection(int position) {
return !singerList.get(position).getDebuted().equals(singerList.get(position - 1).getDebuted());
}
};
}
private List getSingerList() {
return new SingerRepo().getSingerList();
}
private void initDrawable() {
icFinkl = AppCompatResources.getDrawable(this, R.drawable.ic_finkl);
icBuzz = AppCompatResources.getDrawable(this, R.drawable.ic_buzz);
icWannaOne = AppCompatResources.getDrawable(this, R.drawable.ic_wannaone);
icGirlsGeneration = AppCompatResources.getDrawable(this, R.drawable.ic_girlsgeneration);
icSolo = AppCompatResources.getDrawable(this, R.drawable.ic_wannaone);
}
}
```
##### caution
- *Currently only LinearLayoutManager is supported.*
#### recycler_row.xml
```xml
```
##### caution
- *Don't set margin value in the parent view.*
#### attribute
| Method Name | Description | Default Value |
|:------------------------:|-------------------------------------------------------|:-------------:|
|sectionBackgroundColor | To change section section background color | #f9f9f9 |
|sectionTitleTextColor | To change section title color | #414fca |
|sectionSubTitleTextColor | To change section sub title color | #d16767 |
|timeLineColor | To change line color in timeline | #51ae45 |
|timeLineDotColor | To change dot color in timeline | #51ae45 |
|timeLineCircleStrokeColor | To change dot stroke color in timeline | #f9f9f9 |
|sectionTitleTextSize | To change section title text size | 14sp |
|sectionSubTitleTextSize | To change section sub title text size | 12sp |
|timeLineWidth | To change line width in timeline | 4dp |
|isSticky | To change Sticky functionality in the Timeline | true |
|customDotDrawable | To change the circle to custom drawable | null |
|sectionBackgroundColorMode| To change section background area(for horizontal mode)| MODE_FULL |
|timeLineDotRadius | To change dot radius | 8dp |
|timeLineDotStrokeSize | To change dot stroke size | 4dp |
# Contribute
We welcome any contributions.
# Inspired by
* [tim.paetz](https://github.com/paetztm), I was inspired by his code. And I used some of his code in the library.
# License
Copyright 2019 Jeong Seok-Won
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.