Listing

This section can be used to display a list of records.

ParameterDescriptionDatatypeMax Limit
nameUnique ID for the sectionString50
layoutType of section layout - ListingString 
titleUnique title for the sectionString30
searchSearch status for ticketsBoolean 
search_hintText that is displayed while hoveringString60
navigateNavigation status for elements in the sectionBoolean 
nodata_textIf 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 emptyString200
dataData to be included in the sectionList10
actionsActions that have to be performedList2
reference_idAdditional 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_idString300

Data element structure:

ParameterDescriptionDatatypeMax 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

String50
titleUnique title for the data itemString80
textDescription of the data itemString2000
subtextAdditional information corresponding to each data itemString80
linkURL associated with   
link_hintText that is displayed on hovering over the linkString20
reference_idAdditional values need to be passed to the action handler. This will be available in the target parameter of the action handler as element_reference_idString300

Action structure:

ParameterDescriptionDatatypeMax Limit
label Label to be shown for the buttonString30
name

Unique name for each action element

String50
reference_idAdditional values need to be passed to the action handler. This will be available in the target parameter of the action handler as action_reference_idString300

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"
}