updated to 1.0.0-beta.5

Author: developerchunk

.idea/copilot.data.migration.agent.xml

@@ -114,7 +114,7 @@ fun StepperPreview() {
 
         Column(
             modifier = Modifier
-                .padding(top = 50.dp, bottom = 40.dp)
+                .padding(top = 50.dp, bottom = 60.dp)
                 .fillMaxSize()
                 .padding(16.dp)
         ) {

.idea/copilot.data.migration.ask.xml

@@ -28,6 +28,7 @@ import androidx.compose.ui.unit.dp
  * @param dividerEffect PathEffect for the dashed divider.
  * @param dividerStrokeWidth Width of the dashed divider line.
  * @param dividerColor Color of the dashed divider line.
+ * @param notchWeight Vertical position of the notches as a fraction of card height (0f to 1f).
  * @param content Card body composable content. Use [TicketContent] to split the card into sections.
  */
 @Composable

.idea/copilot.data.migration.edit.xml

@@ -30,7 +30,43 @@ import com.developerstring.jetco.ui.components.stepper.model.StepperActionIcons
 import com.developerstring.jetco.ui.components.stepper.model.StepperConfig
 import com.developerstring.jetco.ui.components.stepper.model.StepperNode
 
-// Compact Horizontal Stepper (for mobile screens)
+/**
+ * A compact horizontal stepper component for Jetpack Compose.
+ *
+ * The [CompactHorizontalStepper] arranges steps horizontally in a more space-efficient layout
+ * compared to [HorizontalStepper]. It is designed for cases where screen width is limited,
+ * or when you want a cleaner, minimal representation of step progress.
+ *
+ * ### Features
+ * - Displays step nodes with optional icons based on [StepperActionIcons].
+ * - Provides a **compact layout** with smaller labels and reduced spacing.
+ * - Supports **custom styling** with [StepperConfig] (colors, spacing, shapes, typography).
+ * - Allows **step interactions** through [onStepClick] callback.
+ *
+ * ### Example Usage
+ * ```kotlin
+ * val steps = listOf(
+ *     StepperNode("Login", status = StepperStatus.COMPLETE),
+ *     StepperNode("Details", status = StepperStatus.ACTIVE),
+ *     StepperNode("Summary", status = StepperStatus.IDLE),
+ *     StepperNode("Finish", status = StepperStatus.IDLE),
+ * )
+ *
+ * CompactHorizontalStepper(
+ *     steps = steps,
+ *     currentStep = 2,
+ *     style = StepperConfig(),
+ *     onStepClick = { index -> println("Step $index clicked") }
+ * )
+ * ```
+ *
+ * @param steps List of [StepperNode] representing the steps in the compact horizontal flow.
+ * @param currentStep The index of the current active step (0-based).
+ * @param modifier Modifier to be applied to the stepper layout.
+ * @param style Styling options for customizing the stepper’s appearance via [StepperConfig].
+ * @param stepperActionIcons Icons for step states like active, completed, and error.
+ * @param onStepClick Optional callback invoked with the index when a step is clicked.
+ */
 @Composable
 fun CompactHorizontalStepper(
     steps: List<StepperNode>,

app/src/main/java/com/developerstring/jetco_library/StepperCompPreview.kt

@@ -36,7 +36,45 @@ import com.developerstring.jetco.ui.components.stepper.model.StepperConfig
 import com.developerstring.jetco.ui.components.stepper.model.StepperNode
 import com.developerstring.jetco.ui.components.stepper.model.StepperStatus
 
-// Horizontal Stepper Component
+/**
+ * A customizable horizontal stepper component built with Jetpack Compose.
+ *
+ * The [HorizontalStepper] arranges a list of steps horizontally, connected with lines between them.
+ * Each step is represented by a node and an optional title/label below it.
+ *
+ * ### Features
+ * - Supports **progress animations** for node connectors.
+ * - Allows **custom icons** for Active, Completed, and Error states via [StepperActionIcons].
+ * - **Customizable styling** via [StepperConfig] (colors, shape, spacing, typography, path effects, etc.).
+ * - Steps are **interactive** with [onStepClick] callback support.
+ * - Labels can be shown or hidden using [showLabels].
+ * - Supports scrolling if the number of steps exceeds available width via [scrollEnable].
+ *
+ * ### Example Usage
+ * ```kotlin
+ * val steps = listOf(
+ *     StepperNode("Cart", status = StepperStatus.COMPLETE),
+ *     StepperNode("Delivery", status = StepperStatus.ACTIVE),
+ *     StepperNode("Payment", status = StepperStatus.IDLE),
+ *     StepperNode("Confirmation", status = StepperStatus.IDLE),
+ * )
+ *
+ * HorizontalStepper(
+ *     steps = steps,
+ *     showLabels = true,
+ *     style = StepperConfig(),
+ *     onStepClick = { index -> println("Step $index clicked") }
+ * )
+ * ```
+ *
+ * @param steps List of [StepperNode] representing the steps in the horizontal flow.
+ * @param modifier Modifier to be applied to the stepper layout.
+ * @param style Customization options for the stepper look & feel via [StepperConfig].
+ * @param stepperActionIcons Icons to display for different step states (active, completed, error).
+ * @param showLabels Whether to display the step titles/labels below each node.
+ * @param scrollEnable Whether the stepper should allow horizontal scrolling if content exceeds width.
+ * @param onStepClick Callback invoked with the step index when a step is clicked. Can be `null` if not needed.
+ */
 @Composable
 fun HorizontalStepper(
     steps: List<StepperNode>,

jetco/ui/src/main/java/com/developerstring/jetco/ui/cards/ticket/TickerCard.kt

@@ -1,7 +1,6 @@
 package com.developerstring.jetco.ui.components.stepper
 
 import androidx.compose.animation.core.animateFloatAsState
-import androidx.compose.animation.core.tween
 import androidx.compose.foundation.Canvas
 import androidx.compose.foundation.Image
 import androidx.compose.foundation.layout.Arrangement
@@ -42,7 +41,41 @@ import com.developerstring.jetco.ui.components.stepper.model.StepperConfig
 import com.developerstring.jetco.ui.components.stepper.model.StepperNode
 import com.developerstring.jetco.ui.components.stepper.model.StepperStatus
 
-// Vertical Stepper Component
+/**
+ * A customizable vertical stepper component built with Jetpack Compose.
+ *
+ * The [VerticalStepper] arranges a list of steps vertically, each step represented by a node and connector line between them.
+ * Steps can show a title, description, and status (Idle, Active, Complete, or Error).
+ *
+ * ### Features
+ * - Supports **animations** for node and connector line drawing.
+ * - Allows **custom icons** for Active, Completed, and Error states via [StepperActionIcons].
+ * - **Customizable styling** via [StepperConfig] (colors, shape, spacing, typography, path effects, etc.).
+ * - Each step is clickable with [onStepClick] callback.
+ * - Can be scrollable or fixed using [scrollEnable].
+ *
+ * ### Example Usage
+ * ```kotlin
+ * val steps = listOf(
+ *     StepperNode("Account Created", "Your account has been created", status = StepperStatus.COMPLETE),
+ *     StepperNode("Profile Setup", "Fill in your profile details", status = StepperStatus.ACTIVE),
+ *     StepperNode("Verification", "Pending verification", status = StepperStatus.IDLE),
+ * )
+ *
+ * VerticalStepper(
+ *     steps = steps,
+ *     style = StepperConfig(),
+ *     onStepClick = { index -> println("Step $index clicked") }
+ * )
+ * ```
+ *
+ * @param steps List of [StepperNode] representing the steps in the vertical flow.
+ * @param modifier Modifier to be applied to the stepper layout.
+ * @param style Customization options for the stepper look & feel via [StepperConfig].
+ * @param stepperActionIcons Icons to display for different step states (active, completed, error).
+ * @param scrollEnable Whether the stepper should allow vertical scrolling if content exceeds bounds.
+ * @param onStepClick Callback invoked with the step index when a step is clicked. Can be `null` if not needed.
+ */
 @Composable
 fun VerticalStepper(
     steps: List<StepperNode>,
@@ -59,7 +92,7 @@ fun VerticalStepper(
 
     val animatedProgress by animateFloatAsState(
         targetValue = if (animationTriggered) 1f else 0f,
-        animationSpec = tween(style.animation.durationMillis),
+        animationSpec = style.animation.animationSpec,
         label = "node_animation"
     )
 
@@ -118,6 +151,7 @@ private fun VerticalStepItem(
                 .width(style.node.size)
                 .fillMaxHeight()
         ) {
+
             // Node
             Card(
                 modifier = Modifier

jetco/ui/src/main/java/com/developerstring/jetco/ui/components/stepper/CompactHorizontalStepper.kt

@@ -1,5 +1,7 @@
 package com.developerstring.jetco.ui.components.stepper.model
 
+import androidx.compose.animation.core.AnimationSpec
+import androidx.compose.animation.core.tween
 import androidx.compose.foundation.layout.PaddingValues
 import androidx.compose.foundation.shape.CircleShape
 import androidx.compose.ui.graphics.Color
@@ -102,10 +104,12 @@ data class StepperConfig(
      *
      * @property enabled Whether animations are enabled.
      * @property durationMillis Duration of node/connector animations in milliseconds.
+     * @property animationSpec The animation specification to use (default: tween with [durationMillis]).
      */
     data class AnimationConfig(
         val enabled: Boolean = true,
-        val durationMillis: Int = 1200
+        val durationMillis: Int = 1200,
+        val animationSpec: AnimationSpec<Float> = tween(durationMillis)
     )
 
     /**

jetco/ui/src/main/java/com/developerstring/jetco/ui/components/stepper/HorizontalStepper.kt

@@ -25,8 +25,8 @@ ext {
 
     library = [
             groupId        : "com.developerstring.jetco",
-            version_name   : "1.0.0-beta.4",
-            version_code   : 4,
+            version_name   : "1.0.0-beta.5",
+            version_code   : 5,
             target_sdk     : 36,
             min_sdk        : 21,
             compose_min_sdk: 21,