Added documentations for classes

danvick · danvick · commit 1d65752b90a0 · 2020-11-21T20:48:42.000+03:00
diff --git a/lib/src/fields/form_builder_checkbox.dart b/lib/src/fields/form_builder_checkbox.dart
@@ -3,6 +3,7 @@ import 'package:flutter/rendering.dart';
 import 'package:flutter/widgets.dart';
 import 'package:flutter_form_builder/flutter_form_builder.dart';
 
+/// Single Checkbox field
 class FormBuilderCheckbox extends FormBuilderField<bool> {
   /// The primary content of the CheckboxListTile.
   ///
@@ -64,6 +65,7 @@ class FormBuilderCheckbox extends FormBuilderField<bool> {
   /// Normally, this property is left to its default value, false.
   final bool selected;
 
+  /// Creates a single Checkbox field
   FormBuilderCheckbox({
     //From Super
     Key key,
diff --git a/lib/src/fields/form_builder_checkbox_group.dart b/lib/src/fields/form_builder_checkbox_group.dart
@@ -3,6 +3,7 @@ import 'package:flutter/widgets.dart';
 import 'package:flutter_form_builder/flutter_form_builder.dart';
 import 'package:flutter_form_builder/src/widgets/grouped_checkbox.dart';
 
+/// A list of Checkboxes for selecting multiple options
 class FormBuilderCheckboxGroup<T> extends FormBuilderField<List<T>> {
   final List<FormBuilderFieldOption<T>> options;
   final Color activeColor;
@@ -24,6 +25,7 @@ class FormBuilderCheckboxGroup<T> extends FormBuilderField<List<T>> {
   final ControlAffinity controlAffinity;
   final OptionsOrientation orientation;
 
+  /// Creates a list of Checkboxes for selecting multiple options
   FormBuilderCheckboxGroup({
     Key key,
     //From Super
diff --git a/lib/src/fields/form_builder_chips_input.dart b/lib/src/fields/form_builder_chips_input.dart
@@ -2,6 +2,8 @@ import 'package:flutter/material.dart';
 import 'package:flutter_chips_input/flutter_chips_input.dart';
 import 'package:flutter_form_builder/flutter_form_builder.dart';
 
+/// A field that takes a list of `Chip`s as input and suggests more options
+/// while typing
 class FormBuilderChipsInput<T> extends FormBuilderField<List<T>> {
   //TODO: Add documentation
   final ChipsInputSuggestions findSuggestions;
@@ -23,6 +25,8 @@ class FormBuilderChipsInput<T> extends FormBuilderField<List<T>> {
   final bool autofocus;
   final TextOverflow textOverflow;
 
+  /// Creates a field that takes a list of `Chip`s as input and suggests more options
+  /// while typing
   FormBuilderChipsInput({
     Key key,
     //From Super
diff --git a/lib/src/fields/form_builder_choice_chips.dart b/lib/src/fields/form_builder_choice_chips.dart
@@ -2,6 +2,7 @@ import 'package:flutter/material.dart';
 import 'package:flutter/widgets.dart';
 import 'package:flutter_form_builder/flutter_form_builder.dart';
 
+/// A list of `Chip`s that acts like radio buttons
 class FormBuilderChoiceChip<T> extends FormBuilderField<T> {
   /// The list of items the user can select.
   final List<FormBuilderFieldOption<T>> options;
@@ -238,6 +239,7 @@ class FormBuilderChoiceChip<T> extends FormBuilderField<T> {
   /// [verticalDirection] must not be null.
   final VerticalDirection verticalDirection;
 
+  /// Creates a list of `Chip`s that acts like radio buttons
   FormBuilderChoiceChip({
     Key key,
     //From Super
diff --git a/lib/src/fields/form_builder_color_picker.dart b/lib/src/fields/form_builder_color_picker.dart
@@ -31,6 +31,7 @@ extension on Color {
 
 enum ColorPickerType { ColorPicker, MaterialPicker, BlockPicker }
 
+/// Creates a field for `Color` input selection
 class FormBuilderColorPickerField extends FormBuilderField<Color> {
   //TODO: Add documentation
   final TextEditingController controller;
diff --git a/lib/src/fields/form_builder_date_range_picker.dart b/lib/src/fields/form_builder_date_range_picker.dart
@@ -6,9 +6,9 @@ import 'package:flutter/material.dart';
 import 'package:flutter/services.dart';
 import 'package:flutter/widgets.dart';
 import 'package:flutter_form_builder/flutter_form_builder.dart';
-import 'package:flutter_form_builder/src/always_disabled_focus_node.dart';
 import 'package:intl/intl.dart' as intl;
 
+/// Field for selecting a range of dates
 class FormBuilderDateRangePicker extends FormBuilderField<List<DateTime>> {
   //TODO: Add documentation
   final int maxLines;
@@ -47,6 +47,7 @@ class FormBuilderDateRangePicker extends FormBuilderField<List<DateTime>> {
   final date_range_picker.SelectableDayPredicate selectableDayPredicate;
   final intl.DateFormat format;
 
+  /// Creates field for selecting a range of dates
   FormBuilderDateRangePicker({
     Key key,
     //From Super
diff --git a/lib/src/fields/form_builder_date_time_picker.dart b/lib/src/fields/form_builder_date_time_picker.dart
@@ -13,6 +13,7 @@ enum InputType { date, time, both }
 
 enum PickerType { material, cupertino }
 
+/// Field for `Date`, `Time` and `DateTime` input
 class FormBuilderDateTimePicker extends FormBuilderField<DateTime> {
   /// The date/time picker dialogs to show.
   final InputType inputType;
@@ -145,6 +146,7 @@ class FormBuilderDateTimePicker extends FormBuilderField<DateTime> {
   final DatePickerTheme theme;
   final TimePickerEntryMode timePickerInitialEntryMode;
 
+  /// Creates field for `Date`, `Time` and `DateTime` input
   FormBuilderDateTimePicker({
     Key key,
     //From Super
diff --git a/lib/src/fields/form_builder_dropdown.dart b/lib/src/fields/form_builder_dropdown.dart
@@ -2,6 +2,7 @@ import 'package:flutter/material.dart';
 import 'package:flutter/widgets.dart';
 import 'package:flutter_form_builder/flutter_form_builder.dart';
 
+/// Field for Dropdown button
 class FormBuilderDropdown<T> extends FormBuilderField<T> {
   /// The list of items the user can select.
   ///
@@ -179,6 +180,7 @@ class FormBuilderDropdown<T> extends FormBuilderField<T> {
   final bool allowClear;
   final Widget clearIcon;
 
+  /// Creates field for Dropdown button
   FormBuilderDropdown({
     Key key,
     //From Super
diff --git a/lib/src/fields/form_builder_file_picker.dart b/lib/src/fields/form_builder_file_picker.dart
@@ -9,6 +9,7 @@ import 'package:flutter/widgets.dart';
 import 'package:flutter_form_builder/flutter_form_builder.dart';
 import 'package:permission_handler/permission_handler.dart';
 
+/// Field for image(s) from user device storage
 class FormBuilderFilePicker extends FormBuilderField<List<PlatformFile>> {
   /// Maximum number of files needed for this field
   final int maxFiles;
@@ -45,6 +46,7 @@ class FormBuilderFilePicker extends FormBuilderField<List<PlatformFile>> {
   /// which can be useful for uploading and processing large files.
   final bool withReadStream;
 
+  /// Creates field for image(s) from user device storage
   FormBuilderFilePicker({
     //From Super
     Key key,
diff --git a/lib/src/fields/form_builder_filter_chips.dart b/lib/src/fields/form_builder_filter_chips.dart
@@ -2,6 +2,7 @@ import 'package:flutter/material.dart';
 import 'package:flutter/widgets.dart';
 import 'package:flutter_form_builder/flutter_form_builder.dart';
 
+/// Field with chips that acts like a list checkboxes.
 class FormBuilderFilterChip<T> extends FormBuilderField<List<T>> {
   //TODO: Add documentation
   final List<FormBuilderFieldOption<T>> options;
@@ -32,6 +33,7 @@ class FormBuilderFilterChip<T> extends FormBuilderField<List<T>> {
   // final VisualDensity visualDensity;
   final int maxChips;
 
+  /// Creates field with chips that acts like a list checkboxes.
   FormBuilderFilterChip({
     Key key,
     //From Super
diff --git a/lib/src/fields/form_builder_image_picker.dart b/lib/src/fields/form_builder_image_picker.dart
@@ -7,6 +7,7 @@ import 'package:flutter_form_builder/flutter_form_builder.dart';
 import 'package:flutter_form_builder/src/widgets/image_source_sheet.dart';
 import 'package:image_picker/image_picker.dart';
 
+/// Field for picking image(s) from Gallery or Camera.
 class FormBuilderImagePicker extends FormBuilderField<List<dynamic>> {
   //TODO: Add documentation
   final double previewWidth;
@@ -41,6 +42,7 @@ class FormBuilderImagePicker extends FormBuilderField<List<dynamic>> {
   final Widget galleryLabel;
   final EdgeInsets bottomSheetPadding;
 
+  /// Creates field for picking image(s) from Gallery or Camera.
   FormBuilderImagePicker({
     Key key,
     //From Super
diff --git a/lib/src/fields/form_builder_phone_field.dart b/lib/src/fields/form_builder_phone_field.dart
@@ -8,6 +8,7 @@ import 'package:flutter_form_builder/flutter_form_builder.dart';
 import 'package:phone_number/phone_number.dart';
 
 //TODO: Switch country_pickers for country_code_picker
+/// Field for international phone number input.
 class FormBuilderPhoneField extends FormBuilderField<String> {
   //TODO: Add documentation
   final int maxLines;
@@ -52,6 +53,7 @@ class FormBuilderPhoneField extends FormBuilderField<String> {
   final double cupertinoPickerSheetHeight;
   final TextAlignVertical textAlignVertical;
 
+  /// Creates field for international phone number input.
   FormBuilderPhoneField({
     Key key,
     //From Super
diff --git a/lib/src/fields/form_builder_radio_group.dart b/lib/src/fields/form_builder_radio_group.dart
@@ -3,6 +3,7 @@ import 'package:flutter/widgets.dart';
 import 'package:flutter_form_builder/flutter_form_builder.dart';
 import 'package:flutter_form_builder/src/widgets/grouped_radio.dart';
 
+/// Field to select one value from a list of Radio Widgets
 class FormBuilderRadioGroup<T> extends FormBuilderField<T> {
   final List<FormBuilderFieldOption<T>> options;
   final Color activeColor;
@@ -20,9 +21,9 @@ class FormBuilderRadioGroup<T> extends FormBuilderField<T> {
   final VerticalDirection wrapVerticalDirection;
   final Widget separator;
   final ControlAffinity controlAffinity;
-
   final OptionsOrientation orientation;
 
+  /// Creates field to select one value from a list of Radio Widgets
   FormBuilderRadioGroup({
     Key key,
     //From Super
diff --git a/lib/src/fields/form_builder_range_slider.dart b/lib/src/fields/form_builder_range_slider.dart
@@ -3,6 +3,7 @@ import 'package:flutter/widgets.dart';
 import 'package:flutter_form_builder/flutter_form_builder.dart';
 import 'package:intl/intl.dart';
 
+/// Field to select a range of values on a Slider
 class FormBuilderRangeSlider extends FormBuilderField<RangeValues> {
   /// Called when the user starts selecting new values for the slider.
   ///
@@ -103,6 +104,7 @@ class FormBuilderRangeSlider extends FormBuilderField<RangeValues> {
   final TextStyle maxTextStyle;
   final NumberFormat numberFormat;
 
+  /// Creates field to select a range of values on a Slider
   FormBuilderRangeSlider({
     Key key,
     //From Super
diff --git a/lib/src/fields/form_builder_rating.dart b/lib/src/fields/form_builder_rating.dart
@@ -4,6 +4,7 @@ import 'package:flutter/widgets.dart';
 import 'package:flutter_form_builder/flutter_form_builder.dart';
 import 'package:rating_bar/rating_bar.dart';
 
+/// Field for selection of a numerical value as a rating
 class FormBuilderRating extends FormBuilderField<double> {
   /// Icon to be used to denote the value of the widget
   final IconData icon;
@@ -32,6 +33,7 @@ class FormBuilderRating extends FormBuilderField<double> {
   /// Fill color of the icon to be used when the value is half
   final Color halfFilledColor;
 
+  /// Creates field for selection of a numerical value as a rating
   FormBuilderRating({
     Key key,
     //From Super
diff --git a/lib/src/fields/form_builder_searchable_dropdown.dart b/lib/src/fields/form_builder_searchable_dropdown.dart
@@ -5,6 +5,7 @@ import 'package:flutter/material.dart';
 import 'package:flutter/widgets.dart';
 import 'package:flutter_form_builder/flutter_form_builder.dart';
 
+/// Field for selecting value(s) from a searchable list
 class FormBuilderSearchableDropdown<T> extends FormBuilderField<T> {
   /// final List<DropdownMenuItem<T>> items;
 
@@ -100,6 +101,7 @@ class FormBuilderSearchableDropdown<T> extends FormBuilderField<T> {
   ///set a custom color for the popup barrier
   final Color popupBarrierColor;
 
+  /// Creates field for selecting value(s) from a searchable list
   FormBuilderSearchableDropdown({
     Key key,
     //From Super
diff --git a/lib/src/fields/form_builder_segmented_control.dart b/lib/src/fields/form_builder_segmented_control.dart
@@ -3,6 +3,7 @@ import 'package:flutter/material.dart';
 import 'package:flutter/widgets.dart';
 import 'package:flutter_form_builder/flutter_form_builder.dart';
 
+/// Field for selection of a value from the `CupertinoSegmentedControl`
 class FormBuilderSegmentedControl<T> extends FormBuilderField<T> {
   /// The color used to fill the backgrounds of unselected widgets and as the
   /// text color of the selected widget.
@@ -35,6 +36,7 @@ class FormBuilderSegmentedControl<T> extends FormBuilderField<T> {
   /// The list of options the user can select.
   final List<FormBuilderFieldOption<T>> options;
 
+  /// Creates field for selection of a value from the `CupertinoSegmentedControl`
   FormBuilderSegmentedControl({
     Key key,
     //From Super
diff --git a/lib/src/fields/form_builder_signature_pad.dart b/lib/src/fields/form_builder_signature_pad.dart
@@ -5,6 +5,7 @@ import 'package:flutter/widgets.dart';
 import 'package:flutter_form_builder/flutter_form_builder.dart';
 import 'package:signature/signature.dart';
 
+/// Field with drawing pad on which user can doodle
 class FormBuilderSignaturePad extends FormBuilderField<Uint8List> {
   /// Controls the value of the signature pad.
   ///
@@ -26,6 +27,7 @@ class FormBuilderSignaturePad extends FormBuilderField<Uint8List> {
   /// Styles the canvas border
   final Border border;
 
+  /// Creates field with drawing pad on which user can doodle
   FormBuilderSignaturePad({
     Key key,
     //From Super
diff --git a/lib/src/fields/form_builder_slider.dart b/lib/src/fields/form_builder_slider.dart
@@ -6,6 +6,7 @@ import 'package:intl/intl.dart';
 
 enum DisplayValues { all, current, minMax, none }
 
+/// Field for selection of a numerical value on a slider
 class FormBuilderSlider extends FormBuilderField<double> {
   /// Called when the user starts selecting a new value for the slider.
   ///
@@ -127,6 +128,7 @@ class FormBuilderSlider extends FormBuilderField<double> {
   final TextStyle textStyle;
   final TextStyle maxTextStyle;
 
+  /// Creates field for selection of a numerical value on a slider
   FormBuilderSlider({
     Key key,
     //From Super
diff --git a/lib/src/fields/form_builder_switch.dart b/lib/src/fields/form_builder_switch.dart
@@ -4,6 +4,7 @@ import 'package:flutter/material.dart';
 import 'package:flutter/widgets.dart';
 import 'package:flutter_form_builder/flutter_form_builder.dart';
 
+/// On/Off switch field
 class FormBuilderSwitch extends FormBuilderField<bool> {
   /// The primary content of the list tile.
   ///
@@ -80,6 +81,7 @@ class FormBuilderSwitch extends FormBuilderField<bool> {
   /// {@macro flutter.widgets.Focus.autofocus}
   final bool autofocus;
 
+  /// Creates On/Off switch field
   FormBuilderSwitch({
     Key key,
     //From Super
diff --git a/lib/src/fields/form_builder_text_field.dart b/lib/src/fields/form_builder_text_field.dart
@@ -8,6 +8,7 @@ import 'package:flutter/services.dart';
 import 'package:flutter/widgets.dart';
 import 'package:flutter_form_builder/flutter_form_builder.dart';
 
+/// A Material Design text field input.
 class FormBuilderTextField extends FormBuilderField<String> {
   /// Controls the text being edited.
   ///
@@ -289,6 +290,7 @@ class FormBuilderTextField extends FormBuilderField<String> {
   /// {@macro flutter.services.autofill.autofillHints}
   final Iterable<String> autofillHints;
 
+  /// Creates a Material Design text field input.
   FormBuilderTextField({
     Key key,
     //From Super
diff --git a/lib/src/fields/form_builder_touch_spin.dart b/lib/src/fields/form_builder_touch_spin.dart
@@ -4,6 +4,7 @@ import 'package:flutter_form_builder/flutter_form_builder.dart';
 import 'package:flutter_touch_spin/flutter_touch_spin.dart';
 import 'package:intl/intl.dart';
 
+/// Field for selection of a number by tapping on an add or subtract icon
 class FormBuilderTouchSpin extends FormBuilderField<num> {
   /// Value to increment or decrement by
   final num step;
@@ -42,6 +43,7 @@ class FormBuilderTouchSpin extends FormBuilderField<num> {
   /// Color of icon while the widget is in active state
   final Color iconDisabledColor;
 
+  /// Creates field for selection of a number by tapping on an add or subtract icon
   FormBuilderTouchSpin({
     Key key,
     //From Super
diff --git a/lib/src/fields/form_builder_typeahead.dart b/lib/src/fields/form_builder_typeahead.dart
@@ -5,6 +5,7 @@ import 'package:flutter_typeahead/flutter_typeahead.dart';
 
 typedef SelectionToTextTransformer<T> = String Function(T suggestion);
 
+/// Text field that auto-completes user input from a list of items
 class FormBuilderTypeAhead<T> extends FormBuilderField<T> {
   /// Called with the search pattern to get the search suggestions.
   ///
@@ -255,6 +256,7 @@ class FormBuilderTypeAhead<T> extends FormBuilderField<T> {
   /// If null, this widget will create its own [TextEditingController].
   final TextEditingController controller;
 
+  /// Creates text field that auto-completes user input from a list of items
   FormBuilderTypeAhead({
     Key key,
     //From Super
diff --git a/lib/src/form_builder.dart b/lib/src/form_builder.dart
@@ -3,6 +3,7 @@ import 'package:flutter_form_builder/flutter_form_builder.dart';
 
 typedef ValueTransformer<T> = dynamic Function(T value);
 
+/// A container for form fields.
 class FormBuilder extends StatefulWidget {
   /// Called when one of the form fields changes.
   ///
@@ -59,6 +60,9 @@ class FormBuilder extends StatefulWidget {
   /// and their enabled state will be ignored.
   final bool enabled;
 
+  /// Creates a container for form fields.
+  ///
+  /// The [child] argument must not be null.
   const FormBuilder({
     Key key,
     @required this.child,
diff --git a/lib/src/form_builder_field.dart b/lib/src/form_builder_field.dart
diff --git a/lib/src/form_builder_field_option.dart b/lib/src/form_builder_field_option.dart
diff --git a/lib/src/form_builder_validators.dart b/lib/src/form_builder_validators.dart
