JetLime ⏱️

A simple yet highly customizable library for showing a TimeLine view

Compose
Compose
Maven Central
Github Followers
Twitter Follow

Made with ❤ using Compose

Simple Animated Fancy

Implementation

In build.gradle of app module, include the following dependency

dependencies {
  implementation("io.github.pushpalroy:jetlime:1.0.0")
}

Usage

✌🏻 To start using JetLime, use the composable JetLimeView like this:

val jetLimeList = remember {
  mutableStateListOf(
    JetLimeItem(
      title = "Item title",
      description = "Item description",
      jetLimeItemConfig = JetLimeItemConfig(
        itemHeight = 80.dp,
        iconType = IconType.Filled
      )
    )
  )
}

JetLimeView(
  jetLimeItems = jetLimeList,
  jetLimeViewConfig = JetLimeViewConfig(lineType = LineType.Solid),
  modifier = Modifier.padding(16.dp)
)

🤘🏻 To customize JetLimeView more play around with JetLimeViewConfig:

val jetTimeLineViewConfig = JetLimeViewConfig(
  backgroundColor = Color(0xFF747474),
  lineColor = Color(0xff00ACEE),
  lineThickness = 12F,
  lineType = LineType.Solid,
  lineStartMargin = 48.dp,
  lineEndMargin = 36.dp,
  iconSize = 26.dp,
  iconShape = CircleShape,
  iconBorderThickness = 2.dp,
  itemSpacing = 0.dp,
  enableItemAnimation = false,
  showIcons = true
)

👌🏻 To customize each item of the view configure JetLimeItemConfig for each item:

val jetLimeItemConfig = JetLimeItemConfig(
  titleColor = Color(0xFF2C2C2C),
  descriptionColor = Color(0xFF3A3A3A),
  iconType = IconType.Checked,
  iconColor = Color(0xFF3F51B5),
  iconBorderColor = Color(0xFFFFFFFF),
  iconBackgroundColor = Color(0xFF44485F),
  itemHeight = 60.dp
)

😲 Custom animations can be done for each item icon using iconAnimation:

  val jetLimeItemConfig = JetLimeItemConfig(
    iconAnimation = IconAnimation(
      initialValue = 0.5f,
      targetValue = 1.5f,
      keySpecs = keyframes {
        durationMillis = 500
        0.6f at 0
        0.7f at 100
        0.8f at 200
        0.9f at 300
        1f at 500
      }
    )
)

😱 Apart from title and description you can pass any composable to JetLimeItem:

JetLimeItem(
  title = "Some Title",
  description = "Some Description"
) {
  // Pass any composable here
}

🤪 Use custom icon of ImageVector type for each item:

iconType = IconType.Custom(Icons.Rounded.AccountCircle)

🙏 Got inspired by:

Timeline-View by Vipul Asri

License

MIT License

Copyright (c) 2022 Pushpal Roy

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

GitHub

View Github