Actions

Difference between revisions of "Standard form field types"

From Joomla! Documentation

m (Updated contents)
m
(19 intermediate revisions by 3 users not shown)
Line 1: Line 1:
Numerous types of [[form field]] are built into Joomla!. The following table lists these standard types and their availability.
+
Numerous types of [[form field]] are built into Joomla!. The following table lists these standard types and their availability. Use the [[/Single-page reference|single-page reference]] if you want to print all existing form field documentation.
  
{{JVer|1.5}} Please note that many of these fields are available as [[Parameter|parameter types]] in Joomla! 1.5. For a list of parameter types, see [[Standard parameter types]]. For a comparison between form field and parameter types, see [[Standard form field and parameter types]].
+
{{JVer|1.5}} Please note that many of these fields are available as [[Parameter|parameter types]] in Joomla! 1.5. For a list of parameter types, see [[J1.5:Standard parameter types]]. For a comparison between form field and parameter types, see [[Standard form field and parameter types]].
 
{| class="wikitable" style="vertical-align:top; border:1px solid Sienna; background-color:Cornsilk;"
 
{| class="wikitable" style="vertical-align:top; border:1px solid Sienna; background-color:Cornsilk;"
 
|- style="background-color:Wheat; font-weight:bold; text-align: left;"
 
|- style="background-color:Wheat; font-weight:bold; text-align: left;"
 
!width=15%|Type
 
!width=15%|Type
!width=70%|Description
+
!width=65%|Description
!width=15%|Availability
+
!width=20%|Availability
 
|-
 
|-
 
|[[Accesslevel form field type|accesslevel]]
 
|[[Accesslevel form field type|accesslevel]]
 
|provides a drop down list of viewing access levels.
 
|provides a drop down list of viewing access levels.
|{{JVer|1.6}} and newer
+
|{{JVer|2.5}} and newer
 
|-
 
|-
 
|[[Cachehandler form field type|cachehandler]]
 
|[[Cachehandler form field type|cachehandler]]
 
|provides a list of available cache handling options.
 
|provides a list of available cache handling options.
|{{JVer|1.6}} and newer
+
|{{JVer|2.5}} and newer
 
|-
 
|-
 
|[[Calendar form field type|calendar]]
 
|[[Calendar form field type|calendar]]
 
|provides a text box for entry of a date. An icon next to the text box provides a link to a pop-up calendar, which can also be used to enter the date value.
 
|provides a text box for entry of a date. An icon next to the text box provides a link to a pop-up calendar, which can also be used to enter the date value.
|{{JVer|1.6}} and newer
+
|{{JVer|2.5}} and newer
 +
|-
 +
|[[Captcha form field type|captcha]]
 +
|provides a drop down list of the captcha plugins.
 +
|{{JVer|2.5}} and newer
 
|-
 
|-
 
|[[Category form field type|category]]
 
|[[Category form field type|category]]
 
|provides a drop down list of categories for an extension.
 
|provides a drop down list of categories for an extension.
|{{JVer|1.6}} and newer
+
|{{JVer|2.5}} and newer
 
|-
 
|-
 
|[[Checkbox form field type|checkbox]]
 
|[[Checkbox form field type|checkbox]]
 
|provides a single checkbox to be checked or unchecked
 
|provides a single checkbox to be checked or unchecked
|{{JVer|1.6}} and newer
+
|{{JVer|2.5}} and newer
 
|-
 
|-
 
|[[Checkboxes form field type|checkboxes]]
 
|[[Checkboxes form field type|checkboxes]]
 
|provides unlimited checkboxes that can be used for multi-select.
 
|provides unlimited checkboxes that can be used for multi-select.
|{{JVer|1.6}} and newer
+
|{{JVer|2.5}} and newer
 +
|-
 +
|[[ChromeStyle form field type|Chrome Style]]
 +
|provides a list of template chrome style options grouped by template.
 +
|{{JVer|3.0}} and newer
 +
|-
 +
|[[Color form field type|color]]
 +
|provides a color picker when clicking the input box.
 +
|{{JVer|2.5}} and newer
 +
|-
 +
|[[ContentLanguage form field type|Content Language]]
 +
|Provides a list of content languages.
 +
|{{JVer|2.5}} and newer
 +
|-
 +
|[[Contenttype form field type|Content Type]]
 +
|Provides a list of content types.
 +
|{{JVer|3.1}} and newer
 
|-
 
|-
 
|[[Combo form field type|combo]]
 
|[[Combo form field type|combo]]
 
|provides a combo box field.
 
|provides a combo box field.
|{{JVer|1.6}} and newer
+
|{{JVer|2.5}} and newer
 
|-
 
|-
 
|[[Componentlayout form field type|componentlayout]]
 
|[[Componentlayout form field type|componentlayout]]
 
|provides a grouped list of core and template alternate layouts for a component item.
 
|provides a grouped list of core and template alternate layouts for a component item.
|{{JVer|1.6}} and newer
+
|{{JVer|2.5}} and newer
 
|-
 
|-
 
|[[Contentlanguage form field type|contentlanguage]]
 
|[[Contentlanguage form field type|contentlanguage]]
 
|provides a list of installed content languages for use in conjunction with the language switcher plugin.
 
|provides a list of installed content languages for use in conjunction with the language switcher plugin.
|{{JVer|1.6}} and newer
+
|{{JVer|2.5}} and newer
 +
|-
 +
|[[DatabaseConnection form field type|Database Connection]]
 +
|Provides a list of available database connections, optionally limiting to a given list.
 +
|{{JVer|2.5}} and newer
 
|-
 
|-
 
|[[Editor form field type|editor]]
 
|[[Editor form field type|editor]]
 
|provides an editor area field.
 
|provides an editor area field.
|{{JVer|1.6}} and newer
+
|{{JVer|2.5}} and newer
 
|-
 
|-
 
|[[Editors form field type|editors]]
 
|[[Editors form field type|editors]]
|provides a drop down list of the available WYSIWYG editors.
+
|Provides a drop down list of the available WYSIWYG editors. Since {{JVer|2.5}} use [[Plugins form field type|plugins form field]] instead.
|{{JVer|1.6}} and newer
+
|{{JVer|2.5}}
 +
|-
 +
|[[Email form field type|email]]
 +
|provides an email field.
 +
|{{JVer|2.5}} and newer
 
|-
 
|-
 
|[[File form field type|file]]
 
|[[File form field type|file]]
 
|
 
|
|{{JVer|1.6}} and newer
+
|{{JVer|2.5}} and newer
 
|-
 
|-
 
|[[Filelist form field type|filelist]]
 
|[[Filelist form field type|filelist]]
 
|provides a drop down list of files from a specified directory.
 
|provides a drop down list of files from a specified directory.
|{{JVer|1.6}} and newer
+
|{{JVer|2.5}} and newer
 
|-
 
|-
 
|[[Folderlist form field type|folderlist]]
 
|[[Folderlist form field type|folderlist]]
 
|provides a drop down list of folders from a specified directory.
 
|provides a drop down list of folders from a specified directory.
|{{JVer|1.6}} and newer
+
|{{JVer|2.5}} and newer
 
|-
 
|-
 
|[[Groupedlist form field type|groupedlist]]
 
|[[Groupedlist form field type|groupedlist]]
 
|provides a drop down list of items organized into groups.
 
|provides a drop down list of items organized into groups.
|{{JVer|1.6}} and newer
+
|{{JVer|2.5}} and newer
 +
|-
 +
|[[HeaderTag form field type|header tag]]
 +
|provides a drop down list of the header tags (h1-h6).
 +
|{{JVer|3.0}} and newer
 
|-
 
|-
 
|[[Helpsite form field type|helpsite]]
 
|[[Helpsite form field type|helpsite]]
 
|provides a drop down list of the help sites for your Joomla installation.
 
|provides a drop down list of the help sites for your Joomla installation.
|{{JVer|1.6}} and newer
+
|{{JVer|2.5}} and newer
 
|-
 
|-
 
|[[Hidden form field type|hidden]]
 
|[[Hidden form field type|hidden]]
 
|provides a hidden field for saving a form field whose value cannot be altered directly by a user in the Administrator (it can be altered in code or by editing the ''params.ini'' file).
 
|provides a hidden field for saving a form field whose value cannot be altered directly by a user in the Administrator (it can be altered in code or by editing the ''params.ini'' file).
|{{JVer|1.6}} and newer
+
|{{JVer|2.5}} and newer
 
|-
 
|-
 
|[[Imagelist form field type|imagelist]]
 
|[[Imagelist form field type|imagelist]]
 
|provides a drop down list of image files in a specified directory.
 
|provides a drop down list of image files in a specified directory.
|{{JVer|1.6}} and newer
+
|{{JVer|2.5}} and newer
 
|-
 
|-
 
|-
 
|-
 
|[[Integer form field type|integer]]
 
|[[Integer form field type|integer]]
 
|provides a drop down list of integers between a minimum and maximum.
 
|provides a drop down list of integers between a minimum and maximum.
|{{JVer|1.6}} and newer
+
|{{JVer|2.5}} and newer
 
|-
 
|-
 
|[[Language form field type|language]]
 
|[[Language form field type|language]]
 
|provides a drop down list of the installed languages for the Front-end or Back-end.
 
|provides a drop down list of the installed languages for the Front-end or Back-end.
|{{JVer|1.6}} and newer
+
|{{JVer|2.5}} and newer
 
|-
 
|-
 
|[[List form field type|list]]
 
|[[List form field type|list]]
 
|provides a drop down list of custom-defined entries.
 
|provides a drop down list of custom-defined entries.
|{{JVer|1.6}} and newer
+
|{{JVer|2.5}} and newer
 
|-
 
|-
 
|[[Media form field type|media]]
 
|[[Media form field type|media]]
 
|provides modal access to the media manager for insertion of images with upload for users with appropriate permissions.
 
|provides modal access to the media manager for insertion of images with upload for users with appropriate permissions.
|{{JVer|1.6}} and newer
+
|{{JVer|2.5}} and newer
 
|-
 
|-
 
|[[Menu form field type|menu]]
 
|[[Menu form field type|menu]]
 
|provides a drop down list of the available menus from your Joomla site.
 
|provides a drop down list of the available menus from your Joomla site.
|{{JVer|1.6}} and newer
+
|{{JVer|2.5}} and newer
 
|-
 
|-
|[[Menuitem form field type|menuitem]]
+
|[[Menuitem form field type|Menu Item]]
 
|provides a drop down list of the available menu items from your Joomla site.
 
|provides a drop down list of the available menu items from your Joomla site.
|{{JVer|1.6}} and newer
+
|{{JVer|2.5}} and newer
 
|-
 
|-
|[[Modulelayout form field type|modulelayout]]
+
|[[Modulelayout form field type|Module Layout]]
 
|provides a list of alternative layout for a module grouped by core and template.
 
|provides a list of alternative layout for a module grouped by core and template.
|{{JVer|1.6}} and newer
+
|{{JVer|2.5}} and newer
 +
|-
 +
|[[ModuleOrder form field type|Module Order]]
 +
|Provides a drop down to set the ordering of module in a given position
 +
|{{JVer|2.5}} and newer
 +
|-
 +
|[[ModulePosition form field type|Module Position]]
 +
|provides a text input to set the position of a module.
 +
|{{JVer|2.5}} and newer
 +
|-
 +
|[[ModuleTag form field type|Module Tag]]
 +
|provides a list of html5 elements (used to wrap a module in).
 +
|{{JVer|3.0}} and newer
 +
|-
 +
|[[Note form field type|note]]
 +
|supports a one line text field.
 +
|{{JVer|3.1}} and newer
 
|-
 
|-
 
|[[Password form field type|password]]
 
|[[Password form field type|password]]
 
|provides a text box for entry of a password.  The password characters will be obscured as they are entered.
 
|provides a text box for entry of a password.  The password characters will be obscured as they are entered.
|{{JVer|1.6}} and newer
+
|{{JVer|2.5}} and newer
 +
|-
 +
|[[Plugins form field type|plugins]]
 +
|provides a list of plugins from a given folder.
 +
|{{JVer|2.5}} and newer
 
|-
 
|-
 
|[[Radio form field type|radio]]
 
|[[Radio form field type|radio]]
 
|provides radio buttons to select different options.
 
|provides radio buttons to select different options.
|{{JVer|1.6}} and newer
+
|{{JVer|2.5}} and newer
 
|-
 
|-
 
|[[Rules form field type|rules]]
 
|[[Rules form field type|rules]]
 
|provides a matrix of group by action options for managing access control. Display depends on context.
 
|provides a matrix of group by action options for managing access control. Display depends on context.
|{{JVer|1.6}} and newer
+
|{{JVer|2.5}} and newer
 
|-
 
|-
 
|[[Sessionhandler form field type|sessionhandler]]
 
|[[Sessionhandler form field type|sessionhandler]]
 
|provides a drop down list of session handler options.
 
|provides a drop down list of session handler options.
|{{JVer|1.6}} and newer
+
|{{JVer|2.5}} and newer
 
|-
 
|-
 
|[[Spacer form field type|spacer]]
 
|[[Spacer form field type|spacer]]
 
|provides a visual separator between form fields.  It is purely a visual aid and no value is stored.
 
|provides a visual separator between form fields.  It is purely a visual aid and no value is stored.
|{{JVer|1.6}} and newer
+
|{{JVer|2.5}} and newer
 
|-
 
|-
|[[Sql form field type|sql]]
+
|[[SQL form field type|sql]]
 
|provides a drop down list of entries obtained by running a query on the Joomla Database.  The first results column returned by the query provides the values for the drop down box.
 
|provides a drop down list of entries obtained by running a query on the Joomla Database.  The first results column returned by the query provides the values for the drop down box.
|{{JVer|1.6}} and newer
+
|{{JVer|2.5}} and newer
 +
|-
 +
|[[Tag form field type|tag]]
 +
|provides an entry point for tags (either AJAX or Nested).
 +
|{{JVer|3.1}} and newer
 +
|-
 +
|[[Tel form field type|tel]]
 +
|provides an input field for a telephone number.
 +
|{{JVer|2.5}} and newer
 
|-
 
|-
 
|[[Templatestyle form field type|templatestyle]]
 
|[[Templatestyle form field type|templatestyle]]
 
|provides a drop down list of template styles.
 
|provides a drop down list of template styles.
|{{JVer|1.6}} and newer
+
|{{JVer|2.5}} and newer
 
|-
 
|-
 
|[[Text form field type|text]]
 
|[[Text form field type|text]]
 
|provides a text box for data entry.
 
|provides a text box for data entry.
|{{JVer|1.6}} and newer
+
|{{JVer|2.5}} and newer
 
|-
 
|-
 
|[[Textarea form field type|textarea]]
 
|[[Textarea form field type|textarea]]
 
|provides a text area for entry of multi-line text.
 
|provides a text area for entry of multi-line text.
|{{JVer|1.6}} and newer
+
|{{JVer|2.5}} and newer
 
|-
 
|-
 
|[[Timezone form field type|timezone]]
 
|[[Timezone form field type|timezone]]
 
|provides a drop down list of time zones.
 
|provides a drop down list of time zones.
|{{JVer|1.6}} and newer
+
|{{JVer|2.5}} and newer
 +
|-
 +
|[[URL form field type|URL]]
 +
|provides a URL text input field.
 +
|{{JVer|2.5}} and newer
 
|-
 
|-
 
|[[User form field type|user]]
 
|[[User form field type|user]]
 
|provides a modal list of users.
 
|provides a modal list of users.
|{{JVer|1.6}} and newer
+
|{{JVer|2.5}} and newer
 
|-
 
|-
 
|[[Usergroup form field type|usergroup]]
 
|[[Usergroup form field type|usergroup]]
|provides an array of check boxes allowing multi-select.  
+
|provides a drop down list of user groups.  
|{{JVer|1.6}} and newer
+
|{{JVer|2.5}} and newer
 
|}
 
|}

