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

40min

The schema defines the following properties:

Property

Type

Required

Description

type

component.list

true



instanceId

InstanceId | Expression

false



when

Expression | boolean

false



options

JCListOptions

true



instanceId (InstanceId | Expression)

when (Expression | boolean)

options (JCListOptions, required)



Sub Schemas

The schema defines the following additional types:

JCListOptions (object | object)

The object must be any of the following types:

JCListOptions (object)

Properties of the JCListOptions object:

Property

Type

Required

Description

data

string

false

Array of items you want to display.

item

ItemOptions

true

Item displayed in list for each data item from data. It can get the item data from @context.current.item.

isSearchable

boolean

false

Whether or not the list is searchable

isHorizontal

boolean

false

If true the list will be horizontal instead of vertical.

isHorizontalScrollIndicatorHidden

boolean

false

If true it will hide horizontal scroll indicator

isVerticalScrollIndicatorHidden

boolean

false

If true it will hide vertical scroll indicator

hasActiveItem

boolean

false

List has active item state

filter

object[] | string

false



maximumItemsToRender

number | string

false

Max items to be rendered. Bigger number means worse performance. For large data sets use Jig List instead.

onShowMorePress

ja-go-to

false

Action to be performed when user presses on show more button.

data (string)

Array of items you want to display.

item (ItemOptions, required)

Item displayed in list for each data item from data. It can get the item data from @context.current.item.

filter (object[] | string)

The object must be any of the following types:

filter (object[])

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

The array object has the following properties:

Property

Type

Required

Description

title

string | Expression | TextWithFormat | TextLocale

true



value

string | number | boolean | string

true



title (string | Expression | TextWithFormat | TextLocale, required)

value (string | number | boolean | string, required)

The object must be any of the following types:

value (string)

filter (string)

maximumItemsToRender (number | string)

Max items to be rendered. Bigger number means worse performance. For large data sets use Jig List instead.

The object must be any of the following types:

maximumItemsToRender (string)

Default: 8

onShowMorePress (ja-go-to)

Action to be performed when user presses on show more button.

JCListOptions (object)

Properties of the JCListOptions object:

Property

Type

Required

Description

sections

SectionBase[]

false

Array of sections (groups of items). Every group will start with section header. Useful when you want to do favorite as a first group, so user doesn't need to search in huge list of items.

item

ItemOptions

true

Item displayed in list for each data item from data. It can get the item data from @context.current.item.

isSearchable

boolean

false

Whether or not the list is searchable

isHorizontal

boolean

false

If true the list will be horizontal instead of vertical.

isHorizontalScrollIndicatorHidden

boolean

false

If true it will hide horizontal scroll indicator

isVerticalScrollIndicatorHidden

boolean

false

If true it will hide vertical scroll indicator

hasActiveItem

boolean

false

List has active item state

filter

object[] | string

false



maximumItemsToRender

number | string

false

Max items to be rendered. Bigger number means worse performance. For large data sets use Jig List instead.

onShowMorePress

ja-go-to

false

Action to be performed when user presses on show more button.

sections (SectionBase[])

Array of sections (groups of items). Every group will start with section header. Useful when you want to do favorite as a first group, so user doesn't need to search in huge list of items.

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

item (ItemOptions, required)

Item displayed in list for each data item from data. It can get the item data from @context.current.item.

filter (object[] | string)

The object must be any of the following types:

filter (object[])

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

The array object has the following properties:

Property

Type

Required

Description

title

string | Expression | TextWithFormat | TextLocale

true



value

string | number | boolean | string

true



title (string | Expression | TextWithFormat | TextLocale, required)

value (string | number | boolean | string, required)

The object must be any of the following types:

value (string)

filter (string)

maximumItemsToRender (number | string)

Max items to be rendered. Bigger number means worse performance. For large data sets use Jig List instead.

The object must be any of the following types:

maximumItemsToRender (string)

Default: 8

onShowMorePress (ja-go-to)

Action to be performed when user presses on show more button.

ItemOptions (jc-bar-chart | jc-expander | jc-list-item | jc-pie-chart | jc-product-item | jc-stage | jc-custom-component)

The object must be any of the following types:

ItemOptions (jc-bar-chart)

ItemOptions (jc-expander)

ItemOptions (jc-list-item)

ItemOptions (jc-pie-chart)

ItemOptions (jc-product-item)

ItemOptions (jc-stage)

ItemOptions (jc-custom-component)

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)

SectionBase (object)

Groups of items. Every group will start with section header. Useful when you want to do favorite as a first group, so user doesn't need to search in huge list of items.

Properties of the SectionBase object:

Property

Type

Required

Description

title

string | Expression | TextWithFormat | TextLocale

true



data

string

true



title (string | Expression | TextWithFormat | TextLocale, required)

data (string, required)



Updated 25 Sep 2023
Did this page help you?
PREVIOUS
jc-list-item
NEXT
jc-location
Docs powered by
Archbee
TABLE OF CONTENTS
instanceId (InstanceId | Expression)
when (Expression | boolean)
options (JCListOptions, required)
Sub Schemas
JCListOptions (object | object)
JCListOptions (object)
data (string)
item (ItemOptions, required)
filter (object[] | string)
filter (object[])
title (string | Expression | TextWithFormat | TextLocale, required)
value (string | number | boolean | string, required)
value (string)
filter (string)
maximumItemsToRender (number | string)
maximumItemsToRender (string)
onShowMorePress (ja-go-to)
JCListOptions (object)
sections (SectionBase[])
item (ItemOptions, required)
filter (object[] | string)
filter (object[])
title (string | Expression | TextWithFormat | TextLocale, required)
value (string | number | boolean | string, required)
value (string)
filter (string)
maximumItemsToRender (number | string)
maximumItemsToRender (string)
onShowMorePress (ja-go-to)
ItemOptions (jc-bar-chart | jc-expander | jc-list-item | jc-pie-chart | jc-product-item | jc-stage | jc-custom-component)
ItemOptions (jc-bar-chart)
ItemOptions (jc-expander)
ItemOptions (jc-list-item)
ItemOptions (jc-pie-chart)
ItemOptions (jc-product-item)
ItemOptions (jc-stage)
ItemOptions (jc-custom-component)
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)
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)
SectionBase (object)
title (string | Expression | TextWithFormat | TextLocale, required)
data (string, required)
Docs powered by
Archbee
Copyright © 2023 Jigx, Inc. All rights reserved. Terms of Service