jig-calendar-specification
The schema defines the following properties:
Property | Type | Required | Description |
type | jig.calendar | 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. | |
item | jc-event | true | Important note: Your datasource has to contain props "from" and "to" If you DB has column names like "date_from" and "date_to" you have map your values to "from" and "to" keys. Otherwise the data will not be processed. |
data | string | false | |
widgets | JigWidgets | 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.
Important note: Your datasource has to contain props "from" and "to" If you DB has column names like "date_from" and "date_to" you have map your values to "from" and "to" keys. Otherwise the data will not be processed.
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 JigWidgets object:
Property | Type | Required | Description |
1x1 | false | | |
2x2 | false | | |
2x4 | false | | |
4x2 | false | | |
4x4 | Keg4x4WidgetConfiguration | false | |
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:
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