Difference between revisions of "Standard form field types"
From Joomla! Documentation
(Add plugins form field) |
|||
(16 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. Use the [[/Single-page reference|single-page reference]] if you want to print all existing form field documentation. | 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= | + | !width=65%|Description |
− | !width= | + | !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| | + | |{{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| | + | |{{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| | + | |{{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| | + | |{{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| | + | |{{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 | + | |{{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| | + | |{{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| | + | |{{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| | + | |{{JVer|2.5}} and newer |
|- | |- | ||
|[[DatabaseConnection form field type|Database Connection]] | |[[DatabaseConnection form field type|Database Connection]] | ||
Line 50: | Line 70: | ||
|[[Editor form field type|editor]] | |[[Editor form field type|editor]] | ||
|provides an editor area field. | |provides an editor area field. | ||
− | |{{JVer| | + | |{{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. Since {{JVer|2.5}} use [[Plugins form field type|plugins form field]] instead. |
− | |{{JVer| | + | |{{JVer|2.5}} |
|- | |- | ||
|[[Email form field type|email]] | |[[Email form field type|email]] | ||
|provides an email field. | |provides an email field. | ||
− | |{{JVer| | + | |{{JVer|2.5}} and newer |
|- | |- | ||
|[[File form field type|file]] | |[[File form field type|file]] | ||
| | | | ||
− | |{{JVer| | + | |{{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| | + | |{{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| | + | |{{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| | + | |{{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| | + | |{{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| | + | |{{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| | + | |{{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| | + | |{{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| | + | |{{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| | + | |{{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| | + | |{{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| | + | |{{JVer|2.5}} and newer |
|- | |- | ||
− | |[[Menuitem form field type| | + | |[[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| | + | |{{JVer|2.5}} and newer |
|- | |- | ||
− | |[[Modulelayout form field type| | + | |[[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| | + | |{{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]] | |[[Note form field type|note]] | ||
Line 123: | Line 159: | ||
|[[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| | + | |{{JVer|2.5}} and newer |
|- | |- | ||
|[[Plugins form field type|plugins]] | |[[Plugins form field type|plugins]] | ||
Line 131: | Line 167: | ||
|[[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| | + | |{{JVer|2.5}} and newer |
+ | |- | ||
+ | |[[Repeatable form field type|repeatable]] | ||
+ | |Allows form fields which can have as many options as the user desires. | ||
+ | |{{JVer|3.2}} 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| | + | |{{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| | + | |{{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| | + | |{{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| | + | |{{JVer|2.5}} and newer |
|- | |- | ||
|[[Tag form field type|tag]] | |[[Tag form field type|tag]] | ||
|provides an entry point for tags (either AJAX or Nested). | |provides an entry point for tags (either AJAX or Nested). | ||
|{{JVer|3.1}} and newer | |{{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| | + | |{{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| | + | |{{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| | + | |{{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| | + | |{{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| | + | |{{JVer|2.5}} and newer |
|- | |- | ||
|[[Usergroup form field type|usergroup]] | |[[Usergroup form field type|usergroup]] | ||
|provides a drop down list of user groups. | |provides a drop down list of user groups. | ||
− | |{{JVer| | + | |{{JVer|2.5}} and newer |
|} | |} | ||
+ | |||
+ | [[Category:Form fields]] | ||
+ | [[Category:Development Reference]] | ||
+ | [[Category:Needs to be marked for translation]] |
Revision as of 08:37, 8 February 2015
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.
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. | and newer |
cachehandler | provides a list of available cache handling options. | 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. | and newer |
captcha | provides a drop down list of the captcha plugins. | and newer |
category | provides a drop down list of categories for an extension. | and newer |
checkbox | provides a single checkbox to be checked or unchecked | and newer |
checkboxes | provides unlimited checkboxes that can be used for multi-select. | and newer |
Chrome Style | provides a list of template chrome style options grouped by template. | and newer |
color | provides a color picker when clicking the input box. | and newer |
Content Language | Provides a list of content languages. | and newer |
Content Type | Provides a list of content types. | and newer |
combo | provides a combo box field. | and newer |
componentlayout | provides a grouped list of core and template alternate layouts for a component item. | and newer |
contentlanguage | provides a list of installed content languages for use in conjunction with the language switcher plugin. | and newer |
Database Connection | Provides a list of available database connections, optionally limiting to a given list. | and newer |
editor | provides an editor area field. | and newer |
editors | Provides a drop down list of the available WYSIWYG editors. Since use plugins form field instead. | |
provides an email field. | and newer | |
file | and newer | |
filelist | provides a drop down list of files from a specified directory. | and newer |
folderlist | provides a drop down list of folders from a specified directory. | and newer |
groupedlist | provides a drop down list of items organized into groups. | and newer |
header tag | provides a drop down list of the header tags (h1-h6). | and newer |
helpsite | provides a drop down list of the help sites for your Joomla installation. | 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). | and newer |
imagelist | provides a drop down list of image files in a specified directory. | and newer |
integer | provides a drop down list of integers between a minimum and maximum. | and newer |
language | provides a drop down list of the installed languages for the Front-end or Back-end. | and newer |
list | provides a drop down list of custom-defined entries. | and newer |
media | provides modal access to the media manager for insertion of images with upload for users with appropriate permissions. | and newer |
menu | provides a drop down list of the available menus from your Joomla site. | and newer |
Menu Item | provides a drop down list of the available menu items from your Joomla site. | and newer |
Module Layout | provides a list of alternative layout for a module grouped by core and template. | and newer |
Module Order | Provides a drop down to set the ordering of module in a given position | and newer |
Module Position | provides a text input to set the position of a module. | and newer |
Module Tag | provides a list of html5 elements (used to wrap a module in). | and newer |
note | supports a one line text field. | and newer |
password | provides a text box for entry of a password. The password characters will be obscured as they are entered. | and newer |
plugins | provides a list of plugins from a given folder. | and newer |
radio | provides radio buttons to select different options. | and newer |
repeatable | Allows form fields which can have as many options as the user desires. | and newer |
rules | provides a matrix of group by action options for managing access control. Display depends on context. | and newer |
sessionhandler | provides a drop down list of session handler options. | and newer |
spacer | provides a visual separator between form fields. It is purely a visual aid and no value is stored. | 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. | and newer |
tag | provides an entry point for tags (either AJAX or Nested). | and newer |
tel | provides an input field for a telephone number. | and newer |
templatestyle | provides a drop down list of template styles. | and newer |
text | provides a text box for data entry. | and newer |
textarea | provides a text area for entry of multi-line text. | and newer |
timezone | provides a drop down list of time zones. | and newer |
URL | provides a URL text input field. | and newer |
user | provides a modal list of users. | and newer |
usergroup | provides a drop down list of user groups. | and newer |