AdditionalField

The AdditionalField object represents a single additional form field in the storefront.

classDiagram
  direction LR
  AdditionalField --> AdditionalFieldOptionsList
  AdditionalFieldOptionsList "1" --o "*" AdditionalFieldOption
  class AdditionalFieldOptionsList{
  } 
  class AdditionalFieldOption{
  }
  class AdditionalField{
    int id
    int order
    string name
    string description
    bool isCheckbox
    bool isHidden
    bool isInfo
    bool isText
    bool isSelect
    bool isRequired
    bool isChecked
    ?AdditionalFieldOptionsList options
  }

Properties

Attribute name	Type	Description
id	int	The unique identifier of the additional form field
order	int	The field order in the additional fields list.
name	string	The option name
isCheckbox	bool	Returns true if the field is checkbox field.
isHidden	bool	Returns true if the field is hidden field.
isInfo	bool	Returns true if the field is an info box.
isText	bool	Returns true if the field is text field.
isSelect	bool	Returns true if the field is select field.
isRequired	bool	Returns true if the field is required.
isChecked	bool	Returns true if the field is checkbox and checked.
options	null|AdditionalFieldOptionsList	The AdditionalFieldOptionsList object represents a list of options for select field.

Examples

id property

sourceoutput

{{ additionalField.id }}

1

order property

sourceoutput

{{ additionalField.order }}

2

name property

sourceoutput

{{ additionalField.name }}

example name

isCheckbox property

sourceoutput

{{ additionalField.isCheckbox }}

true

isHidden property

sourceoutput

{{ additionalField.isHidden }}

true

isInfo property

sourceoutput

{{ additionalField.isInfo }}

true

isText property

sourceoutput

{{ additionalField.isText }}

true

isSelect property

sourceoutput

{{ additionalField.isSelect }}

true

isRequired property

sourceoutput

{{ additionalField.isRequired }}

true

isChecked property

sourceoutput

{{ additionalField.isChecked }}

true

options property

sourceoutput

{% if additionalField.isSelect %}
    <select {% if additionalField.isRequired %}required{% endif %}>
        <option></option>
        {% for option in additionalField.options %}
            <option value="{{ option.id }}">{{ option.name }}</option>
        {% endfor %}
    </select>
{% endif %}

<select required>
  <option></option>
  <option value="111">Cooperation</option>
  <option value="222">Complaint</option>
</select>