KotStep

Note: If you're using KotStep v3 then please checkout the new docs: Documentation

Features

• Multiple stepper styles:
  • Horizontal Numbered Stepper
  • Horizontal Tab Stepper
  • Horizontal Icon Stepper
  • Horizontal Dashed Stepper
  • Vertical Icon Stepper
  • Vertical Tab Stepper
  • Vertical Numbered Stepper
  • Vertical Icon Stepper with Label
  • Vertical Tab Stepper with Label
  • Vertical Numbered Stepper with Label
• Easy integration with Jetpack Compose
• Optional checkmark icons for completed steps.
• Highly customizable appearance and behavior

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:

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

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

Please checkout KotStep v3 Docs if you've migrated the version to KotStep 3.0.0 and above: KotStep V3 Docs

Usage

Horizontal Stepper - Tab

HorizontalStepper(
    style = tabHorizontal(
        totalSteps = 3,
        currentStep = 1
    )
) {
	// Do something...
}

tabHorizontal Parameters

Example:

Horizontal Stepper - Icon

HorizontalStepper(
    style = iconHorizontal(
	currentStep = 1,
        icons = listOf(
            Icons.Default.AccountCircle,
	    ...
            Icons.Default.DateRange
        )
    )
) {
	// Do something...
}

iconHorizontal Parameters

Example:

Horizontal Stepper - Numbered

HorizontalStepper(
  style = numberedHorizontal(
    totalSteps = 5,
    currentStep = 1
  )
) {
	// Do something...
}      

numberedHorizontal Parameters

Example:

Horizontal Stepper - Dashed

HorizontalStepper(
  style = dashed(
    totalSteps = 5,
    currentStep = 1
  )
) {
	// Do something...
}    

dashed Parameters

Example:

Vertical Stepper - Tab

VerticalStepper(
  style = tabVertical(
    totalSteps = 5,
    currentStep = 1
  )
) {
	// Do something...
} 

tabVertical Parameters

Example:

Vertical Stepper - Tab with Label

VerticalStepper(
  style = tabVerticalWithLabel(
    totalSteps = 2,
    currentStep = 1,
    trailingLabels = listOf(
    	{ Text("Hello") },
        { Text("World") }
    )
  )
) {
	// Do something...
}

tabVerticalWithLabel Parameters

Example:

Vertical Stepper - Icon

VerticalStepper(
  style = iconVertical(
    currentStep = 1,
    icons = listOf(
      Icons.Default.AccountCircle,
      ...
      Icons.Default.DateRange
    )
  )
) {
	// Do something...
}    

iconVertical Parameters

Example:

Vertical Stepper - Icon with label

VerticalStepper(
  style = iconVerticalWithLabel(
    currentStep = 1,
    icons = listOf(
      Icons.Default.AccountCircle,
      Icons.Default.DateRange
    ),
    trailingLabels = listOf(
    	{ Text("Hello") },
        { Text("World") }
    )
  )
) {
	// Do something...
}    

iconVerticalWithLabel Parameters

Example:

Vertical Stepper - Numbered

VerticalStepper(
  style = numberedVertical(
    totalSteps = 5,
    currentStep = 1
  )
) {
	// Do something...
}    

numberedVertical Parameters

Example:

Vertical Stepper - Numbered with Label

VerticalStepper(
  style = numberedVerticalWithLabel(
    totalSteps = 2,
    currentStep = 1,
    trailingLabels = listOf(
    	{ Text("Hello") },
        { Text("World") }
    )
  )
) {
	// Do something...
}    

numberedVerticalWithLabel Parameters

Example:

StepStyle Parameters

Reporting Issues and Requesting Features✨

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

Supporting KotStep :heart:

Support it by joining stargazers for this repository. :star:

Also follow me for my next creations! 🤩

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.