improved documentation

Author: codegrue

.pubignore

@@ -1,3 +1,2 @@
 .vscode/*
-example
 images

CHANGELOG.md

@@ -1,5 +1,10 @@
 # Releases
 
+## [3.1.4] - 2022-04-08
+
+- added example back in
+- improved documentation
+
 ## [3.1.3] - 2022-04-07
 
 - Updated dependency versions

lib/dialogs/checkbox_picker_dialog.dart

@@ -10,7 +10,8 @@ import 'responsive_dialog.dart';
 
 /// This is a support widget that returns an Dialog with checkboxes as a Widget.
 /// It is designed to be used in the showDialog method of other fields.
-class CheckboxPickerDialog<T> extends StatefulWidget implements ICommonDialogProperties {
+class CheckboxPickerDialog<T> extends StatefulWidget
+    implements ICommonDialogProperties {
   CheckboxPickerDialog({
     this.title,
     required this.items,
@@ -50,13 +51,16 @@ class CheckboxPickerDialog<T> extends StatefulWidget implements ICommonDialogPro
   final String? cancelText;
 
   @override
-  State<CheckboxPickerDialog> createState() => _CheckboxPickerDialogState<T>(selectedItems);
+  State<CheckboxPickerDialog> createState() =>
+      _CheckboxPickerDialogState<T>(selectedItems);
 }
 
 class _CheckboxPickerDialogState<T> extends State<CheckboxPickerDialog<T>> {
   _CheckboxPickerDialogState(List<T>? selectedItems) {
     // make a shallow copy so we don't modify the original list
-    this.selectedItems = (selectedItems == null) ? List<T>.empty(growable: true) : List<T>.from(selectedItems);
+    this.selectedItems = (selectedItems == null)
+        ? List<T>.empty(growable: true)
+        : List<T>.from(selectedItems);
   }
 
   late List<T> selectedItems;

lib/dialogs/radio_picker_dialog.dart

@@ -10,7 +10,8 @@ import 'responsive_dialog.dart';
 
 /// This is a support widget that returns an Dialog with checkboxes as a Widget.
 /// It is designed to be used in the showDialog method of other fields.
-class RadioPickerDialog<T> extends StatefulWidget implements ICommonDialogProperties {
+class RadioPickerDialog<T> extends StatefulWidget
+    implements ICommonDialogProperties {
   RadioPickerDialog({
     this.title,
     required this.items,
@@ -50,7 +51,8 @@ class RadioPickerDialog<T> extends StatefulWidget implements ICommonDialogProper
   final String? cancelText;
 
   @override
-  State<RadioPickerDialog> createState() => _RadioPickerDialogState<T>(selectedItem);
+  State<RadioPickerDialog> createState() =>
+      _RadioPickerDialogState<T>(selectedItem);
 }
 
 class _RadioPickerDialogState<T> extends State<RadioPickerDialog<T>> {

lib/helpers/show_checkbox_picker.dart

@@ -9,20 +9,51 @@ import '../flutter_material_pickers.dart';
 /// Allows selection of many values from a checkbox list.
 Future<List<T>?> showMaterialCheckboxPicker<T>({
   required BuildContext context,
+
+  /// The title for the dialog box
   String? title,
+
+  /// The list of items to use with the picker
   required List<T> items,
+
+  /// The item that will be initially selected
   List<T>? selectedItems,
+
+  /// The dialog header color (overrides theme)
   Color? headerColor,
+
+  /// The dialog header text color (overrides theme)
   Color? headerTextColor,
+
+  /// The dialog background color (overrides theme)
   Color? backgroundColor,
+
+  /// The button text color (overrides theme)
   Color? buttonTextColor,
+
+  /// Text to display in the confirm button
   String? confirmText,
+
+  /// Text to display in the cancel button
   String? cancelText,
+
+  /// Used to restrict how tall the dialog can be.
   double? maxLongSide,
+
+  /// Used to restrict how wide the dialog can be.
   double? maxShortSide,
+
+  /// Function that gets called when the value is changed
   ValueChanged<List<T>>? onChanged,
+
+  /// Function that gets called when the confirm button is pressed
   VoidCallback? onConfirmed,
+
+  /// Function that gets called when the cancel button is pressed
   VoidCallback? onCancelled,
+
+  /// Function that is called when each items renders which can be used to transform the content
+  /// This is helpful, for example, to provide translations to other languages
   Transformer<T>? transformer,
 }) {
   return showDialog<List<T>>(

lib/helpers/show_color_picker.dart

@@ -8,18 +8,44 @@ import 'package:flutter_material_pickers/dialogs/responsive_dialog.dart';
 /// Allows RGB selection of a color.
 Future<Color?> showMaterialColorPicker({
   required BuildContext context,
+
+  /// The title for the dialog box
   String title = "Pick a color",
+
+  /// The color that is initially selected
   required Color selectedColor,
+
+  /// The dialog header color (overrides theme)
   Color? headerColor,
+
+  /// The dialog header text color (overrides theme)
   Color? headerTextColor,
+
+  /// The dialog background color (overrides theme)
   Color? backgroundColor,
+
+  /// The button text color (overrides theme)
   Color? buttonTextColor,
+
+  /// Text to display in the confirm button
   String? confirmText,
+
+  /// Text to display in the cancel button
   String? cancelText,
+
+  /// Used to restrict how tall the dialog can be.
   double? maxLongSide,
+
+  /// Used to restrict how wide the dialog can be.
   double? maxShortSide,
+
+  /// Function that gets called when the value is changed
   ValueChanged<Color>? onChanged,
+
+  /// Function that gets called when the confirm button is pressed
   VoidCallback? onConfirmed,
+
+  /// Function that gets called when the cancel button is pressed
   VoidCallback? onCancelled,
 }) {
   return showDialog<Color>(

lib/helpers/show_date_picker.dart

@@ -7,20 +7,50 @@ import 'package:flutter_material_pickers/dialogs/responsive_dialog.dart';
 /// Allows selection of a date.
 Future<DateTime?> showMaterialDatePicker({
   required BuildContext context,
+
+  /// The title for the dialog box
   String? title,
+
+  /// The intiial first date in the selection range
   required DateTime firstDate,
+
+  /// The intiial last date in the selection range
   required DateTime lastDate,
+
+  /// The initial single selected date
   required DateTime selectedDate,
+
+  /// The dialog header color (overrides theme)
   Color? headerColor,
+
+  /// The dialog header text color (overrides theme)
   Color? headerTextColor,
+
+  /// The dialog background color (overrides theme)
   Color? backgroundColor,
+
+  /// The button text color (overrides theme)
   Color? buttonTextColor,
+
+  /// Text to display in the confirm button
   String? confirmText,
+
+  /// Text to display in the cancel button
   String? cancelText,
+
+  /// Used to restrict how tall the dialog can be.
   double? maxLongSide,
+
+  /// Used to restrict how wide the dialog can be.
   double? maxShortSide,
+
+  /// Function that gets called when the value is changed
   ValueChanged<DateTime>? onChanged,
+
+  /// Function that gets called when the confirm button is pressed
   VoidCallback? onConfirmed,
+
+  /// Function that gets called when the cancel button is pressed
   VoidCallback? onCancelled,
 }) {
   return showDialog<DateTime>(

lib/helpers/show_file_picker.dart

@@ -9,8 +9,14 @@ import 'package:flutter/material.dart';
 /// Allows selection of a file.
 Future<void> showMaterialFilePicker({
   BuildContext? context,
+
+  /// The type of the file to retrieve (filter)
   FileType fileType = FileType.any,
+
+  /// What allowed extensions to look for
   List<String>? allowedExtensions,
+
+  /// Function that gets called when the value is changed
   ValueChanged<PlatformFile>? onChanged,
 }) async {
   FilePickerResult? result = await FilePicker.platform.pickFiles(

lib/helpers/show_number_picker.dart

@@ -9,22 +9,57 @@ import '../flutter_material_pickers.dart';
 /// Allows selection of a number via a slot machine carousel
 Future<int?> showMaterialNumberPicker({
   required BuildContext context,
+
+  /// The title for the dialog box
   String? title,
+
+  /// The lowest or starting number for the selections
   required final int minNumber,
+
+  /// The highest or max number for the selections
   required final int maxNumber,
+
+  /// The number to begin on
   final int? selectedNumber,
+
+  /// The number step, in case you don't to skip ranges.
   final int step = 1,
+
+  /// The dialog header color (overrides theme)
   Color? headerColor,
+
+  /// The dialog header text color (overrides theme)
   Color? headerTextColor,
+
+  /// The dialog background color (overrides theme)
   Color? backgroundColor,
+
+  /// The button text color (overrides theme)
   Color? buttonTextColor,
+
+  /// Text to display in the confirm button
   String? confirmText,
+
+  /// Text to display in the cancel button
   String? cancelText,
+
+  /// Used to restrict how tall the dialog can be.
   double? maxLongSide,
+
+  /// Used to restrict how wide the dialog can be.
   double? maxShortSide,
+
+  /// Function that gets called when the value is changed
   ValueChanged<int>? onChanged,
+
+  /// Function that gets called when the confirm button is pressed
   VoidCallback? onConfirmed,
+
+  /// Function that gets called when the cancel button is pressed
   VoidCallback? onCancelled,
+
+  /// Function that is called when each items renders which can be used to transform the content
+  /// This is helpful, for example, to provide translations to other languages
   Transformer<int>? transformer,
 }) {
   List<int> items = [];

lib/helpers/show_palette_picker.dart

@@ -8,18 +8,44 @@ import 'package:flutter_material_pickers/dialogs/responsive_dialog.dart';
 /// Allows Material palette selection of a color
 Future<Color?> showMaterialPalettePicker({
   required BuildContext context,
+
+  /// The title for the dialog box
   String title = "Pick a color",
+
+  /// The color that is initially selected
   required Color selectedColor,
+
+  /// The dialog header color (overrides theme)
   Color? headerColor,
+
+  /// The dialog header text color (overrides theme)
   Color? headerTextColor,
+
+  /// The dialog background color (overrides theme)
   Color? backgroundColor,
+
+  /// The button text color (overrides theme)
   Color? buttonTextColor,
+
+  /// Text to display in the confirm button
   String? confirmText,
+
+  /// Text to display in the cancel button
   String? cancelText,
+
+  /// Used to restrict how tall the dialog can be.
   double? maxLongSide,
+
+  /// Used to restrict how wide the dialog can be.
   double? maxShortSide,
+
+  /// Function that gets called when the value is changed
   ValueChanged<Color>? onChanged,
+
+  /// Function that gets called when the confirm button is pressed
   VoidCallback? onConfirmed,
+
+  /// Function that gets called when the cancel button is pressed
   VoidCallback? onCancelled,
 }) {
   return showDialog<Color>(

lib/helpers/show_radio_picker.dart

@@ -9,20 +9,51 @@ import '../flutter_material_pickers.dart';
 /// Allows selection of a single from a radio list
 Future<T?> showMaterialRadioPicker<T>({
   required BuildContext context,
+
+  /// The title for the dialog box
   String? title,
+
+  /// The list of items to use with the picker
   required List<T> items,
+
+  /// The item that will be initially selected
   T? selectedItem,
+
+  /// The dialog header color (overrides theme)
   Color? headerColor,
+
+  /// The dialog header text color (overrides theme)
   Color? headerTextColor,
+
+  /// The dialog background color (overrides theme)
   Color? backgroundColor,
+
+  /// The button text color (overrides theme)
   Color? buttonTextColor,
+
+  /// Text to display in the confirm button
   String? confirmText,
+
+  /// Text to display in the cancel button
   String? cancelText,
+
+  /// Used to restrict how tall the dialog can be.
   double? maxLongSide,
+
+  /// Used to restrict how wide the dialog can be.
   double? maxShortSide,
+
+  /// Function that gets called when the value is changed
   ValueChanged<T>? onChanged,
+
+  /// Function that gets called when the confirm button is pressed
   VoidCallback? onConfirmed,
+
+  /// Function that gets called when the cancel button is pressed
   VoidCallback? onCancelled,
+
+  /// Function that is called when each items renders which can be used to transform the content
+  /// This is helpful, for example, to provide translations to other languages
   Transformer<T>? transformer,
 }) {
   return showDialog<T>(