Spacer form field type

From Joomla! Documentation

The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.
Other languages:
English • ‎Nederlands • ‎español • ‎français • ‎polski

The spacer form field type provides a visual separator between parameter field elements. It is purely a visual aid and no field value is stored.

Params.spacer.jpg
  • type (mandatory) must be spacer.
  • name (mandatory) is the unique name of the field.
  • label (optional) (translatable) is the text to use as a spacer.
  • description (optional) (translatable) is text that will be shown as a tooltip when the user moves the mouse over the drop-down box.
  • hr (optional) is whether to display a horizontal rule ('true' or 'false'). If this attribute is 'true', the label attribute will be ignored.
  • class (optional) is a CSS class name for the HTML form field.

Example XML field definition:

<field type="spacer" name="myspacer" hr="true" />

You can replace the basic horizontal line with a title which can be used to group parameters. For example,

<field type="spacer" name="myspacer" label="Advanced parameters" />

You can also place translatable text into the label attribute:

<field type="spacer" name="myspacer" class="text"
label="PLG_TINY_FIELD_NAME_EXTENDED_LABEL"
/>

Note that you can also include HTML markup but it must be encoded. For example, to put the text into bold you can use:

<field type="spacer" name="myspacer" label="&lt;b&gt;Advanced parameters&lt;/b&gt;" />

You cannot combine the hr and label attributes. To define a spacer with both a horizontal rule and a label, use an encoded <hr /> in the label attribute:

<field type="spacer" name="myspacer" label="&lt;hr/&gt;More parameters" />

See also