jig-list-specification
The object must be any of the following types:
Properties of the object:
Property | Type | Required | Description |
type | jig.list | true | |
title | string | Expression | TextWithFormat | TextLocale | true | Will be displayed as the title of both Widgets and Jigs. |
jigId | string | false | |
datasources | object | false | |
expressions | object | false | |
isCollapsible | boolean | string | false | If jig is collapsible on composite card |
isInitiallyCollapsed | boolean | string | false | Initial state of composite card if collapsible is active |
isWaitingSync | boolean | string | false | If true, "waiting sync" indication will be displayed on the Jig. |
isHomeButtonVisible | boolean | string | false | If false, home button will be hidden. This can add some extra space to the Jig in some cases. |
icon | false | The icon will be displayed on the 1x1 widget of this jig. Please use Ctrl+Space for browsing the list of available icons. | |
actions | jig-actions[] | false | |
description | string | Expression | TextWithFormat | TextLocale | false | |
header | false | | |
outputs | object | false | |
placeholders | object[] | false | |
stories | KegStoriesConfiguration | false | |
summary | object | false | |
preview | JigPreviewConfiguration | false | |
badge | number | Expression | empty | object[] | false | |
onFocus | false | Actions will be executed when user navigates to the jig. | |
onRefresh | false | Actions will be executed when user pulls to refresh the jig. | |
isSelectable | boolean | false | |
widgets | JigListWidgets | false | |
sections | SectionBase[] | false | Array of sections (groups of items). Every group will start with section header. Useful when you want to do favorite as a first group, so user doesn't need to search in huge list of items. |
item | ItemOptions | true | Item displayed in list for each data item from data. It can get the item data from @context.current.item. |
isSearchable | boolean | false | Whether or not the list is searchable |
isHorizontal | boolean | false | If true the list will be horizontal instead of vertical. |
isHorizontalScrollIndicatorHidden | boolean | false | If true it will hide horizontal scroll indicator |
isVerticalScrollIndicatorHidden | boolean | false | If true it will hide vertical scroll indicator |
hasActiveItem | boolean | false | List has active item state |
filter | object[] | string | false | |
Will be displayed as the title of both Widgets and Jigs.
If jig is collapsible on composite card
The object must be any of the following types:
Default: false
Initial state of composite card if collapsible is active
The object must be any of the following types:
Default: false
If true, "waiting sync" indication will be displayed on the Jig.
The object must be any of the following types:
Default: false
If false, home button will be hidden. This can add some extra space to the Jig in some cases.
The object must be any of the following types:
Default: true
The icon will be displayed on the 1x1 widget of this jig. Please use Ctrl+Space for browsing the list of available icons.
actions (jig-actions[])
The object is an array with all elements of the type jig-actions.
The object is an array with all elements of the type object.
The array object has the following properties:
The object must be any of the following types:
The object is an array with all elements of the type object.
The array object has the following properties:
Actions will be executed when user navigates to the jig.
Actions will be executed when user pulls to refresh the jig.
Array of sections (groups of items). Every group will start with section header. Useful when you want to do favorite as a first group, so user doesn't need to search in huge list of items.
The object is an array with all elements of the type SectionBase.
Item displayed in list for each data item from data. It can get the item data from @context.current.item.
The object must be any of the following types:
The object is an array with all elements of the type object.
The array object has the following properties:
Property | Type | Required | Description |
title | string | Expression | TextWithFormat | TextLocale | true | |
value | string | number | boolean | string | true | |
The object must be any of the following types:
Properties of the object:
Property | Type | Required | Description |
type | jig.list | true | |
title | string | Expression | TextWithFormat | TextLocale | true | Will be displayed as the title of both Widgets and Jigs. |
jigId | string | false | |
datasources | object | false | |
expressions | object | false | |
isCollapsible | boolean | string | false | If jig is collapsible on composite card |
isInitiallyCollapsed | boolean | string | false | Initial state of composite card if collapsible is active |
isWaitingSync | boolean | string | false | If true, "waiting sync" indication will be displayed on the Jig. |
isHomeButtonVisible | boolean | string | false | If false, home button will be hidden. This can add some extra space to the Jig in some cases. |
icon | false | The icon will be displayed on the 1x1 widget of this jig. Please use Ctrl+Space for browsing the list of available icons. | |
actions | jig-actions[] | false | |
description | string | Expression | TextWithFormat | TextLocale | false | |
header | false | | |
outputs | object | false | |
placeholders | object[] | false | |
stories | KegStoriesConfiguration | false | |
summary | object | false | |
preview | JigPreviewConfiguration | false | |
badge | number | Expression | empty | object[] | false | |
onFocus | false | Actions will be executed when user navigates to the jig. | |
onRefresh | false | Actions will be executed when user pulls to refresh the jig. | |
isSelectable | boolean | false | |
widgets | JigListWidgets | false | |
data | string | false | Array of items you want to display. |
item | ItemOptions | true | Item displayed in list for each data item from data. It can get the item data from @context.current.item. |
isSearchable | boolean | false | Whether or not the list is searchable |
isHorizontal | boolean | false | If true the list will be horizontal instead of vertical. |
isHorizontalScrollIndicatorHidden | boolean | false | If true it will hide horizontal scroll indicator |
isVerticalScrollIndicatorHidden | boolean | false | If true it will hide vertical scroll indicator |
hasActiveItem | boolean | false | List has active item state |
filter | object[] | string | false | |
Will be displayed as the title of both Widgets and Jigs.
If jig is collapsible on composite card
The object must be any of the following types:
Default: false
Initial state of composite card if collapsible is active
The object must be any of the following types:
Default: false
If true, "waiting sync" indication will be displayed on the Jig.
The object must be any of the following types:
Default: false
If false, home button will be hidden. This can add some extra space to the Jig in some cases.
The object must be any of the following types:
Default: true
The icon will be displayed on the 1x1 widget of this jig. Please use Ctrl+Space for browsing the list of available icons.
actions (jig-actions[])
The object is an array with all elements of the type jig-actions.
The object is an array with all elements of the type object.
The array object has the following properties:
The object must be any of the following types:
The object is an array with all elements of the type object.
The array object has the following properties:
Actions will be executed when user navigates to the jig.
Actions will be executed when user pulls to refresh the jig.
Array of items you want to display.
Item displayed in list for each data item from data. It can get the item data from @context.current.item.
The object must be any of the following types:
The object is an array with all elements of the type object.
The array object has the following properties:
Property | Type | Required | Description |
title | string | Expression | TextWithFormat | TextLocale | true | |
value | string | number | boolean | string | true | |
The object must be any of the following types:
The schema defines the following additional types:
Properties of the JigPreviewConfiguration object:
Property | Type | Required | Description |
header | false | | |
actions | JigActionsOnPreview[] | false | |
children | JigPreviewChild[] | true | |
isCompact | boolean | false | When true the preview will inherit its size from the content. |
The object is an array with all elements of the type JigActionsOnPreview.
The object is an array with all elements of the type JigPreviewChild.
Properties of the JigActionsOnPreview object:
Property | Type | Required | Description |
when | string | boolean | false | Whether or not these actions are displayed on the screen. Default is 'true'. |
children | KegActionOnPreviewConfiguration[] | true | Actions displayed when preview is opened |
style | Style | false | Styles for action panel |
Actions displayed when preview is opened
The object is an array with all elements of the type KegActionOnPreviewConfiguration.
Styles for action panel
Properties of the style object:
Property | Type | Required | Description |
isDisabled | boolean | string | false | Whether or not actions are disabled |
isEssential | boolean | string | false | Only actions are displayed. Nothing else. |
isDanger | boolean | string | false | Whether or not action is dangerous |
Whether or not actions are disabled
The object must be any of the following types:
Only actions are displayed. Nothing else.
The object must be any of the following types:
Whether or not action is dangerous
The object must be any of the following types:
KegActionOnPreviewConfiguration (ja-action-list | ja-confirm | ja-execute-entities | ja-execute-entity | ja-go-to | ja-open-url | ja-reset-state | ja-set-state | ja-sync-entities)
The object must be any of the following types:
JigPreviewChild (jc-entity | jc-web-view)
This should be only "readonly" children. Because user can't interact with content in preview (longpress). So it makes no sense to have form, etc. on it. I didn't add Section as well because then we would have extra SectionOnPreviewChild type (which is not a problem but I am not even sure if section is needed on preview). Let's keep an eye on this and add it later if needed.
The object must be any of the following types:
Properties of the JigListWidgets object:
Property | Type | Required | Description |
1x1 | keg-widget | JigListView | false | |
2x2 | keg-widget | JigListView | false | |
2x4 | keg-widget | JigListView | false | |
4x2 | keg-widget | JigListView | false | |
4x4 | Keg4x4WidgetConfiguration | JigListView | false | |
1x1 (keg-widget | JigListView)
The object must be any of the following types:
2x2 (keg-widget | JigListView)
The object must be any of the following types:
2x4 (keg-widget | JigListView)
The object must be any of the following types:
4x2 (keg-widget | JigListView)
The object must be any of the following types:
The object must be any of the following types:
KegWidgetConfigurationBase (jw-actions | jw-avatar | jw-chart | jw-image | jw-list | jw-location | jw-status | jw-value)
The object must be any of the following types:
The object must be any of the following types:
Reuse the list jig configuration with a possibility to extend or override some of the properties.
Properties of the JigListView object:
Property | Type | Required | Description |
widgets | KegWidgetOptionsBase | false | |
data | string | false | Array of items you want to display. |
item | ItemOptions | true | Item displayed in list for each data item from data. It can get the item data from @context.current.item. |
isSearchable | boolean | false | Whether or not the list is searchable |
isHorizontal | boolean | false | If true the list will be horizontal instead of vertical. |
isHorizontalScrollIndicatorHidden | boolean | false | If true it will hide horizontal scroll indicator |
isVerticalScrollIndicatorHidden | boolean | false | If true it will hide vertical scroll indicator |
hasActiveItem | boolean | false | List has active item state |
filter | object[] | string | false | |
Array of items you want to display.
Item displayed in list for each data item from data. It can get the item data from @context.current.item.
The object must be any of the following types:
The object is an array with all elements of the type object.
The array object has the following properties:
Property | Type | Required | Description |
title | string | Expression | TextWithFormat | TextLocale | true | |
value | string | number | boolean | string | true | |
The object must be any of the following types:
Reuse the list jig configuration with a possibility to extend or override some of the properties.
Properties of the JigListView object:
Property | Type | Required | Description |
widgets | KegWidgetOptionsBase | false | |
sections | SectionBase[] | false | Array of sections (groups of items). Every group will start with section header. Useful when you want to do favorite as a first group, so user doesn't need to search in huge list of items. |
item | ItemOptions | true | Item displayed in list for each data item from data. It can get the item data from @context.current.item. |
isSearchable | boolean | false | Whether or not the list is searchable |
isHorizontal | boolean | false | If true the list will be horizontal instead of vertical. |
isHorizontalScrollIndicatorHidden | boolean | false | If true it will hide horizontal scroll indicator |
isVerticalScrollIndicatorHidden | boolean | false | If true it will hide vertical scroll indicator |
hasActiveItem | boolean | false | List has active item state |
filter | object[] | string | false | |
Array of sections (groups of items). Every group will start with section header. Useful when you want to do favorite as a first group, so user doesn't need to search in huge list of items.
The object is an array with all elements of the type SectionBase.
Item displayed in list for each data item from data. It can get the item data from @context.current.item.
The object must be any of the following types:
The object is an array with all elements of the type object.
The array object has the following properties:
Property | Type | Required | Description |
title | string | Expression | TextWithFormat | TextLocale | true | |
value | string | number | boolean | string | true | |
The object must be any of the following types:
Base class for all Widget options
Properties of the KegWidgetOptionsBase object:
Property | Type | Required | Description |
footer | string | Expression | TextWithFormat | TextLocale | false | Footer text of widget |
footerAlign | enum<string> | false | Footer text align |
placeholders | object[] | false | Widget specific placeholders config |
Footer text of widget
Footer text align
This element must be one of the following enum values:
- left
- right
- center
Widget specific placeholders config
The object is an array with all elements of the type object.
The array object has the following properties:
ItemOptions (jc-bar-chart | jc-expander | jc-list-item | jc-pie-chart | jc-product-item | jc-stage | jc-custom-component)
The object must be any of the following types:
FormChildrenFields (jc-text-field | jc-checkbox | jc-email-field | jc-number-field | jc-dropdown | jc-date-picker | jc-signature-field | jc-media-field | jc-avatar-field)
The object must be any of the following types:
Groups of items. Every group will start with section header. Useful when you want to do favorite as a first group, so user doesn't need to search in huge list of items.
Properties of the SectionBase object:
Property | Type | Required | Description |
title | string | Expression | TextWithFormat | TextLocale | true | |
data | string | true | |
The object must be any of the following types:
Properties of the JW4x4GroupConfig object:
Property | Type | Required | Description |
type | widget.group | true | |
instanceId | InstanceId | Expression | false | |
options | object | true | |
Properties of the options object:
Property | Type | Required | Description |
footer | string | Expression | TextWithFormat | TextLocale | false | Footer text of widget |
footerAlign | enum<string> | false | Footer text align |
placeholders | object[] | false | Widget specific placeholders config |
children | Array<jw-actions | jw-avatar | jw-chart | jw-image | jw-list | jw-value | jw-location | jw-status> | true | |
split | JWGroupLayout | false | |
Footer text of widget
Footer text align
This element must be one of the following enum values:
- left
- right
- center
Widget specific placeholders config
The object is an array with all elements of the type object.
The array object has the following properties:
children (Array<jw-actions | jw-avatar | jw-chart | jw-image | jw-list | jw-value | jw-location | jw-status>, required)
The elements of the array must match at least one of the following properties:
Default: "vertical"
This element must be one of the following enum values:
- horizontal
- vertical