Listing
This section can be used to display a list of records.
Parameter | Description | Datatype | Max Limit |
name | Unique ID for the section | String | 50 |
layout | Type of section layout - Listing | String | |
title | Unique title for the section | String | 30 |
search | Search status for tickets | Boolean | |
search_hint | Text that is displayed while hovering | String | 60 |
navigate | Navigation status for elements in the section | Boolean | |
nodata_text | If there are no results for search, this key can be used to display it. The "nodata_text" key will be considered only if "data" is empty | String | 200 |
data | Data to be included in the section | List | 10 |
actions | Actions that have to be performed | List | 2 |
reference_id | Additional values that need to be passed to the action handler. This will be available in the target parameter of the action handler as section_reference_id | String | 300 |
Data element structure:
Parameter | Description | Datatype | Max Limit |
name | Unique name for each data item Note: Element name is mandatory if reference_id is available in that element or navigate is true for that element or section | String | 50 |
title | Unique title for the data item | String | 80 |
text | Description of the data item | String | 2000 |
subtext | Additional information corresponding to each data item | String | 80 |
link | URL associated with | ||
link_hint | Text that is displayed on hovering over the link | String | 20 |
reference_id | Additional values need to be passed to the action handler. This will be available in the target parameter of the action handler as element_reference_id | String | 300 |
Action structure:
Parameter | Description | Datatype | Max Limit |
label | Label to be shown for the button | String | 30 |
name | Unique name for each action element | String | 50 |
reference_id | Additional values need to be passed to the action handler. This will be available in the target parameter of the action handler as action_reference_id | String | 300 |
Note:
If the datatype is String then the Max Limit indicates the character limit and if the datatype is List, then it indicates the maximum number of values that can be included in the list.
Sample Code:
Copied{
"name":"purchases",
"layout":"listing",
"search":true,
"search_hint" : "Search recent purchases..",
"navigate":true,
"title":"Recent Purchases",
"data" : [
{
"name":"HO340WA52EIPHTFUR",
"title":"$1000",
"text":"Tiago Engineered Wood Four Door Wardrobe in Wenge Colour by HomeTown",
"subtext":"Shipped | Jun 28, 2020",
"link":"https://www.zylkerfurnitures.com/tiago-engineered-wood-four-door-wardrobe-in-wenge-colour-by-hometown/sku/HO340WA52EIPHTFUR",
"link_hint":"Click to view product"
},
{
"name":"HO340FU60GNZHTFUR",
"title":"$200",
"text":"Paris Fabric Office Chair in Black Colour by HomeTown",
"subtext":"Delivered | Jun 3, 2020",
"link":"https://www.zylkerfurnitures.com/paris-fabric-office-chair-in-black-colour-by-hometown/sku/HO340FU60GNZHTFUR",
"link_hint":"Click to view product"
},
{
"name":"HO340FU28GPFHTFUR",
"title":"$350",
"text":"Castle Engineered Wood Study Table in Highgloss White & Pink Colour by HomeTown",
"subtext":"Delivered | Apr 14, 2020",
"link":"https://www.zylkerfurnitures.com/castle-engineered-wood-study-table-in-highgloss-white-and-pink-colour-by-hometown/sku/HO340FU28GPFHTFUR",
"link_hint":"Click to view product"
}
],
"reference_id" : "1"
}