KotStep Library

💜 KotStep is a Jetpack Compose library that simplifies the creation of customizable step-by-step UI components in your Android applications. It allows you to easily integrate vertical and horizontal stepper components with icons, titles, and various customization options.

Features

  • Vertical and horizontal stepper components.
  • Customizable colors, icons, and labels for each step.
  • Support for both text labels and icon-based steps.
  • Optional checkmark icons for completed steps.
  • Easily integrate step-by-step user interfaces into your Jetpack Compose apps.

Installation

To get started with KotStep in your Android Jetpack Compose project,

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

allprojects {
	repositories {
		...
	    maven { url 'https://jitpack.io' }
    }
}
  • Lastly, add the following dependency to your app’s build.gradle.kts (Kotlin) or build.gradle (Groovy) file:
Kotlin

dependencies {
    implementation("com.github.binayshaw7777:KotStep:$currentVersion")
}
Groovy

dependencies {
    implementation 'com.github.binayshaw7777:KotStep:$currentVersion'
}

Usage

  • Horizontal Sequenced Stepper

HorizontalSequencedStepper(
    totalSteps = totalSteps,
    currentStep = currentStep,
    stepSize = stepItemSize.dp,
    lineThickness = lineThickness.dp
)

Example:

  • Horizontal Icons Stepper

HorizontalIconStepper(
    totalSteps = totalSteps,
    currentStep = currentStep,
    stepSize = stepItemSize.dp,
    lineThickness = lineThickness.dp,
    stepIconsList = listOf(
        Icons.Default.AccountBox,
        Icons.Default.AddCircle,
        Icons.Default.Build,
        Icons.Default.Face,
        Icons.Default.Home
    )
)

Example:

  • Vertical Sequenced Stepper

VerticalSequencedStepper(
    totalSteps = 5,
    currentStep = 1,
    stepSize = 35.dp,
    lineThickness = 3.dp
)       

Example:

  • Vertical Icon Stepper

VerticalIconStepper(
    totalSteps = 5,
    currentStep = 1,
    stepSize = 35.dp,
    lineThickness = 3.dp,
    stepIconsList = listOf(
        Icons.Default.AccountBox,
        Icons.Default.AddCircle,
        Icons.Default.Build,
        Icons.Default.Face,
        Icons.Default.Home
    )
)

Example:

Reporting Issues and Requesting Features✨

If you encounter any issues or have feature requests, please create a new issue in this repository.

Supporting KotStep ❤️

Support it by joining stargazers for this repository. ⭐ Also follow me for my next creations! 🤩

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.">

Copyright 2023 binayshaw7777

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.

GitHub

View Github