BigCommerce · Schema

widgetSchemaArray

**Array.** Use the **array** settings type to build collections of elements within the widget. Each element in the array can contain tabs, sections, and an entire schema.

E-CommerceRetailCatalogOrdersCheckoutPaymentsSaaS

Properties

Name	Type	Description
type	string
label	string
id	string
defaultCount	integer	number of elements in the list to display by default.
entryLabel	string	name for each element in the list
thumbnail	object	used to display an image stored at the specified attribute name
schema	array	The schema used for each element in the array.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/widgetSchemaArray",
  "title": "widgetSchemaArray",
  "type": "object",
  "description": "**Array.** Use the **array** settings type to build collections of elements within the widget. Each element in the array can contain tabs, sections, and an entire schema.",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "array"
      ]
    },
    "label": {
      "type": "string"
    },
    "id": {
      "type": "string"
    },
    "defaultCount": {
      "type": "integer",
      "description": "number of elements in the list to display by default."
    },
    "entryLabel": {
      "type": "string",
      "description": "name for each element in the list"
    },
    "thumbnail": {
      "type": "object",
      "description": "used to display an image stored at the specified attribute name",
      "properties": {
        "type": {
          "type": "string",
          "example": "image"
        },
        "valueKey": {
          "type": "string",
          "example": "imageUrl.src"
        }
      }
    },
    "schema": {
      "description": "The schema used for each element in the array.",
      "type": "array",
      "items": {
        "anyOf": [
          {
            "$ref": "#/components/schemas/widgetSchemaHidden"
          },
          {
            "$ref": "#/components/schemas/widgetSchemaTab"
          }
        ]
      }
    }
  },
  "x-internal": false
}