jc-card

Card component used mostly in custom components

The schema defines the following properties:

instanceId (InstanceId | Expression)

when (Expression | boolean)

options (Card Options, required)

Properties of the options object:

children (ComponentDefaultChild[], required)

Define children components inside the card

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

direction (enum<string>)

Direction of layout of components inside the card

This element must be one of the following enum values:

• row
• column

Default: "column"

onPress (keg-action-in-background)

Action that will be triggered by pressing on this component.

color (ColorOrConditionalColor)

Background color of the card based on color or conditional color

emphasis (EmphasisDefinition)

Define opacity of the card

Sub Schemas

The schema defines the following additional types:

ComponentDefaultChild (jc-avatar | jc-bar-chart | jc-button | jc-card | jc-entity | jc-expander | jc-form | jc-icon | JCImageOnCustomComponentConfig | jc-interactive-image | jc-line-chart | jc-location | jc-pie-chart | jc-stage | jc-stepper | jc-text | jc-trend | JCVideoPlayerOnJigConfig | jc-view | jc-web-view)

The object must be any of the following types:

ComponentDefaultChild (jc-avatar)

ComponentDefaultChild (jc-bar-chart)

ComponentDefaultChild (jc-button)

ComponentDefaultChild (jc-card)

ComponentDefaultChild (jc-entity)

ComponentDefaultChild (jc-expander)

ComponentDefaultChild (jc-form)

ComponentDefaultChild (jc-icon)

ComponentDefaultChild (JCImageOnCustomComponentConfig)

ComponentDefaultChild (jc-interactive-image)

ComponentDefaultChild (jc-line-chart)

ComponentDefaultChild (jc-location)

ComponentDefaultChild (jc-pie-chart)

ComponentDefaultChild (jc-stage)

ComponentDefaultChild (jc-stepper)

ComponentDefaultChild (jc-text)

ComponentDefaultChild (jc-trend)

ComponentDefaultChild (JCVideoPlayerOnJigConfig)

ComponentDefaultChild (jc-view)

ComponentDefaultChild (jc-web-view)

BasicColor (enum<string>)

This element must be one of the following enum values:

• color1
• color2
• color3
• color4
• color5
• color6
• color7
• color8
• color9
• color10
• color11
• color12
• color13
• color14

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:

FormChildrenFields (jc-text-field)

FormChildrenFields (jc-checkbox)

FormChildrenFields (jc-email-field)

FormChildrenFields (jc-number-field)

FormChildrenFields (jc-dropdown)

FormChildrenFields (jc-date-picker)

FormChildrenFields (jc-signature-field)

FormChildrenFields (jc-media-field)

FormChildrenFields (jc-avatar-field)

ResizeMode (enum<string>)

This element must be one of the following enum values:

• contain
• cover
• stretch
• center

JCImageURISource (Image Uri Source)

Properties of the JCImageURISource object:

uri (string | string, required)

The object must be any of the following types:

uri (string)

JCVideoPlayerOnJigConfig (component.video-player)

Properties of the JCVideoPlayerOnJigConfig object:

instanceId (InstanceId | Expression)

when (Expression | boolean)

options (Video Player Options (jigs), required)

Properties of the options object:

url (string | string, required)

URL of the video

The object must be any of the following types:

url (string)

title (string | Expression | TextWithFormat | TextLocale)

Title of the video

subtitle (string | Expression | TextWithFormat | TextLocale)

Subtitle of the video

ratio (Ratio)

Aspect ratio of the video (default = 16:9, only for non-YouTube videos)

autoplay (boolean | string)

Autoplay the video (default = true)

The object must be any of the following types:

autoplay (string)

loop (boolean | string)

Loop the video (default = true)

The object must be any of the following types:

loop (string)

onPress (keg-action-in-background)

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

Ratio (enum<string>)

This element must be one of the following enum values:

• 16:9
• 4:3

ColorOrConditionalColor (primary | BasicColor | string | object[])

The object must be any of the following types:

ColorOrConditionalColor (BasicColor)

ColorOrConditionalColor (string)

ColorOrConditionalColor (object[])

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

The array object has the following properties:

EmphasisDefinition (extra-low | low | low-medium | medium | high | string)

The object must be any of the following types:

EmphasisDefinition (string)

JCImageOnCustomComponentConfig (component.image)

Properties of the JCImageOnCustomComponentConfig object:

instanceId (InstanceId | Expression)

when (Expression | boolean)

options (object, required)

Properties of the options object:

title (string | Expression | TextWithFormat | TextLocale)

Title that could be displayed on/next to the image based on current context.

subtitle (string | Expression | TextWithFormat | TextLocale)

Subtitle that could be displayed on/next to the image based on current context.

resizeMode (ResizeMode)

Determines how to resize the image when the frame doesn't match the raw image dimensions.

'cover': Scale the image uniformly (maintain the image's aspect ratio) so that both dimensions (width and height) of the image will be equal to or larger than the corresponding dimension of the view (minus padding).

'contain': Scale the image uniformly (maintain the image's aspect ratio) so that both dimensions (width and height) of the image will be equal to or less than the corresponding dimension of the view (minus padding).

'stretch': Scale width and height independently, This may change the aspect ratio of the src.

'center': Scale the image down so that it is completely visible, if bigger than the area of the view. The image will not be scaled up.

source (JCImageURISource, required)

The image source (either a remote URL or a local file resource). The currently supported formats are png, jpg, jpeg, bmp, gif, webp (Android only), psd (iOS only).

size (ImageSizeConfig | flexible)

The object must be any of the following types:

size (ImageSizeConfig)

onPress (keg-action-in-background)

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

ImageSizeConfig (Static Size)

Properties of the ImageSizeConfig object:

height (number | string)

Change constrain of image height. Remember to use a proper resizeMode to achieve the best results in all different device resolutions

The object must be any of the following types:

height (string)

Default: 196

width (number | string)

Change constrain of image width. Remember to use a proper resizeMode to achieve the best results in all different device resolutions

The object must be any of the following types:

width (string)