Difference between revisions of "Editor form field type"
From Joomla! Documentation
ADaneInSpain (talk | contribs) (Cols and rows also do not work) |
(Some capitalization, markup and punctuation changes.) |
||
| Line 10: | Line 10: | ||
* '''label''' (mandatory) (translatable) is the descriptive title of the field.</translate> | * '''label''' (mandatory) (translatable) is the descriptive title of the field.</translate> | ||
<translate><!--T:5--> | <translate><!--T:5--> | ||
| − | * '''width''' (optional) defines the width (in pixels) of the | + | * '''width''' (optional) defines the width (in pixels) of the WYSIWYG editor and defaults to 100%. '''(Currently not supported)'''</translate> |
<translate><!--T:6--> | <translate><!--T:6--> | ||
| − | * '''height''' (optional) defines the height (in pixels) of the | + | * '''height''' (optional) defines the height (in pixels) of the WYSIWYG editor and defaults to 250px. '''(Currently not supported)'''</translate> |
<translate><!--T:7--> | <translate><!--T:7--> | ||
* '''cols''' (optional) defines the width of the editor (in columns). '''(Currently not supported)'''</translate> | * '''cols''' (optional) defines the width of the editor (in columns). '''(Currently not supported)'''</translate> | ||
| Line 20: | Line 20: | ||
* '''buttons''' (optional) can be an array of plugin buttons to be excluded or set to false. The default editors-xtd are: article, image, pagebreak and readmore.</translate> | * '''buttons''' (optional) can be an array of plugin buttons to be excluded or set to false. The default editors-xtd are: article, image, pagebreak and readmore.</translate> | ||
<translate><!--T:10--> | <translate><!--T:10--> | ||
| − | * '''hide''' (optional) array of plugin buttons to be hidden. | + | * '''hide''' (optional) array of plugin buttons to be hidden. E.g. set buttons="true" hide="readmore,pagebreak"</translate> |
<translate><!--T:11--> | <translate><!--T:11--> | ||
| − | * '''editor''' specifies the editor to be used and can include two options (editor="desired|alternative")</translate> | + | * '''editor''' specifies the editor to be used and can include two options. (editor="desired|alternative")</translate> |
<translate><!--T:12--> | <translate><!--T:12--> | ||
| − | * '''filter''' (optional) allow the system to save certain | + | * '''filter''' (optional) allow the system to save certain HTML tags or raw data.</translate> |
<translate><!--T:13--> | <translate><!--T:13--> | ||
| − | Example XML Definition | + | Example XML Definition</translate> |
| − | < | + | <syntaxhighlight lang="xml"><field name="test1" type="editor" label="Test Field" description="" width="300" filter="safehtml" /></syntaxhighlight> |
| − | <translate>=== See | + | <translate>=== See Also === <!--T:14--></translate> |
<translate><!--T:15--> | <translate><!--T:15--> | ||
* [[S:MyLanguage/Textarea form field type|Textarea form field type]]</translate> | * [[S:MyLanguage/Textarea form field type|Textarea form field type]]</translate> | ||
Latest revision as of 17:28, 15 December 2022
The Editor field type provides a WYSIWYG editor.
- type (mandatory) must be editor.
- name (mandatory) is the unique name of the parameter.
- label (mandatory) (translatable) is the descriptive title of the field.
- width (optional) defines the width (in pixels) of the WYSIWYG editor and defaults to 100%. (Currently not supported)
- height (optional) defines the height (in pixels) of the WYSIWYG editor and defaults to 250px. (Currently not supported)
- cols (optional) defines the width of the editor (in columns). (Currently not supported)
- rows (optional) defines the height of the editor (in rows). (Currently not supported)
- buttons (optional) can be an array of plugin buttons to be excluded or set to false. The default editors-xtd are: article, image, pagebreak and readmore.
- hide (optional) array of plugin buttons to be hidden. E.g. set buttons="true" hide="readmore,pagebreak"
- editor specifies the editor to be used and can include two options. (editor="desired|alternative")
- filter (optional) allow the system to save certain HTML tags or raw data.
Example XML Definition
<field name="test1" type="editor" label="Test Field" description="" width="300" filter="safehtml" />