Difference between revisions of "RML Forms"
(Created page with "{{RML}} A form is a collection of input elements inside a <form> element - when the form is “submitted”, the information stored in the each child input element is sent thr...") |
|||
| Line 10: | Line 10: | ||
====Attributes==== | ====Attributes==== | ||
| − | + | =====name===== | |
| − | + | The name of the input element. This is used to look up the element’s value when the form is submitted. For types of radio it is used to group together radio buttons so that only one with the same name can be checked at once. | |
| − | + | =====value===== | |
| + | For types of text, password and range, this is used as the initial value of the element. For the radio and checkbox types this is used as the value that is submitted if the input is checked. For <option> elements, this is the value that is submitted by the parent <select>, if it is the selected option. | ||
| + | =====disabled===== | ||
| + | If this attribute is set, then the input element is unable to be changed by user input. | ||
==<input>== | ==<input>== | ||
===Attributes=== | ===Attributes=== | ||
| − | + | ====type==== | |
| − | + | The type of the input field. Must be one of: | |
| − | + | ====text==== | |
| − | + | A one-line text-entry field. | |
| − | + | ====password==== | |
| − | + | Like text, but replaces the entered text with asterisks. | |
| − | + | ====radio==== | |
| + | A radio button. | ||
| + | ====checkbox==== | ||
| + | A checkbox. | ||
| + | ====range==== | ||
| + | A slider bar. | ||
| + | ====submit==== | ||
| + | A button for submitting the form. | ||
===Text and Password types=== | ===Text and Password types=== | ||
| − | + | ====size==== | |
| − | + | For types of text and password, defines the length (in characters) of the element. | |
| + | ====maxlength==== | ||
| + | For types of text and password, defines the maximum length (in characters) that the element will accept. | ||
===Radio and Checkbox types=== | ===Radio and Checkbox types=== | ||
| − | + | ====checked==== | |
| + | For types of radio and checkbox, if this attribute is set then the element is “on”. | ||
===Range type=== | ===Range type=== | ||
| − | + | ====min==== | |
| − | + | For the range type, defines the value at the lowest (left or top) end of the slider. | |
| − | + | ====max==== | |
| − | + | For the range type, defines the value at the highest (right or bottom) end of the slider. | |
| + | ====step==== | ||
| + | For the range type, defines the increment that the slider will move by. | ||
| + | ====orientation==== | ||
| + | For the range type, specifies if it is a vertical or horizontal slider. Values can be horizontal or vertical. | ||
==<textarea>== | ==<textarea>== | ||
===Attributes=== | ===Attributes=== | ||
| − | + | ====cols==== | |
| − | + | The width of the visible area of the textarea, as a number of columns of text. | |
| − | + | ====rows==== | |
| − | + | The height of the visible area of the textarea, as a number of text rows. | |
| + | ====wrap==== | ||
| + | If set nowrap, the textarea will not wrap unbroken lines to a new row. | ||
| + | ====maxlength==== | ||
| + | The maximum length (in characters) that the element will accept. | ||
==<select>== | ==<select>== | ||
| Line 46: | Line 67: | ||
==<option>== | ==<option>== | ||
===Attributes=== | ===Attributes=== | ||
| − | + | ====selected==== | |
| − | + | If set, then the option is selected when the <select> element is first loaded. | |
| + | ====unselectable==== | ||
| + | If set, then the option is not selectable by the user. Useful for labelling groups of options. | ||
==<dataselect>== | ==<dataselect>== | ||
===Attributes=== | ===Attributes=== | ||
| − | + | ====source==== | |
| − | + | The data source to read the options from. | |
| − | + | ====fields==== | |
| − | + | A comma-separated list of fields to fetch from the data source and to display for each option (or optionally to be sent through the data formatter) | |
| + | ====valuefield==== | ||
| + | The field from the data source to use as the option’s value. If not set, then the first field in the fields attribute is used. | ||
| + | ====formatter==== | ||
| + | The name of the dataformatter to use to process the raw fields information into RML. If not set, then the fields are displayed in raw text. | ||
Latest revision as of 21:01, 21 April 2023
| Librocket RML references | |
|---|---|
| Elements | |
| Documents | |
| Images | |
| Style Sheets | |
| Forms | |
| Controls | |
| Data Display | |
| Templates | |
| Events | |
A form is a collection of input elements inside a <form> element - when the form is “submitted”, the information stored in the each child input element is sent through to the listening process.
<form>
Attributes
- onsubmit - The name of the event to trigger when the form is submitted. The values of all form element children are passed to the event as parameters.
<form> Children
There are four elements that function as children to a <form> element: the <input>, <textarea>, <select> and <dataselect> elements. These have many common attributes which are listed below. Any specific attributes are listed afterwards under their own headings.
Attributes
name
The name of the input element. This is used to look up the element’s value when the form is submitted. For types of radio it is used to group together radio buttons so that only one with the same name can be checked at once.
value
For types of text, password and range, this is used as the initial value of the element. For the radio and checkbox types this is used as the value that is submitted if the input is checked. For <option> elements, this is the value that is submitted by the parent <select>, if it is the selected option.
disabled
If this attribute is set, then the input element is unable to be changed by user input.
<input>
Attributes
type
The type of the input field. Must be one of:
text
A one-line text-entry field.
password
Like text, but replaces the entered text with asterisks.
radio
A radio button.
checkbox
A checkbox.
range
A slider bar.
submit
A button for submitting the form.
Text and Password types
size
For types of text and password, defines the length (in characters) of the element.
maxlength
For types of text and password, defines the maximum length (in characters) that the element will accept.
Radio and Checkbox types
checked
For types of radio and checkbox, if this attribute is set then the element is “on”.
Range type
min
For the range type, defines the value at the lowest (left or top) end of the slider.
max
For the range type, defines the value at the highest (right or bottom) end of the slider.
step
For the range type, defines the increment that the slider will move by.
orientation
For the range type, specifies if it is a vertical or horizontal slider. Values can be horizontal or vertical.
<textarea>
Attributes
cols
The width of the visible area of the textarea, as a number of columns of text.
rows
The height of the visible area of the textarea, as a number of text rows.
wrap
If set nowrap, the textarea will not wrap unbroken lines to a new row.
maxlength
The maximum length (in characters) that the element will accept.
<select>
<select> has no additional parameters.
<option>
Attributes
selected
If set, then the option is selected when the <select> element is first loaded.
unselectable
If set, then the option is not selectable by the user. Useful for labelling groups of options.
<dataselect>
Attributes
source
The data source to read the options from.
fields
A comma-separated list of fields to fetch from the data source and to display for each option (or optionally to be sent through the data formatter)
valuefield
The field from the data source to use as the option’s value. If not set, then the first field in the fields attribute is used.
formatter
The name of the dataformatter to use to process the raw fields information into RML. If not set, then the fields are displayed in raw text.
