Stepper

The stepper component can be used to show a numbered list of steps next to a form component to indicate the progress and number of steps that are required to complete and submit the form data.

Usage

Note If you are not using Tailwind CSS, you can skip this step. On your tailwind.config.js file, add the Stepper component within the ui() plugin.

import ui from "franken-ui";
 
ui({
    components: {
        stepper: {
            hooks: {},
            media: true
        }
    }
}),

To create a stepper, just add the .uk-stepper class to a <ul> tag.

<ul class="uk-stepper uk-stepper-default">
    <li>
        <a href="#">Personal Info</a>
    </li>
    <li>
        <a href="#">Account Info</a>
    </li>
    <li>
        <a href="#">Confirmation</a>
    </li>
</ul>

Active modifier

This example can be used to highlight the current step in the stepper, indicating which step is actively being worked on.

Note When you add the .uk-active class to one of your li tags, the previous li tags will automatically change colors.

Checked modifier

To show a checkmark when the step has been finished, add the .uk-stepper-checked to one of your li tag.

Counter modifier

This example can be used to display step numbers within the stepper, helping to indicate the sequence of steps. Each li tag will be numbered to show its position in the progression.

Available hooks

Learn more about using hooks.