Revision as of 19:16, 10 May 2013

Numerous types of form field are built into Joomla!. The following table lists these standard types and their availability. Use the single-page reference if you want to print all existing form field documentation.

Joomla 1.5 Please note that many of these fields are available as parameter types in Joomla! 1.5. For a list of parameter types, see J1.5:Standard parameter types. For a comparison between form field and parameter types, see Standard form field and parameter types.

Type Description Availability
accesslevel provides a drop down list of viewing access levels. Joomla 2.5 and newer
cachehandler provides a list of available cache handling options. Joomla 2.5 and newer
calendar provides a text box for entry of a date. An icon next to the text box provides a link to a pop-up calendar, which can also be used to enter the date value. Joomla 2.5 and newer
captcha provides a drop down list of the captcha plugins. Joomla 2.5 and newer
category provides a drop down list of categories for an extension. Joomla 2.5 and newer
checkbox provides a single checkbox to be checked or unchecked Joomla 2.5 and newer
checkboxes provides unlimited checkboxes that can be used for multi-select. Joomla 2.5 and newer
Chrome Style provides a list of template chrome style options grouped by template. Joomla 3.0 and newer
color provides a color picker when clicking the input box. Joomla 2.5 and newer
Content Language Provides a list of content languages. Joomla 2.5 and newer
Content Type Provides a list of content types. Joomla 3.1 and newer
combo provides a combo box field. Joomla 2.5 and newer
componentlayout provides a grouped list of core and template alternate layouts for a component item. Joomla 2.5 and newer
contentlanguage provides a list of installed content languages for use in conjunction with the language switcher plugin. Joomla 2.5 and newer
Database Connection Provides a list of available database connections, optionally limiting to a given list. Joomla 2.5 and newer
editor provides an editor area field. Joomla 2.5 and newer
editors Provides a drop down list of the available WYSIWYG editors. Since Joomla 2.5 use plugins form field instead. Joomla 2.5
email provides an email field. Joomla 2.5 and newer
file Joomla 2.5 and newer
filelist provides a drop down list of files from a specified directory. Joomla 2.5 and newer
folderlist provides a drop down list of folders from a specified directory. Joomla 2.5 and newer
groupedlist provides a drop down list of items organized into groups. Joomla 2.5 and newer
header tag provides a drop down list of the header tags (h1-h6). Joomla 3.0 and newer
helpsite provides a drop down list of the help sites for your Joomla installation. Joomla 2.5 and newer
hidden provides a hidden field for saving a form field whose value cannot be altered directly by a user in the Administrator (it can be altered in code or by editing the params.ini file). Joomla 2.5 and newer
imagelist provides a drop down list of image files in a specified directory. Joomla 2.5 and newer
integer provides a drop down list of integers between a minimum and maximum. Joomla 2.5 and newer
language provides a drop down list of the installed languages for the Front-end or Back-end. Joomla 2.5 and newer
list provides a drop down list of custom-defined entries. Joomla 2.5 and newer
media provides modal access to the media manager for insertion of images with upload for users with appropriate permissions. Joomla 2.5 and newer
menu provides a drop down list of the available menus from your Joomla site. Joomla 2.5 and newer
Menu Item provides a drop down list of the available menu items from your Joomla site. Joomla 2.5 and newer
Module Layout provides a list of alternative layout for a module grouped by core and template. Joomla 2.5 and newer
Module Order Provides a drop down to set the ordering of module in a given position Joomla 2.5 and newer
Module Position provides a text input to set the position of a module. Joomla 2.5 and newer
Module Tag provides a list of html5 elements (used to wrap a module in). Joomla 3.0 and newer
note supports a one line text field. Joomla 3.1 and newer
password provides a text box for entry of a password. The password characters will be obscured as they are entered. Joomla 2.5 and newer
plugins provides a list of plugins from a given folder. Joomla 2.5 and newer
radio provides radio buttons to select different options. Joomla 2.5 and newer
rules provides a matrix of group by action options for managing access control. Display depends on context. Joomla 2.5 and newer
sessionhandler provides a drop down list of session handler options. Joomla 2.5 and newer
spacer provides a visual separator between form fields. It is purely a visual aid and no value is stored. Joomla 2.5 and newer
sql provides a drop down list of entries obtained by running a query on the Joomla Database. The first results column returned by the query provides the values for the drop down box. Joomla 2.5 and newer
tag provides an entry point for tags (either AJAX or Nested). Joomla 3.1 and newer
tel provides an input field for a telephone number. Joomla 2.5 and newer
templatestyle provides a drop down list of template styles. Joomla 2.5 and newer
text provides a text box for data entry. Joomla 2.5 and newer
textarea provides a text area for entry of multi-line text. Joomla 2.5 and newer
timezone provides a drop down list of time zones. Joomla 2.5 and newer
URL provides a URL text input field. Joomla 2.5 and newer
user provides a modal list of users. Joomla 2.5 and newer
usergroup provides a drop down list of user groups. Joomla 2.5 and newer