List Data

Description

Allows selection of one or more options from a specific list.

Must contain option-generating sub-macros (e.g. List Option or Content Options).


Parameters

NameRequiredAvailable InDefault ValueDescription

name (Field Name)

 (tick)

 

The name of the field. Must be unique.

type

 (tick)

select

The type of field to display. May be one of the following:

  • select - A selectable list is displayed
  • check - A list of checkable items are displayed.
  • Auto Complete - An auto complete list is displayed.

Note: Only applies for forms mode.

required

 (error)

false/unchecked

If true, a non-empty item must be selected. 

multiple (Allow Multiple)

 (error)

false/unchecked

If true, multiple options may be selected.

separator

 (error)

comma

If multiple items are selected, the type of separator to display between each item. Defaults to one item per line. May be one of the following:

  • bracket - Square brackets ('[', ']') surrounding each item.
  • brace - Braces ('{', '}') surrounding each item.
  • comma - A comma (',') between each item.
  • paren - Parentheses ('(', ')') surrounding each item.
  • pipe - A pipe ('|') between each item.
  • newline - A line break after each item.
  • "custom" - Any other character you wish, specified between quotes.

customSeparator

 (error)

 

What you wish to use as a separator, only used when custom is selected for Separator.

blank

 (error)

true

If 'true', a blank item is added to the list. Only applies to 'select' lists. If the user saves while selecting the blank item and the list is 'required', the page cannot be saved.

Note: Only applicable for forms mode.

blankText

 (error)

 

If specified, and 'blank' is true, this text will be used for the blank option label.

Note: Only applicable for forms mode.

width

 (error)

 

The width of the field. Any CSS width is allowed (e.g. 100px).

Note: Only applies when type is 'select'.
Note: Only applies for forms mode.

height

 (error)

 

The height of the field. Any CSS height is allowed (e.g. '20px').

Note: Only applies when type is 'select'.
Note: Only applicable for forms mode.


Editor View

Tutorial Examples