website logo
👥 Community🎯 Samples on GitHub🚦System Status
💡 Guides
🚀 Examples
🍕 Developer Reference
⚡️ Changelog
🎥 Video Library
Navigate through spaces
⌘K
Examples Overview
Setting up your solution
Jig Types
Components
Datasource
Actions
Preview
Widgets
Expressions
Aggregation
Boolean
Comparison Operators
Date & Time
Path Operators
Functional Programming
Jigx Variables
Predicate Queries
String
Docs powered by
Archbee
Components

stepper

6min

This component displays the progress status of a task.

Stepper Preview
Stepper Preview


Configuration options

Some properties are common to all components, see Common component properties for a list and their configuration options.



The core structure includes: data, item, and completedPercentage (uses decimals, 1 equals completed)

The item property is the step component.

Other options:

title and subtitle - The title and subtitle/short description of the stepper

style - There are styling sets:

  • isNegative
  • isPositive
  • isWarning

isExpandable - The boolean value that allows you to choose if the stepper will be expandable into steps or not

The item property is core for the stepper component, so even if you are creating a non-expandable stepper there is a need of filling the step component's title and value properties with an empty string: "")

Examples and code snippets 

Stepper example

Document image


In this example, we see a stepper component that shows us that the task is half done. For completeness, we will use it together with the step component. After expanding the stepper, the individual steps will be shown to us.

Examples: See the full example using static data in GitHub. See the full example using dynamic data in GitHub.

Datasource: See the full datasource for static data in GitHub. See the full datasource for dynamic data in GitHub.

stepper (static)
stepper (dynamic)
datasources (static)
datasources (dynamic)
|
tchildren:
  - type: component.stepper
    options:
      data: =@ctx.datasources.steps-dynamic
      isExpandable: true
      title: Shipment in transit
      item:
        type: component.step
        options:
          title: =@ctx.current.item.title
          description: =@ctx.current.item.description
          value: =@ctx.current.item.value 
          leftElement:
            element: icon
            icon: =@ctx.current.item.icon
          style:
            isPositive: =@ctx.current.item.iscompleted
            isActive: =@ctx.current.item.isactive
            isStrikeThrough: =@ctx.current.item.iscompleted
            isDisabled: =@ctx.current.item.iswaiting
      completedPercentage: 0.5
      style:  
        isPositive: false
        isWarning: false
        isNegative: false


See also

  • Developer reference
  • Related examples (Github)



Updated 19 Sep 2023
Did this page help you?
PREVIOUS
location
NEXT
step
Docs powered by
Archbee
TABLE OF CONTENTS
Configuration options
Examples and code snippets
Stepper example
See also
Docs powered by
Archbee
Copyright © 2023 Jigx, Inc. All rights reserved. Terms of Service