ja-set-state
The schema defines the following additional types:
Properties of the JASetStateOnButtonConfig object:
Property | Type | Required | Description |
type | action.set-state | true | |
instanceId | InstanceId | Expression | false | |
when | Expression | boolean | false | When the property is set to 'false', the action will not execute. Default is 'true'. |
options | Set State Action Options | true | Options related to Jig Actions on bottom panel |
When the property is set to 'false', the action will not execute. Default is 'true'.
Options related to Jig Actions on bottom panel
Properties of the options object:
Property | Type | Required | Description |
title | string | Expression | TextWithFormat | TextLocale | true | Title of action displayed on a button. |
icon | icon-name | string | false | Icon of action displayed on a button. |
style | object | false | More of them can be true. It will be evaluated based on priority. |
isHidden | boolean | string | false | Hides the button when `true` |
state | string | true | |
value | string | number | boolean | string | true | |
Title of action displayed on a button.
icon (icon-name | string)
Icon of action displayed on a button.
The object must be any of the following types:
More of them can be true. It will be evaluated based on priority.
Hides the button when true
The object must be any of the following types:
Additional restrictions:
- Regex pattern: ^=@ctx\.solution\.state\.[a-zA-Z][a-zA-Z0-9_-]{0,48}[a-zA-Z0-9]$
The object must be any of the following types:
Properties of the JASetStateInBackgroundConfig object:
Property | Type | Required | Description |
type | action.set-state | true | |
instanceId | InstanceId | Expression | false | |
when | Expression | boolean | false | When the property is set to 'false', the action will not execute. Default is 'true'. |
options | Set State Action Options | true | Options related to Jig Actions on bottom panel |
When the property is set to 'false', the action will not execute. Default is 'true'.
Options related to Jig Actions on bottom panel
Properties of the options object:
Property | Type | Required | Description |
state | string | true | |
value | string | number | boolean | string | true | |
Additional restrictions:
- Regex pattern: ^=@ctx\.solution\.state\.[a-zA-Z][a-zA-Z0-9_-]{0,48}[a-zA-Z0-9]$
The object must be any of the following types:
