Infobox¶

Infobox is an element that represent information box.

Options¶

type¶

string Available types: info, warning, success, critical, subtle. Blank type does not have an icon in infobox.

infobox

message¶

string Message to show in information box. Message can be passed as Markdown.

placeholderValues¶

array Optional parameter. List of placeholders (string, int, float) which will be placed in message. They are useful when you have for example links in message. If you place link in placeholderValues, in translations you do not need to pass links. To place placeholder in message is used printf function. For example if you want place text placeholder in message, you must put %s in your message. Whole documentation with list of parameters you can find here.

JSON

{
"options":
    {
      "type" : "blank",
      "message" : "## Related settings in the admin panel\n- turning on additional product codes in [product settings](%s)",
      "placeholderValues" : ["\/admin\/configProducts"]
    }
}

Build-in Validators¶

Element does not have any build-in validators.

Available Validators¶

Element does not have any available validators.

Relations Support¶

Element does not support relations between elements.

Configuration output schema¶

schema

{
  "<element_type>" : "infobox",
  "<element_name>" : "string",
  "<element_options>" : {
    "<element_option_type>" : "string",
    "<element_option_message" : "string",
    "<element_option_placeholderValues>" : ["string", int, float]
  },
}

example

{
  "type": "infobox",
  "name": "related_settings_infobox",
  "options": {
    "type" : "blank",
    "message" : "## Related settings in the admin panel\n- turning on additional product codes in [product settings](%s)",
    "placeholderValues" : ["\/admin\/configProducts"]
  }
}

Element value¶

Infobox is a purely informational element used to display a message (optionally as Markdown) in the configurator. It does not produce any value and is not available in moduleConfig.

Example of module¶

JSON configuration¶

JSON configuration

[
  {
    "label": "Full screen view",
    "state": "unfolded",
    "elements": [
      {
        "type": "infobox",
        "name": "infobox",
        "options": {
          "type": "warning",
          "message": "Changes to the settings in this section will not be visible in the live view. To see the changes, save them, click \"Preview\" and click on the photo in the gallery."
        }
      },
      {
        "type": "checkbox",
        "name": "display_photo_description",
        "label": "Display photo description / file name",
        "defaultValue": 1
      }
    ]
  }
]

JSON translations¶

JSON translations

{
  "schema": {
    "pl_PL": {
      "Full screen view": "Widok pełnoekranowy",
      "Display photo description / file name": "Wyświetl opis zdjęcia / nazwę pliku"
    },
    "en_US": {
      "Full screen view": "Full screen view",
      "Display photo description / file name": "Display photo description / file name"
    }
  }
}