Tabs Widget

Use the tabs widget to place tabs somewhere in the layout. Each tab can be of type widget_tab or form_tab.

Tabs can contain available widgets and forms.

Name Type Description
type string Declares the type of tab:
  • widget_tab - to reference a widget directly
  • form_tab - to reference a particular configured area
caption   a template to define localized meta data
"caption": {
  "template": {
    "de": "Kunde (de)",
    "default": "Customer Data",
    "de-DE": "Kundendaten (de-DE)"
  }
}
config   A configuration for form_tab tabs:
  • area_id string Specifies the area id to appear in this tab.
  • default_data_provider string A data provider to access the data in the form
  • query_params Boolean query params for the particular data provider
"tabs": {
      "type": "tabs",
      "config": {
        "tabs": [
          {
            "type": "widget_tab",
            "caption": {
              "template": {
                "default": "Coupons"
              }
            },
            "widget_id": "basket_coupons"
          },
          {
            "type": "form_tab",
            "caption": {
              "template": {
                "default": "Customer Data"
              }
            },
            "config": {
              "area_id": "customer_view",
              "default_data_provider": "Customer",
              "query_params": {
                "customer_id": {
                  "attribute": "customer_info.customer_id"
                }
              }
            }
          }
        ]
      }
    }

The main layout section needs a reference to the tabs widget only to show the configured tabs with their content.

"layout": [
    {
      "layout": [
        {
          "id": "tabs",
          "width": 8
        }
      ]
    }
  ]