Skip to content

Latest commit

 

History

History
124 lines (90 loc) · 2.86 KB

README.md

File metadata and controls

124 lines (90 loc) · 2.86 KB

Jetpack Compose Progress

This library aims to develop multiple customizable types of progress components.

Key Features

  • Fully compose infrastructure
  • Instantly tracked state structure
  • Lightweight with its pure component structure
  • Highly customizable
  • Animation option included in components
  • Continuous development

Add Your Project

Add it in your root build.gradle at the end of repositories:

  allprojects {
		repositories {
			...
			maven { url 'https://jitpack.io' }
		}
	}

Add the dependency:

  dependencies {
	    implementation 'com.github.DogusTeknoloji:compose-progress:version'
	}

How to Use

Animated BarProgress

fun BarProgress(
    modifier: Modifier,
    progressColor: Color,
    progressBackgroundColor: Color,
    fillProgressBy: Float,
    indicators: List<Float>? = null,
    indicatorColor: Color = Color.White,
    indicatorWidth: Float = 5f,
    cornerRadius: CornerRadius = CornerRadius.Zero,
    stepImageVector: ImageVector? = null,
    stepImageVectorMultiplier: Float = 0.6f,
    animationDuration: Int,
    animationDelay: Int = 0
)

Simple BarProgress

fun BarProgress(
    modifier: Modifier,
    progressColor: Color,
    progressBackgroundColor: Color,
    fillProgressBy: Float,
    indicators: List<Float>? = null,
    indicatorColor: Color = Color.White,
    indicatorWidth: Float = 5f,
    cornerRadius: CornerRadius = CornerRadius.Zero,
    stepImageVector: ImageVector? = null,
    stepImageVectorMultiplier: Float = 0.6f
)

StepProgress

fun StepProgress(
    modifier: Modifier,
    progressColor: Color,
    progressBackgroundColor: Color,
    currentStep: Int,
    totalStep: Int,
    indicatorColor: Color = Color.White,
    indicatorWidth: Float = 5f,
    cornerRadius: CornerRadius = CornerRadius.Zero,
    stepImageVector: ImageVector? = null,
    stepImageVectorMultiplier: Float = 0.6f
)

Bar Progress

Basic BarProgress without any indicator and Icon

Basic BarProgress with indicators

Animated BarProgress with indicators and icon

Step Progress

Basic StepProgress with Icon

Note that

You can create any shape you want with modifier parameter, these screenshots are just basic samples.

What is next ?

  • Animated StepBar
  • Different types of progress
  • More customizable components