jc-custom-component
Custom component defined in the components folder.
The object must be any of the following types:
The schema defines the following additional types:
Custom component defined in the components folder.
Properties of the JCCustomComponentReferenceConfig object:
Property | Type | Required | Description |
type | component.custom-component | true | |
instanceId | InstanceId | Expression | false | |
when | Expression | boolean | false | |
inputs | JigInputs | | false | Inputs for the component that will be passed as parameters inside the custom component |
componentId | string | true | ID of the component to be rendered. Mostly the name of the component file |
Inputs for the component that will be passed as parameters inside the custom component
ID of the component to be rendered. Mostly the name of the component file
Custom component defined in the components folder.
Properties of the JCCustomComponentInlineConfig object:
Property | Type | Required | Description |
type | component.custom-component | true | |
instanceId | InstanceId | Expression | false | |
when | Expression | boolean | false | |
options | Custom Component Options | true | |
Properties of the options object:
Property | Type | Required | Description |
children | ComponentDefaultChild[] | true | |
The object is an array with all elements of the type ComponentDefaultChild.
Additional restrictions:
- Minimum items: 1
ComponentDefaultChild (jc-avatar | jc-bar-chart | jc-button | jc-card | jc-countdown | jc-entity | jc-expander | jc-form | jc-icon | jc-image | jc-interactive-image | jc-line-chart | jc-location | jc-pie-chart | jc-stage | jc-stepper | jc-text | jc-trend | jc-progress-bar | JCVideoPlayerOnJigConfig | jc-view | jc-web-view)
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:
Properties of the JCVideoPlayerOnJigConfig object:
Property | Type | Required | Description |
type | component.video-player | true | |
instanceId | InstanceId | Expression | false | |
when | Expression | boolean | false | |
options | Video Player Options jigs | true | |
Properties of the options object:
Property | Type | Required | Description |
url | string | string | true | URL of the video |
title | string | Expression | TextWithFormat | TextLocale | false | Title of the video |
subtitle | string | Expression | TextWithFormat | TextLocale | false | Subtitle of the video |
ratio | Ratio | false | Aspect ratio of the video (default = 16:9, only for non-YouTube videos) |
autoplay | boolean | string | false | Autoplay the video (default = true) |
loop | boolean | string | false | Loop the video (default = true) |
onPress | false | Action Keg component that will be triggered by pressing on this image. |
URL of the video
The object must be any of the following types:
Title of the video
Subtitle of the video
Aspect ratio of the video (default = 16:9, only for non-YouTube videos)
Autoplay the video (default = true)
The object must be any of the following types:
Loop the video (default = true)
The object must be any of the following types:
Action Keg component that will be triggered by pressing on this image.
This element must be one of the following enum values:
- 16:9
- 4:3