Reference
jc-event

21min
The schema defines the following properties:
Property
Type
Required
Description
type
component.event
true
﻿
instanceId
InstanceId | Expression
false
﻿
when
Expression | boolean
false
﻿
options
Event Options
true
﻿
instanceId (InstanceId | Expression)
when (Expression | boolean)
options (Event Options, required)
Properties of the options object:
Property
Type
Required
Description
people
EventPeople[] | string
false
List of Attendees
description
string | Expression | TextWithFormat | TextLocale
false
Event description content - will be shown in event detail
isAllDay
boolean | string
false
Is event all day long
location
string | Expression | TextWithFormat | TextLocale
false
Location of event
tags
EventTag[] | string
false
Additional tags
title
string | Expression | TextWithFormat | TextLocale
true
Event title
onPress
﻿keg-action-in-background﻿
false
Optionally you can override the default action opening the event build-in detail in modal
onButtonPress
﻿keg-action-on-button﻿
false
Action Keg component that will be triggered by pressing on button in detail.
buttonTitle
string | Expression | TextWithFormat | TextLocale
false
Title on button in detail of event
from
string | Expression | TextWithFormat | TextLocale
true
Timestamp of beginning of the event
to
string | Expression | TextWithFormat | TextLocale
true
Timestamp of end of the event
people (EventPeople[] | string)
List of Attendees
The object must be any of the following types:
people (EventPeople[])
The object is an array with all elements of the type EventPeople.
people (string)
description (string | Expression | TextWithFormat | TextLocale)
Event description content - will be shown in event detail
isAllDay (boolean | string)
Is event all day long
The object must be any of the following types:
isAllDay (string)
location (string | Expression | TextWithFormat | TextLocale)
Location of event
tags (EventTag[] | string)
Additional tags
The object must be any of the following types:
tags (EventTag[])
The object is an array with all elements of the type EventTag.
tags (string)
title (string | Expression | TextWithFormat | TextLocale, required)
Event title
onPress (keg-action-in-background)
Optionally you can override the default action opening the event build-in detail in modal
onButtonPress (keg-action-on-button)
Action Keg component that will be triggered by pressing on button in detail.
buttonTitle (string | Expression | TextWithFormat | TextLocale)
Title on button in detail of event
from (string | Expression | TextWithFormat | TextLocale, required)
Timestamp of beginning of the event
to (string | Expression | TextWithFormat | TextLocale, required)
Timestamp of end of the event
﻿
Sub Schemas
The schema defines the following additional types:
EventPeople (object)
Properties of the EventPeople object:
Property
Type
Required
Description
avatarUrl
string | null
false
﻿
fullName
string
false
﻿
email
string | null
false
﻿
EventTag (object)
Properties of the EventTag object:
Property
Type
Required
Description
color
PaletteColor
true
﻿
title
string
true
﻿
color (PaletteColor, required)
PaletteColor (enum<string>)
This element must be one of the following enum values:
element
background
onBackground
screen
card
color10
color11
color12
color13
color14
color1
color2
color3
color4
color5
color6
color7
color8
color9
overlay
onOverlay
link
navigation
onNavigation
negative
onScreen
onCard
onColor10
onColor11
onColor12
onColor13
onColor14
onColor1
onColor2
onColor3
onColor4
onColor5
onColor6
onColor7
onColor8
onColor9
onElement
onNegative
onPositive
onPrimary
onSecondary
onSplash
onToast
onWarning
positive
primary
secondary
splash
toast
transparent
warning
﻿
Updated 25 Sep 2023
Did this page help you?
Property	Type	Required	Description
type	component.event	true
instanceId	InstanceId \| Expression	false
when	Expression \| boolean	false
options	Event Options	true