Header¶

Header element can be used as a header for section. Work perfectly with children field.

In the picture below, it is the "Display for every product:" phrase:

header

Options¶

icon¶

string Optional parameter. You can set an icon next to your Header label.

Available icons:

header-options

phonetabletdesktoplaptopmobile_devicescomputerscomputers_and_tablet

    {
        "options": {
            "icon" : "phone"
        }
    }

    {
        "options": {
            "icon" : "tablet"
        }
    }

    {
        "options": {
            "icon" : "desktop"
        }
    }

    {
        "options": {
            "icon" : "laptop"
        }
    }

    {
        "options": {
            "icon" : "mobile_devices"
        }
    }

    {
        "options": {
            "icon" : "computers"
        }
    }

    {
        "options": {
            "icon" : "computers_and_tablet"
        }
    }

Build-in Validators¶

Element has no build-in validators.

Available Validators¶

Element does not have available validators.

Relations Support¶

Element does not supports relations between elements.

Configuration output schema¶

schema

{
  "<element_type>" : "header",
  "<element_name>" : string,
  "<element_label>" : string,
  "<element_labelDescription>" : string,
  "<element_isHidden>" : bool,
  "<element_options>" : {
    "<element_icon>" : string
  },
  "<element_children>" : []
}

example

{
  "type" : "header",
  "name" : "header",
  "label" : "Mobile devices",
  "labelDescription" : "Configuration for mobile devices.",
  "isHidden" : false,
  "options": {
    "icon" : "mobile_devices"
  },
  "children": [
    {
      "type": "checkbox",
      "name": "navigation",
      "label": "Enable navigation arrows",
      "defaultValue": 1
    }
  ]
}