website logo
👥 Community🎯 Samples on GitHub🚦 System Status
💡 Guides
🚀 Examples
🍕 Developer Reference
⚡️ Changelog
🎥 Video Library
Navigate through spaces
⌘K
Overview
Reference
Actions
Data
UI
Widgets
Docs powered by
Archbee
Reference
UI

jc-step

18min

The schema defines the following properties:

Property

Type

Required

Description

type

component.step

true



instanceId

InstanceId | Expression

false



when

Expression | boolean

false



options

Step Options

true



instanceId (InstanceId | Expression)

when (Expression | boolean)

options (Step Options, required)

Properties of the options object:

Property

Type

Required

Description

title

string | Expression | TextWithFormat | TextLocale

true

Title displayed on list item

description

string | Expression | TextWithFormat | TextLocale

false

Description of step displayed on list item as subtitle

value

string | string

true

Value of step. It is exposed to Jig's state. So you can use it anywhere inside of Jig

leftElement

icon

false

Define icon element

onPress

keg-action-in-background

false

Action Keg component that will be triggered by pressing on this list item.

style

object

false

Styling of step component

title (string | Expression | TextWithFormat | TextLocale, required)

Title displayed on list item

description (string | Expression | TextWithFormat | TextLocale)

Description of step displayed on list item as subtitle

value (string | string, required)

Value of step. It is exposed to Jig's state. So you can use it anywhere inside of Jig

The object must be any of the following types:

value (string)

leftElement (icon)

Define icon element

onPress (keg-action-in-background)

Action Keg component that will be triggered by pressing on this list item.

style (object)

Styling of step component

Properties of the style object:

Property

Type

Required

Description

isPositive

string | boolean

false

Set design to positive

isNegative

string | boolean

false

Set design to negative

isWarning

string | boolean

false

Set design to warning

isActive

string | boolean

false

Set true if the step is in active state

isDisabled

string | boolean

false

Set style to disabled

isStrikeThrough

string | boolean

false

Strike through style for the item

isPositive (string | boolean)

Set design to positive

The object must be any of the following types:

isPositive (string)

isNegative (string | boolean)

Set design to negative

The object must be any of the following types:

isNegative (string)

isWarning (string | boolean)

Set design to warning

The object must be any of the following types:

isWarning (string)

isActive (string | boolean)

Set true if the step is in active state

The object must be any of the following types:

isActive (string)

isDisabled (string | boolean)

Set style to disabled

The object must be any of the following types:

isDisabled (string)

isStrikeThrough (string | boolean)

Strike through style for the item

The object must be any of the following types:

isStrikeThrough (string)



Updated 25 Sep 2023
Did this page help you?
PREVIOUS
jc-stage
NEXT
jc-stepper
Docs powered by
Archbee
TABLE OF CONTENTS
instanceId (InstanceId | Expression)
when (Expression | boolean)
options (Step Options, required)
title (string | Expression | TextWithFormat | TextLocale, required)
description (string | Expression | TextWithFormat | TextLocale)
value (string | string, required)
value (string)
leftElement (icon)
onPress (keg-action-in-background)
style (object)
isPositive (string | boolean)
isPositive (string)
isNegative (string | boolean)
isNegative (string)
isWarning (string | boolean)
isWarning (string)
isActive (string | boolean)
isActive (string)
isDisabled (string | boolean)
isDisabled (string)
isStrikeThrough (string | boolean)
isStrikeThrough (string)
Docs powered by
Archbee
Copyright © 2023 Jigx, Inc. All rights reserved. Terms of Service