Actions

J1.5

Difference between revisions of "Spacer parameter type"

From Joomla! Documentation

(This is a parameter, not a form field.)
Line 6: Line 6:
  
 
* '''type''' (mandatory) must be ''spacer''.
 
* '''type''' (mandatory) must be ''spacer''.
* '''default''' (optional) (translatable) is a string which will be used instead of the ''<nowiki><hr /></nowiki>'' that is inserted by default.
+
* '''label''' (optional) (translatable) is a string which will be used instead of the ''<nowiki><hr /></nowiki>'' that is inserted by default.
  
 
Example XML parameter definition:
 
Example XML parameter definition:
Line 12: Line 12:
  
 
You can replace the basic horizontal line with a title which can be used to group parameters.  For example,
 
You can replace the basic horizontal line with a title which can be used to group parameters.  For example,
<source lang="xml"><param type="spacer" default="Advanced parameters" /></source>
+
<source lang="xml"><param type="spacer" label="Advanced parameters" /></source>
  
 
Note that you can also include HTML markup but it must be encoded.  For example, to put the text into bold you can use:
 
Note that you can also include HTML markup but it must be encoded.  For example, to put the text into bold you can use:
<source lang="xml"><param type="spacer" default="&lt;b&gt;Advanced parameters&lt;/b&gt;" /></source>
+
<source lang="xml"><param type="spacer" label="&lt;b&gt;Advanced parameters&lt;/b&gt;" /></source>
 
<noinclude>
 
<noinclude>
 
=== See also ===
 
=== See also ===
 
* [[Standard parameter types|List of standard parameter types]]
 
* [[Standard parameter types|List of standard parameter types]]
 
[[Category:Standard parameter types]]</noinclude>
 
[[Category:Standard parameter types]]</noinclude>

Revision as of 09:13, 18 October 2011

Replacement filing cabinet.png
This Namespace has been archived - Please Do Not Edit or Create Pages in this namespace. Pages contain information for a Joomla! version which is no longer supported. It exists only as a historical reference, will not be improved and its content may be incomplete.
Params.spacer.jpg

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

  • type (mandatory) must be spacer.
  • label (optional) (translatable) is a string which will be used instead of the <hr /> that is inserted by default.

Example XML parameter definition:

<param type="spacer" />

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

<param type="spacer" label="Advanced parameters" />

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

<param type="spacer" label="&lt;b&gt;Advanced parameters&lt;/b&gt;" />

See also