Steps
Steps helps guide users through a process, one step at a time. It's perfect for things like forms, onboarding, or any task that involves multiple stages. Each step shows users where they are, what they've completed, and what’s next.
This makes complex tasks feel more manageable, giving users a clear sense of progress and direction. You can also add tooltips and status indicators to make the experience even more helpful.
Properties
Steps
This property lets you add the steps. Every object represents a step.
{{
[
{ name: 'step 1', tooltip: 'some tooltip', id: 1},
{ name: 'step 2', tooltip: 'some tooltip', id: 2},
{ name: 'step 3', tooltip: 'some tooltip', id: 3},
{ name: 'step 4', tooltip: 'some tooltip', id: 4},
{ name: 'step 5', tooltip: 'some tooltip', id: 5}
]
}}
Current step
This property lets you select the current step you want to be highlighted.
Steps selectable
This property when disabled will disable the selection of steps.
Events
Event | Description |
---|---|
On select | Triggers whenever the user selects any step. |
Component Specific Actions (CSA)
There are currently no CSA (Component-Specific Actions) implemented to regulate or control the component.
Exposed Variables
Variables | Description | How To Access |
---|---|---|
currentStepId | This variable holds the id of the currently selected step on the step component. | Access the value dynamically using JS: {{components.steps1.currentStepId}} |
General
Tooltip
A Tooltip is often used to specify extra information about something when the user hovers the mouse pointer over the component.
Under the General accordion, you can set the value in the string format. Now hovering over the component will display the string as the tooltip.
Devices
Property | Description | Expected Value |
---|---|---|
Show on desktop | Makes the component visible in desktop view. | You can set it with the toggle button or dynamically configure the value by clicking on fx and entering a logical expression. |
Show on mobile | Makes the component visible in mobile view. | You can set it with the toggle button or dynamically configure the value by clicking on fx and entering a logical expression. |
Styles
Style | Description |
---|---|
Theme | You can change the theme of a component by selecting available themes from the dropdown. |
Colour | You can change the color of the component by entering the Hex color code or choosing a color of your choice from the color picker. |
Text color | You can change the text color of the component by entering the Hex color code or choosing a color of your choice from the color picker. |
Visibility | Toggle on or off to control the visibility of the component. You can programmatically change its value by clicking on the fx button next to it. If {{false}} the component will not be visible after the app is deployed. By default, it's set to {{true}} . |
Any property having fx button next to its field can be programmatically configured.