DEPRECATION WARNING
This documentation is not using the current rendering mechanism and is probably outdated. The extension maintainer should switch to the new system. Details on how to use the rendering mechanism can be found here.
Tab "Options"¶
The options tab will show the configuration of a particular element in the form. When no element has been selected, it will show a message that the editor has to select an element in the form.
The content of this tab depends on the type of element the editor has chosen in the form.
showAccordions¶
- Property:
- showAccordions
- TypoScript Path:
mod.wizards.form.defaults.tabs.options.showAccordions
- Data type:
- string
- Description:
Comma-separated list of the accordions that are allowed to be shown in the wizard. This does not mean they are all shown by default, but depends on the chosen element type.
Some tabs have further configuration which is described below.
- Default:
The following accordions are available:
- legend: Legend Properties
- label: Label Properties
- attributes: Attributes Properties
- options: Field Options
- validation: Validation
- filters: Filters
- various: Various Properties
- Example:
mod.wizards { form { defaults { tabs { options { showAccordions = legend, label, attributes, options, validation, filters, various } } } } }
Label accordion¶
showProperties¶
- Property:
- showProperties
- TypoScript Path:
mod.wizards.form.defaults.tabs.options.accordions.label.showProperties
- Data type:
- string
- Description:
- Comma-separated list of the label options that are allowed to be shown in the accordion. The appearance of an option depends on the chosen element type. If an element type does not support an option, it will not be shown.
- Default:
- label
Attributes accordion¶
showProperties¶
- Property:
- showProperties
- TypoScript Path:
mod.wizards.form.defaults.tabs.options.accordions.attributes.showProperties
- Data type:
- string
- Description:
- Comma-separated list of attributes that are allowed to be shown in the accordion. The appearance of an attribute depends on the chosen element type. If an element type does not support an attribute, it will not be shown.
- Default:
- accept, accept-charset, accesskey, action, alt, autocomplete, autofocus, checked, class, cols, contenteditable, contextmenu, dir, draggable, dropzone, disabled, enctype, hidden, height, id, inputmode, label, lang, list, max, maxlength, method, min, minlength, multiple, name, novalidate, pattern, placeholder, readonly, required, rows, selected, selectionDirection, selectionEnd, selectionStart, size, spellcheck, src, step, style, tabindex, text, title, translate, type, value, width, wrap
Validation accordion¶
showRules¶
- Property:
- showRules
- TypoScript Path:
mod.wizards.form.defaults.tabs.options.accordions.validation.showRules
- Data type:
- string
- Description:
- Comma-separated list of rules that are allowed to be shown in the wizard.
- Default:
- alphabetic, alphanumeric, between, date, digit, email, equals, fileallowedtypes, filemaximumsize, fileminimumsize, float, greaterthan, inarray, integer, ip, length, lessthan, regexp, required, uri
rules.[rule].showProperties¶
- Property:
- rules.[rule].showProperties
- TypoScript Path:
mod.wizards.form.defaults.tabs.options.accordions.validation.rules.[rule].showProperties
- Data type:
- [array of objects]
- Description:
- For each rule one can define which properties should appear.
The syntax is
rules.[name of the rule].showProperties
. - Default:
The following element properties are available:
Element Properties alphabetic message, error, showMessage, allowWhiteSpace alphanumeric message, error, showMessage, allowWhiteSpace between message, error, showMessage, minimum, maximum, inclusive date message, error, showMessage, format digit message, error, showMessage email message, error, showMessage equals message, error, showMessage, field fileallowedtypes message, error, showMessage, types filemaximumsize message, error, showMessage, maximum fileminimumsize message, error, showMessage, minimum float message, error, showMessage greaterthan message, error, showMessage, minimum inarray message, error, showMessage, array, strict integer message, error, showMessage ip message, error, showMessage length message, error, showMessage, minimum, maximum lessthan message, error, showMessage, maximum regexp message, error, showMessage, expression required message, error, showMessage uri message, error, showMessage
Filters accordion¶
showFilters¶
- Property:
- showFilters
- TypoScript Path:
mod.wizards.form.defaults.tabs.options.accordions.filtering.showFilters
- Data type:
- string
- Description:
Comma-separated list of the filters that are allowed to be shown in the wizard.
For each filter a list of properties to be shown can be defined.
- Default:
- alphabetic, alphanumeric, currency, digit, integer, lowercase, regexp, stripnewlines, titlecase, trim, uppercase
filters.[filter].showProperties¶
- Property:
- filters.[filter].showProperties
- TypoScript Path:
mod.wizards.form.defaults.tabs.options.accordions.filtering.filters.[filter].showProperties
- Data type:
- string
- Description:
Configuration for the filters individually. Not all filters have a configuration. Only the filters which are mentioned below can be configured.
The syntax is
filters.[name of the filter].showProperties
.- Default:
The following element properties are available:
Element Properties alphabetic allowWhiteSpace alphanumeric allowWhiteSpace currency decimalPoint, thousandSeparator regexp expression trim characterList
Default configuration¶
The default configuration of the options tab looks like this:
options {
showAccordions = legend, label, attributes, options, validation, filters, various
accordions {
label {
showProperties = label
}
attributes {
showProperties = accept, accept-charset, accesskey, action, alt, autocomplete, autofocus, checked, class, cols, contenteditable, contextmenu, dir, draggable, dropzone, disabled, enctype, hidden, height, id, inputmode, label, lang, list, max, maxlength, method, min, minlength, multiple, name, novalidate, pattern, placeholder, readonly, required, rows, selected, selectionDirection, selectionEnd, selectionStart, size, spellcheck, src, step, style, tabindex, text, title, translate, type, value, width, wrap
}
validation {
showRules = alphabetic, alphanumeric, between, date, digit, email, equals, fileallowedtypes, filemaximumsize, fileminimumsize, float, greaterthan, inarray, integer, ip, length, lessthan, regexp, required, uri
rules {
alphabetic {
showProperties = message, error, showMessage, allowWhiteSpace
}
alphanumeric {
showProperties = message, error, showMessage, allowWhiteSpace
}
between {
showProperties = message, error, showMessage, minimum, maximum, inclusive
}
date {
showProperties = message, error, showMessage, format
}
digit {
showProperties = message, error, showMessage
}
email {
showProperties = message, error, showMessage
}
equals {
showProperties = message, error, showMessage, field
}
fileallowedtypes {
showProperties = message, error, showMessage, types
}
filemaximumsize {
showProperties = message, error, showMessage, maximum
}
fileminimumsize {
showProperties = message, error, showMessage, minimum
}
float {
showProperties = message, error, showMessage
}
greaterthan {
showProperties = message, error, showMessage, minimum
}
inarray {
showProperties = message, error, showMessage, array, strict
}
integer {
showProperties = message, error, showMessage
}
ip {
showProperties = message, error, showMessage
}
length {
showProperties = message, error, showMessage, minimum, maximum
}
lessthan {
showProperties = message, error, showMessage, maximum
}
regexp {
showProperties = message, error, showMessage, expression
}
required {
showProperties = message, error, showMessage
}
uri {
showProperties = message, error, showMessage
}
}
}
filtering {
showFilters = alphabetic, alphanumeric, currency, digit, integer, lowercase, regexp, stripnewlines, titlecase, trim, uppercase
filters {
alphabetic {
showProperties = allowWhiteSpace
}
alphanumeric {
showProperties = allowWhiteSpace
}
currency {
showProperties = decimalPoint, thousandSeparator
}
digit {
showProperties =
}
integer {
showProperties =
}
lowercase {
showProperties =
}
regexp {
showProperties = expression
}
removexss {
showProperties =
}
titlecase {
showProperties =
}
trim {
showProperties = characterList
}
uppercase {
showProperties =
}
}
}
}
}