Skip to content

ferPrieto/TimelineView

Repository files navigation

TimelineView 〰️

TimelineView provides a synchronized scrolling experience with two content views that move in complementary directions. Originally designed for audio waveform visualization, it's now a versatile component perfect for any timeline-based application.

Inspiration

Soundcloud Inspiration

This is the original Soundcloud wave scroll view that inspired this project.

Demo

Main Screen Light
Main Screen - Light Mode
Main Screen Dark
Main Screen - Dark Mode
Use Cases Light
Use Cases - Light Mode
Use Cases Dark
Use Cases - Dark Mode

Installation

1. Add this dependency in build.gradle (app-level)

Kotlin:

implementation("com.github.ferPrieto:timelineview:LATEST_VERSION_NUMBER")

Groovy:

implementation 'com.github.ferPrieto:timelineview:LATEST_VERSION_NUMBER'

If you are using a Gradle version catalog through a libs.versions.toml file:

  1. Add timelineview = "LATEST_VERSION_NUMBER" in the [versions] section.
  2. Add timelineview = { group = "com.github.ferPrieto", name = "timelineview", version.ref = "timelineview" } in the [libraries] section
  3. Add implementation(libs.timelineview) in the app-level build.gradle file

2. Include Jitpack repository

You must include jitpack.io in your settings.gradle file because it's a public dependency

Kotlin:

dependencyResolutionManagement {
   ...
    repositories {
      ...
      maven("https://jitpack.io")
    }
}

Groovy:

dependencyResolutionManagement {
   ...
    repositories {
      ...
      maven { url "https://jitpack.io" }
    }
}

Usage

Basic Implementation

@Composable
fun MyScreen() {
    TimelineView(
        height = 120.dp
    )
}

With Custom Content

@Composable
fun MyScreen() {
    TimelineView(
        height = 120.dp,
        pastContent = R.drawable.my_past_content,
        futureContent = R.drawable.my_future_content
    )
}

Advanced Configuration

@Composable
fun MyScreen() {
    TimelineView(
        height = 120.dp,
        pastContent = R.drawable.my_past_content,
        futureContent = R.drawable.my_future_content,
        offsetFraction = 1f/8f, // Custom offset
        dividerWidth = 1.dp,
        dividerColor = Color.Gray
    )
}

Simplified Version

@Composable
fun MyScreen() {
    TimelineViewSimple(
        height = 120.dp
    )
}

Material 3 Styled

@Composable
fun MyScreen() {
    TimelineViewMaterial3(
        height = 120.dp
    )
}

Structure

  • timelineview/: Core TimelineView library module
  • app/: Demo application showcasing various use cases

Documentation

For detailed API documentation, see timelineview/README.md

License

Copyright 2025 Fernando Prieto Moyano

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.

About

A Jetpack Compose modular UI component inspired by the Soundcloud wave scroll view.

Topics

Resources

Stars

Watchers

Forks

Packages

 
 
 

Contributors 3

  •  
  •  
  •  

Languages