jc-list
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 | |
The schema defines the following additional types:
The object must be any of the following types:
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. |
Array of items you want to display.
Item displayed in list for each data item from data. It can get the item data from @context.current.item.
The object must be any of the following types:
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 | |
The object must be any of the following types:
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:
Default: 8
Action to be performed when user presses on show more button.
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. |
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 displayed in list for each data item from data. It can get the item data from @context.current.item.
The object must be any of the following types:
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 | |
The object must be any of the following types:
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:
Default: 8
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:
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:
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 | |