Difference between revisions of "Componentlayout form field type"
From Joomla! Documentation
(Added deprecation notice and link to Joomla Manual) |
|||
| Line 1: | Line 1: | ||
<noinclude><languages /></noinclude> | <noinclude><languages /></noinclude> | ||
| + | {{Warning|This page has been superseded and is no longer maintained. Please go to [https://manual.joomla.org/docs/general-concepts/forms-fields/standard-fields/componentlayout Joomla Manual Componentlayout Field] instead}} | ||
| + | |||
<translate><!--T:1--> | <translate><!--T:1--> | ||
The '''componentlayout''' form field type provides a drop down list of all available layouts for a view of an extension. If the parameter has a saved value this is selected when the page is first loaded. If not, the default value (if any) is selected.</translate> | The '''componentlayout''' form field type provides a drop down list of all available layouts for a view of an extension. If the parameter has a saved value this is selected when the page is first loaded. If not, the default value (if any) is selected.</translate> | ||
Latest revision as of 17:27, 15 July 2024
Warning!
This page has been superseded and is no longer maintained. Please go to Joomla Manual Componentlayout Field instead
The componentlayout form field type provides a drop down list of all available layouts for a view of an extension. If the parameter has a saved value this is selected when the page is first loaded. If not, the default value (if any) is selected.
- type (mandatory) must be componentlayout.
- name (mandatory) is the unique name of the parameter.
- label (mandatory) (translatable) is the descriptive title of the field.
- extension (mandatory) is the name of the extension for which the layouts will be retrieved (e.g. 'com_content').
- view (mandatory) is the name of the view for which the layouts will be retrieved (e.g. 'article').
- useglobal (optional).
- description (optional) (translatable) is text that will be shown as a tooltip when the user moves the mouse over the drop-down box.
Example XML parameter definition:
<field name="mylayout" type="componentlayout" extension="com_content" view="article" label="JFIELD_ALT_LAYOUT" useglobal="true" description="JFIELD_ALT_COMPONENT_LAYOUT" />