Skip to content

Commit f1653f0

Browse files
committed
Tweaked documentation to reflect type safety changes and saveValue property.
1 parent df751af commit f1653f0

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -392,14 +392,14 @@ In order to create an input field in the form, along with the label, and any app
392392

393393
| Attribute | Type | Default | Required | Description |
394394
|-----------|-------|---------|-------------|----------|
395-
| `name` | `String` | `null` | `Yes` | This will form the key in the form value Map |
396-
| `initialValue` | `dynamic` | `null` | `No` | The initial value of the input field |
397-
| `readOnly` | `bool` | `false` | `No` | Determines whether the field widget will accept user input. This value will be ignored if the `readOnly` attribute of `FormBuilder` widget is set to `true` |
395+
| `name` | `String` | | `Yes` | This will form the key in the form value Map |
396+
| `initialValue` | `T` | `null` | `No` | The initial value of the input field |
397+
| `enabled` | `bool` | `true` | `No` | Determines whether the field widget will accept user input. |
398398
| `decoration` | `InputDecoration` | `InputDecoration()` | `No` | Defines the border, labels, icons, and styles used to decorate the field. |
399-
| `validator` | `FormFieldValidator` | `null` | `No` | A `FormFieldValidator` that will check the validity of value in the `FormField` |
399+
| `validator` | `FormFieldValidator<T>` | `null` | `No` | A `FormFieldValidator` that will check the validity of value in the `FormField` |
400400
| `onChanged` | `ValueChanged<T>` | `null` | `No` | This event function will fire immediately the the field value changes |
401401
| `valueTransformer` | `ValueTransformer<T>` | `null` | `No` | Function that transforms field value before saving to form value. e.g. transform TextField value for numeric field from `String` to `num` |
402-
| `skipReadOnly` | `bool` | `false` | `No` | Determines whether the field and its value will be included in the final form value `Map` |
402+
| `saveValue` | `bool` | `true` | `No` | Determines whether the field and its value will be included in the final form value `Map` |
403403
The rest of the attributes will be determined by the type of Widget being used.
404404

405405
### Building your own custom field

0 commit comments

Comments
 (0)