Actions

Difference between revisions of "Text form field type"

From Joomla! Documentation

m (Default value of text field param is currently _not_ translatable)
(Adding the message parameter)
 
(2 intermediate revisions by one user not shown)
Line 1: Line 1:
 
[[Image:Params.text.jpg|right]]
 
[[Image:Params.text.jpg|right]]
  
{{Ambox|type=notice|text=In Joomla! 1.5, [[Form field|form fields]] were [[Parameter|parameters]]. For that version, you may want to use the corresponding [[Text parameter type]].}}
+
{{Ambox|type=notice|text=In Joomla! 1.5, [[Form field|form fields]] were [[Parameter|parameters]]. For that version, you may want to use the corresponding [[J1.5:Text parameter type]].}}
  
 
The '''text''' form field type provides a text box for data entry. If the field has a value saved, this value is displayed when the page is first loaded. If not, the default value (if any) is selected.  
 
The '''text''' form field type provides a text box for data entry. If the field has a value saved, this value is displayed when the page is first loaded. If not, the default value (if any) is selected.  
Line 13: Line 13:
 
* '''description''' (optional) (translatable) is text that will be shown as a tooltip when the user moves the mouse over the drop-down box.
 
* '''description''' (optional) (translatable) is text that will be shown as a tooltip when the user moves the mouse over the drop-down box.
 
* '''class''' (optional) is a CSS class name for the HTML form field. If omitted this will default to 'text_area'.
 
* '''class''' (optional) is a CSS class name for the HTML form field. If omitted this will default to 'text_area'.
* '''readonly''' (optional)  
+
* '''readonly''' (optional) The field cannot be changed and will automatically inherit the default value
* '''disabled''' (optional)
+
* '''disabled''' (optional) The field cannot be changed and will automatically inherit the default value - it will also not submit
 +
* '''required''' (optional) The field must be filled before submitting the form.
 
* '''filter''' (optional) allow the system to save certain html tags or raw data.
 
* '''filter''' (optional) allow the system to save certain html tags or raw data.
 +
* '''message''' (optional) The error message that will be displayed instead of the default message.
  
 
Example XML field definition:
 
Example XML field definition:

Latest revision as of 05:49, 15 May 2014

Params.text.jpg

The text form field type provides a text box for data entry. If the field has a value saved, this value is displayed when the page is first loaded. If not, the default value (if any) is selected.

  • type (mandatory) must be text.
  • name (mandatory) is the unique name of the field.
  • label (mandatory) (translatable) is the descriptive title of the field.
  • size (optional) is the width of the text box in characters. If omitted the width is determined by the browser. The value of size does not limit the number of characters that may be entered.
  • maxlength (optional) limits the number of characters that may be entered.
  • default (optional) (not translatable) is the default value.
  • description (optional) (translatable) is text that will be shown as a tooltip when the user moves the mouse over the drop-down box.
  • class (optional) is a CSS class name for the HTML form field. If omitted this will default to 'text_area'.
  • readonly (optional) The field cannot be changed and will automatically inherit the default value
  • disabled (optional) The field cannot be changed and will automatically inherit the default value - it will also not submit
  • required (optional) The field must be filled before submitting the form.
  • filter (optional) allow the system to save certain html tags or raw data.
  • message (optional) The error message that will be displayed instead of the default message.

Example XML field definition:

<field name="mytextvalue" type="text" default="Some text" label="Enter some text" description="" size="10" />

Use the integer filter to ensure that letters types get stripped when the form is processed.

<field name="myintvalue" type="text" default="8" label="Enter some text" description="Enter some description" filter="integer" />

Use the raw filter to ensure that html code is preserved when the form is processed.

<field name="myhtmlvalue" type="text" default="" label="Enter some text" description="Enter some description" filter="raw" />

See also