date_field/README.md

52 lines
1.6 KiB
Markdown
Raw Normal View History

2020-03-01 22:16:29 +00:00
# date_field
2020-03-01 22:29:41 +00:00
Contains DateField and DateFormField!
2020-03-01 22:16:29 +00:00
## Getting Started
2020-03-01 22:29:41 +00:00
Just to let you know, this is how it looks like without any customization:
2020-03-01 22:16:29 +00:00
2020-03-01 22:29:41 +00:00
<img src=''></img>
The best way to discover this package is simply to check the example page!
There are two widgets in this package:
- DateField
- DateFormField
The second one is wrapping the first one with a FormField widget! This way you can integrate it in your form structure flawlessly.
The DateField widget returns an InputDecorator with an Inkwell which will display a date picker (*platform responsive*) which allows the user to select the date he wants!
You can customize the widget a lot thanks to these parameters:
<pre><code>
/// Callback for whenever the user selects a [DateTime]
final ValueChanged<DateTime> onDateSelected;
/// The current selected date to display inside the field
final DateTime selectedDate;
/// (optional) The first date that the user can select (default is 1900)
final DateTime firstDate;
/// (optional) The last date that the user can select (default is 2100)
final DateTime lastDate;
/// Let you choose the [DatePickerMode] for the date picker! (default is [DatePickerMode.day]
final DatePickerMode initialDatePickerMode;
/// The label to display for the field (default is 'Select date')
final String label;
/// (optional) The error text that should be displayed under the field
final String errorText;
/// (optional) Custom [InputDecoration] for the [InputDecorator] widget
final InputDecoration decoration;
/// (optional) How to display the [DateTime] for the user (default is [DateFormat.yMMMD])
final DateFormat dateFormat;
</code></pre>