website logo
👥 Community🎯 Samples on GitHub🚦 System Status
💡 Guides
🚀 Examples
🍕 Developer Reference
⚡️ Changelog
🎥 Video Library
Navigate through spaces
⌘K
Overview
Reference
Actions
Data
UI
Widgets
Docs powered by
Archbee
Reference
UI

jc-jig-header

23min

The schema defines the following properties:

Property

Type

Required

Description

type

component.jig-header

true



instanceId

InstanceId | Expression

false



when

Expression | boolean

false



options

object

true



instanceId (InstanceId | Expression)

when (Expression | boolean)

options (object, required)

Properties of the options object:

Property

Type

Required

Description

height

JigHeaderHeight

true

Header height

children

HeaderChild

true



height (JigHeaderHeight, required)

Header height

Default: "medium"

children (HeaderChild, required)



Sub Schemas

The schema defines the following additional types:

JigHeaderHeight (enum<string>)

This element must be one of the following enum values:

  • small
  • medium

HeaderChild (jc-image | jc-location | JCVideoPlayerOnJigConfig)

The object must be any of the following types:

HeaderChild (jc-image)

HeaderChild (jc-location)

HeaderChild (JCVideoPlayerOnJigConfig)

JCVideoPlayerOnJigConfig (component.video-player)

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



instanceId (InstanceId | Expression)

when (Expression | boolean)

options (Video Player Options (jigs), required)

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

keg-action-in-background

false

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

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



Updated 25 Sep 2023
Did this page help you?
PREVIOUS
jc-interactive-image
NEXT
jc-line-chart
Docs powered by
Archbee
TABLE OF CONTENTS
instanceId (InstanceId | Expression)
when (Expression | boolean)
options (object, required)
height (JigHeaderHeight, required)
children (HeaderChild, required)
Sub Schemas
JigHeaderHeight (enum<string>)
HeaderChild (jc-image | jc-location | JCVideoPlayerOnJigConfig)
HeaderChild (jc-image)
HeaderChild (jc-location)
HeaderChild (JCVideoPlayerOnJigConfig)
JCVideoPlayerOnJigConfig (component.video-player)
instanceId (InstanceId | Expression)
when (Expression | boolean)
options (Video Player Options (jigs), required)
url (string | string, required)
url (string)
title (string | Expression | TextWithFormat | TextLocale)
subtitle (string | Expression | TextWithFormat | TextLocale)
ratio (Ratio)
autoplay (boolean | string)
autoplay (string)
loop (boolean | string)
loop (string)
onPress (keg-action-in-background)
Ratio (enum<string>)
Docs powered by
Archbee
Copyright © 2023 Jigx, Inc. All rights reserved. Terms of Service