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-summary

36min

The schema defines the following properties:

Property

Type

Required

Description

type

component.summary

true



instanceId

InstanceId | Expression

false



when

Expression | boolean

false



options

default | counter | cart

true



instanceId (InstanceId | Expression)

when (Expression | boolean)

options (default | counter | cart, required)

The object must be any of the following types:

options (default)

Properties of the options object:

Property

Type

Required

Description

title

string | Expression | TextWithFormat | TextLocale

false

Main title of the component

subtitle

string | Expression | TextWithFormat | TextLocale

false

Subtitle of the component

color

object[]

false

Changing color of title based on conditions. First evaluated to true will be used.

layout

default

true



leftIcon

icon

false

Left Icon

title (string | Expression | TextWithFormat | TextLocale)

Main title of the component

subtitle (string | Expression | TextWithFormat | TextLocale)

Subtitle of the component

color (object[])

Changing color of title based on conditions. First evaluated to true will be used.

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

The array object has the following properties:

Property

Type

Required

Description

when

string | boolean

true



color

primary | BasicColor | StatusColor | string

true



when (string | boolean, required)

The object must be any of the following types:

when (string)

color (primary | BasicColor | StatusColor | string, required)

The object must be any of the following types:

color (BasicColor)

color (StatusColor)

color (string)

leftIcon (icon)

Left Icon

options (counter)

Properties of the options object:

Property

Type

Required

Description

title

string | Expression | TextWithFormat | TextLocale

false

Main title of the component

subtitle

string | Expression | TextWithFormat | TextLocale

false

Subtitle of the component

color

object[]

false

Changing color of title based on conditions. First evaluated to true will be used.

layout

counter

true



value

string | Expression | TextWithFormat | TextLocale | number

true

Value

title (string | Expression | TextWithFormat | TextLocale)

Main title of the component

subtitle (string | Expression | TextWithFormat | TextLocale)

Subtitle of the component

color (object[])

Changing color of title based on conditions. First evaluated to true will be used.

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

The array object has the following properties:

Property

Type

Required

Description

when

string | boolean

true



color

primary | BasicColor | StatusColor | string

true



when (string | boolean, required)

The object must be any of the following types:

when (string)

color (primary | BasicColor | StatusColor | string, required)

The object must be any of the following types:

color (BasicColor)

color (StatusColor)

color (string)

value (string | Expression | TextWithFormat | TextLocale | number, required)

Value

The object must be any of the following types:

value (string | Expression | TextWithFormat | TextLocale)

options (cart)

Properties of the options object:

Property

Type

Required

Description

title

string | Expression | TextWithFormat | TextLocale

false

Main title of the component

subtitle

string | Expression | TextWithFormat | TextLocale

false

Subtitle of the component

color

object[]

false

Changing color of title based on conditions. First evaluated to true will be used.

layout

cart

true



value

string | Expression | TextWithFormat | TextLocale | number

true

Value

description

string | Expression | TextWithFormat | TextLocale

false

Description of the component

title (string | Expression | TextWithFormat | TextLocale)

Main title of the component

subtitle (string | Expression | TextWithFormat | TextLocale)

Subtitle of the component

color (object[])

Changing color of title based on conditions. First evaluated to true will be used.

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

The array object has the following properties:

Property

Type

Required

Description

when

string | boolean

true



color

primary | BasicColor | StatusColor | string

true



when (string | boolean, required)

The object must be any of the following types:

when (string)

color (primary | BasicColor | StatusColor | string, required)

The object must be any of the following types:

color (BasicColor)

color (StatusColor)

color (string)

value (string | Expression | TextWithFormat | TextLocale | number, required)

Value

The object must be any of the following types:

value (string | Expression | TextWithFormat | TextLocale)

description (string | Expression | TextWithFormat | TextLocale)

Description of the component



Sub Schemas

The schema defines the following additional types:

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

StatusColor (enum<string>)

This element must be one of the following enum values:

  • positive
  • negative
  • warning



Updated 25 Sep 2023
Did this page help you?
PREVIOUS
jc-story-group
NEXT
jc-text-field
Docs powered by
Archbee
TABLE OF CONTENTS
instanceId (InstanceId | Expression)
when (Expression | boolean)
options (default | counter | cart, required)
options (default)
title (string | Expression | TextWithFormat | TextLocale)
subtitle (string | Expression | TextWithFormat | TextLocale)
color (object[])
when (string | boolean, required)
when (string)
color (primary | BasicColor | StatusColor | string, required)
color (BasicColor)
color (StatusColor)
color (string)
leftIcon (icon)
options (counter)
title (string | Expression | TextWithFormat | TextLocale)
subtitle (string | Expression | TextWithFormat | TextLocale)
color (object[])
when (string | boolean, required)
when (string)
color (primary | BasicColor | StatusColor | string, required)
color (BasicColor)
color (StatusColor)
color (string)
value (string | Expression | TextWithFormat | TextLocale | number, required)
value (string | Expression | TextWithFormat | TextLocale)
options (cart)
title (string | Expression | TextWithFormat | TextLocale)
subtitle (string | Expression | TextWithFormat | TextLocale)
color (object[])
when (string | boolean, required)
when (string)
color (primary | BasicColor | StatusColor | string, required)
color (BasicColor)
color (StatusColor)
color (string)
value (string | Expression | TextWithFormat | TextLocale | number, required)
value (string | Expression | TextWithFormat | TextLocale)
description (string | Expression | TextWithFormat | TextLocale)
Sub Schemas
BasicColor (enum<string>)
StatusColor (enum<string>)
Docs powered by
Archbee
Copyright © 2023 Jigx, Inc. All rights reserved. Terms of Service