jw-list

The schema defines the following properties:

instanceId (InstanceId | Expression)

options (List Widget Options, required)

Properties of the options object:

footer (string | Expression | TextWithFormat | TextLocale)

Footer text of widget

footerAlign (enum<string>)

Footer text align

This element must be one of the following enum values:

• left
• right
• center

placeholders (object[])

Widget specific placeholders config

The object is an array with all elements of the type object.

The array object has the following properties:

data (string)

item (JWListItemConfig | jc-product-item | jc-stage, required)

The object must be any of the following types:

item (JWListItemConfig)

item (jc-product-item)

item (jc-stage)

top (jc-trend)

Top part of widget

bottom (jc-trend)

Bottom part of widget

Sub Schemas

The schema defines the following additional types:

JWListItemConfig (component.list-item)

Properties of the JWListItemConfig object:

instanceId (InstanceId | Expression)

when (Expression | boolean)

options (List Item Options, required)

Properties of the options object:

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

First line of text - text won't wrap.

subtitle (string | Expression | TextWithFormat | TextLocale)

Second line of text - text won't wrap.

style (List Item Style)

More of them can be true. It will be evaluated based on priority.

Properties of the style object:

isDisabled (boolean | string)

Change style to disabled.

The object must be any of the following types:

isDisabled (string)

isError (boolean | string)

Change style to error.

The object must be any of the following types:

isError (string)

isWarning (boolean | string)

Change style to error.

The object must be any of the following types:

isWarning (string)

isPositive (boolean | string)

Change style to error.

The object must be any of the following types:

isPositive (string)

isStrikeThrough (boolean | string)

If the text is crossed out

The object must be any of the following types:

isStrikeThrough (string)

isHighlighted (boolean | string)

Change background to highlight item

The object must be any of the following types:

isHighlighted (string)

isWaitingSync (boolean | string)

Will display "Waiting sync" indicator

The object must be any of the following types:

isWaitingSync (string)

color (object[])

Changing color of list item based on conditions. First evaluated to true will be used.

The object is an array with all elements of the type object.

The array object has the following properties:

divider (enum<string>)

Space between two items in list. Transparent divider will make 1pt "margin" between two items. Solid displays colored line.

This element must be one of the following enum values:

• none
• transparent
• solid

Default: "none"

leftElement (icon | AvatarElement | ImageElement | progress | checkbox)

The object must be any of the following types:

leftElement (icon)

leftElement (AvatarElement)

leftElement (ImageElement)

leftElement (progress)

Properties of the leftElement object:

value (number | string, required)

Value between 0 and 1

The object must be any of the following types:

value (string)

title (string | Expression | TextWithFormat | TextLocale)

Title displayed in the middle of circle progress

leftElement (checkbox)

Properties of the leftElement object:

value (string | boolean | string)

Controlled value of checkbox

The object must be any of the following types:

value (string)

initialValue (string | boolean | string)

Uncontrolled value of checkbox

The object must be any of the following types:

initialValue (string)

onChange (keg-action-in-background)

Action Keg component that will be triggered when value is changed

rightElement (AmountControl | badge | button | icon | switch | value | checkbox)

The object must be any of the following types:

rightElement (AmountControl)

rightElement (badge)

Properties of the rightElement object:

isHidden (boolean | string)

When you want to hide this component

The object must be any of the following types:

isHidden (string)

rightElement (button)

Properties of the rightElement object:

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

Text displayed on button

onPress (keg-action-in-background, required)

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

rightElement (icon)

rightElement (switch)

Properties of the rightElement object:

value (string | boolean | string)

Initial value of switch

The object must be any of the following types:

value (string)

initialValue (string | boolean | string)

Uncontrolled value of switch

The object must be any of the following types:

initialValue (string)

onChange (keg-action-in-background)

Action Keg component that will be triggered when value is changed

rightElement (value)

Properties of the rightElement object:

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

Displayed value - text.

rightElement (checkbox)

Properties of the rightElement object:

value (string | boolean | string)

Controlled value of checkbox

The object must be any of the following types:

value (string)

initialValue (string | boolean | string)

Uncontrolled value of checkbox

The object must be any of the following types:

initialValue (string)

onChange (keg-action-in-background)

Action Keg component that will be triggered when value is changed

onPress (keg-action-in-background)

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

value (string | string)

Value of list item. It is used when selection for example

The object must be any of the following types:

value (string)

progress (number | string)

Value between 0 and 1 to show progress as background of list item

The object must be any of the following types:

progress (string)

label (Label)

Display label on list-item

Properties of the label object:

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

Title of label

color (object[])

Changing color of label based on conditions. First evaluated to true will be used.

The object is an array with all elements of the type object.

The array object has the following properties:

isHidden (boolean | string)

Hide label

The object must be any of the following types:

isHidden (string)

horizontalItemSize (HorizontalListItemSize)

Define variations of horizontal item

Default: "regular"

avatars (string)

The object must be any of the following types:

avatars (string)

description (string | Expression | TextWithFormat | TextLocale)

Third line of text - text won't wrap.

swipeable (object)

Right and left actions that are displayed when list item is swiped to the left/right

Properties of the swipeable object:

left (object[])

The object is an array with all elements of the type object.

The array object has the following properties:

right (object[])

The object is an array with all elements of the type object.

The array object has the following properties:

AvatarElement (avatar)

Avatar

Properties of the AvatarElement object:

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

Text displayed when uri is empty.

uri (string | string)

Source of image displayed as avatar

The object must be any of the following types:

uri (string)

onPress (keg-action-in-background)

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

ImageElement (image)

Properties of the ImageElement object:

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

Text displayed when uri is empty.

uri (string | string)

Source of image displayed as avatar

The object must be any of the following types:

uri (string)

onPress (keg-action-in-background)

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

resizeMode (ResizeMode)

Image resize mode

ResizeMode (enum<string>)

This element must be one of the following enum values:

• contain
• cover
• stretch
• center

AmountControl (amount-control)

Properties of the AmountControl object:

value (number | string)

Value of amount control

The object must be any of the following types:

value (string)

initialValue (number | string)

Initial value of amount control

The object must be any of the following types:

initialValue (string)

onChange (keg-action-in-background)

Action Keg component that will be triggered when value is changed

onDelete (ja-execute-entity | ja-execute-entities)

If this property is set, trash symbol is displayed when the value is 1 or (min + 1).

The object must be any of the following types:

onDelete (ja-execute-entity)

onDelete (ja-execute-entities)

minimum (number | string)

Limits the minimum number. Default is 0.

The object must be any of the following types:

minimum (string)

maximum (number | string)

Limits the maximum number.

The object must be any of the following types:

maximum (string)

step (number | string)

Step for increment/decrement. Default is 1.

The object must be any of the following types:

step (string)

HorizontalListItemSize (enum<string>)

Size variants of horizontal list-item

This element must be one of the following enum values:

• small
• regular
• large

AvatarItemConfig (Avatar)

Properties of the AvatarItemConfig object:

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

Text as placeholder in case of missing image

uri (string | string)

Source of image displayed as avatar

The object must be any of the following types:

uri (string)