jc-story-group

The schema defines the following properties:

instanceId (InstanceId | Expression)

when (Expression | boolean)

options (Stories Options, required)

Properties of the options object:

data (string, required)

Array of items you want to display.

item (SwitchConfiguration<StoryItemContent>, required)

Item displayed in list for each data item from data. It will get item in @context.current.item. Renders root item or first item where 'when' condition is true or empty.

actionButtonTitle (string | Expression | TextWithFormat | TextLocale)

Customize bottom action title. This property can be overwritten by item.onPress.title property. Default is Show more.

Default: "Show more"

groupName (string | Expression | TextWithFormat | TextLocale)

Overrides jig name on story group name.

Sub Schemas

The schema defines the following additional types:

SwitchConfiguration<StoryItemContent> (StoryItemContent | SwitchItem<StoryItemContent>[])

Item configuration or collection of items configurations with when condition. Renders root item or first item where 'when' condition is true or empty.

The object must be any of the following types:

SwitchConfiguration<StoryItemContent> (StoryItemContent)

SwitchConfiguration<StoryItemContent> (SwitchItem<StoryItemContent>[])

The object is an array with all elements of the type SwitchItem<StoryItemContent>.

StoryItemContent (JCStoriesImageConfig | JCVideoPlayerOnStoriesConfig)

The object must be any of the following types:

StoryItemContent (JCStoriesImageConfig)

StoryItemContent (JCVideoPlayerOnStoriesConfig)

JCStoriesImageConfig (component.image)

Properties of the JCStoriesImageConfig object:

instanceId (InstanceId | Expression)

when (Expression | boolean)

options (Image Options, 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).

onPress (keg-action-on-button)

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

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)

JCVideoPlayerOnStoriesConfig (component.video-player)

Properties of the JCVideoPlayerOnStoriesConfig object:

instanceId (InstanceId | Expression)

when (Expression | boolean)

options (Video Player Options (stories), 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)

thumbnailUri (string | string, required)

URI of thumbnail of the video. Like https://videos.com/images/video-preview-image.jpg

The object must be any of the following types:

thumbnailUri (string)

onPress (keg-action-on-button)

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

SwitchItem<StoryItemContent> (object)

Properties of the SwitchItem<StoryItemContent> object:

when (string)

item (StoryItemContent, required)