Document `IInputModeFormField`
authorMatthias Schmidt <gravatronics@live.com>
Fri, 15 Jan 2021 15:28:45 +0000 (16:28 +0100)
committerMatthias Schmidt <gravatronics@live.com>
Fri, 15 Jan 2021 15:28:45 +0000 (16:28 +0100)
docs/php/api/form_builder/form_fields.md
docs/php/api/form_builder/structure.md

index b0aee75f71f0ce112aaa12136f5c28fafc260bac..0c80867704ce3b331c7c7e3e3d78f35ff7c7fd08 100644 (file)
@@ -13,7 +13,7 @@ The following form field classes cannot be instantiated directly because they ar
 ### `AbstractNumericFormField`
 
 `AbstractNumericFormField` is the abstract implementation of a form field handling a single numeric value.
-The class implements `IImmutableFormField`, `IMaximumFormField`, `IMinimumFormField`, `INullableFormField`, `IPlaceholderFormField` and `ISuffixedFormField`.
+The class implements `IImmutableFormField`, `IInputModeFormField`, `IMaximumFormField`, `IMinimumFormField`, `INullableFormField`, `IPlaceholderFormField` and `ISuffixedFormField`.
 If the property `$integerValues` is `true`, the form field works with integer values, otherwise it works with floating point numbers.
 The methods `step($step = null)` and `getStep()` can be used to set and get the step attribute of the `input` element.
 The default step for form fields with integer values is `1`.
@@ -166,7 +166,7 @@ If the field is nullable and the current form field value is considered `empty`
 ### `TextFormField`
 
 `TextFormField` is a form field that allows entering a single line of text.
-The class implements `IImmutableFormField`, `II18nFormField`, `IMaximumLengthFormField`, `IMinimumLengthFormField`, `IPatternFormField`, and `IPlaceholderFormField`.
+The class implements `IImmutableFormField`, `II18nFormField`, `IInputModeFormField`, `IMaximumLengthFormField`, `IMinimumLengthFormField`, `IPatternFormField`, and `IPlaceholderFormField`.
 
 
 ### `TitleFormField`
index e1f51fe2e0fd7a630df6241c43d3e5734cf1876f..250c8113ab623f625a567e11d1a98de0faa0a15f 100644 (file)
@@ -288,6 +288,13 @@ The implementing class has to implement the methods `immutable($immutable = true
 By default, form field are mutable.
 
 
+#### `IInputModeFormField`
+
+`IInputModeFormField` has to be implemented by form fields that support the [`inputmode` attribute](https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute).
+The implementing class has to implement the methods `inputMode(?string $inputMode): self` and `getInputMode(): ?string`, which are used to set and get the input mode, respectively.
+`TInputModeFormField` provides a default implementation of these two methods.
+
+
 #### `IMaximumFormField`
 
 `IMaximumFormField` has to be implemented by form fields if the entered value must have a maximum value.