gfcheckbox tiles change & few components missing comments added

Author: Sandip Kakadiya

lib/components/accordian/gf_accordian.dart

@@ -2,6 +2,7 @@ import 'package:flutter/material.dart';
 import 'package:getwidget/getwidget.dart';
 
 class GFAccordion extends StatefulWidget {
+  /// An accordion is used to show (and hide) content. Use [showAccordion] to hide & show the accordion content.
   const GFAccordion(
       {Key key,
       this.titleChild,

lib/components/animation/gf_animation.dart

@@ -2,6 +2,7 @@ import 'package:flutter/material.dart';
 import 'package:getwidget/types/gf_animation_type.dart';
 
 class GFAnimation extends StatefulWidget {
+  /// Wrap any widget with [GFAnimation] to animate your widget. see [GFAnimationType] for types of animations.
   const GFAnimation({
     Key key,
     this.duration,

lib/components/badge/gf_button_badge.dart

@@ -272,53 +272,3 @@ class _GFButtonBadgeState extends State<GFButtonBadge> {
         ),
       );
 }
-
-//
-//class GFButtonBadge extends GFButton {
-//
-//
-//  Widget build(BuildContext context) => ConstrainedBox(
-//        constraints: const BoxConstraints(
-//          minHeight: 26,
-//          minWidth: 98,
-//        ),
-//        child: Container(
-//          height: size,
-//          child: GFButton(
-//            onPressed: onPressed,
-//            onHighlightChanged: onHighlightChanged,
-//            textStyle: textStyle,
-//            boxShadow: boxShadow,
-//            buttonBoxShadow: badgeBoxShadow,
-//            focusColor: focusColor,
-//            hoverColor: hoverColor,
-//            highlightColor: highlightColor,
-//            splashColor: splashColor,
-//            elevation: elevation,
-//            focusElevation: focusElevation,
-//            hoverElevation: hoverElevation,
-//            highlightElevation: highlightElevation,
-//            disabledElevation: disabledElevation,
-//            constraints: constraints,
-//            borderShape: borderShape,
-//            animationDuration: animationDuration,
-//            clipBehavior: clipBehavior,
-//            focusNode: focusNode,
-//            autofocus: autofocus,
-//            type: type,
-//            shape: shape,
-//            color: color,
-//            textColor: textColor,
-//            position: position,
-//            size: size,
-//            borderSide: borderSide,
-//            text: text,
-//            icon: icon,
-//            blockButton: blockButton,
-//            fullWidthButton: fullWidthButton,
-//            disabledColor: disabledTextColor,
-//            disabledTextColor: disabledColor,
-//          ),
-//        ),
-//      );
-//}

lib/components/badge/gf_icon_badge.dart

@@ -34,9 +34,6 @@ class _GFIconBadgeState extends State<GFIconBadge> {
           children: <Widget>[
             widget.child ?? Container(),
             Positioned(
-              //  top: 2,
-              //  left: 22,
-              right: 0,
               child: widget.counterChild ?? Container(),
             ),
           ],

lib/components/border/gf_border.dart

@@ -5,11 +5,12 @@ import 'package:getwidget/components/border/gf_dashed_border.dart';
 import 'package:getwidget/types/gf_border_type.dart';
 
 class GFBorder extends StatelessWidget {
+  /// Create different types of borders around given child widget
   GFBorder({
     @required this.child,
     this.color = Colors.black,
     this.strokeWidth = 1,
-    this.type = GFBorderType.Rect,
+    this.type = GFBorderType.rect,
     this.dashedLine = const <double>[3, 1],
     this.padding = const EdgeInsets.all(10),
     this.radius = const Radius.circular(0),
@@ -27,7 +28,7 @@ class GFBorder extends StatelessWidget {
   final double strokeWidth;
 
   /// color of type [Color] or GFColor which is used to change the color of the border type
-  final dynamic color;
+  final Color color;
 
   /// dashedLine of type [List<double>] which is used for the linear and simple dashed line of border
   final List<double> dashedLine;

lib/components/border/gf_dashed_border.dart

@@ -9,7 +9,7 @@ class DashedType extends CustomPainter {
     this.strokeWidth = 2,
     this.dashedLine = const <double>[3, 1],
     this.color = Colors.black,
-    this.type = GFBorderType.Rect,
+    this.type = GFBorderType.rect,
     this.radius = const Radius.circular(0),
     this.customPath,
   }) : assert(dashedLine.isNotEmpty, 'dash line cannot be empty');
@@ -21,7 +21,7 @@ class DashedType extends CustomPainter {
   final List<double> dashedLine;
 
   /// color of type [Color] or GFColor which is used to change the color of the border type
-  final dynamic color;
+  final Color color;
 
   /// type of [GFBorderType] which is used to define the different types of borders ie, circle, Rect, RRect and oval
   final GFBorderType type;
@@ -56,20 +56,19 @@ class DashedType extends CustomPainter {
   Path _getPath(Size size) {
     Path path;
     switch (type) {
-      case GFBorderType.Circle:
+      case GFBorderType.circle:
         path = _getCirclePath(size);
         break;
-      case GFBorderType.RRect:
+      case GFBorderType.rRect:
         path = _getRRectPath(size, radius);
         break;
-      case GFBorderType.Rect:
+      case GFBorderType.rect:
         path = _getRectPath(size);
         break;
-      case GFBorderType.Oval:
+      case GFBorderType.oval:
         path = _getOvalPath(size);
         break;
     }
-
     return dashPath(path, dashedarray: CircularIntervalList(dashedLine));
   }
 
@@ -94,7 +93,6 @@ class DashedType extends CustomPainter {
   }
 
   ///  gives a Rounded Rectangular Path with [radius] of [size] for borderType
-
   Path _getRRectPath(Size size, Radius radius) => Path()
     ..addRRect(
       RRect.fromRectAndRadius(
@@ -140,10 +138,8 @@ class DashedType extends CustomPainter {
 
 class CircularIntervalList<T> {
   CircularIntervalList(this.values);
-
   final List<T> values;
   int index = 0;
-
   T get next {
     if (index >= values.length) {
       index = 0;
@@ -159,7 +155,6 @@ Path dashPath(Path source,
   if (source == null) {
     return null;
   }
-
   final Path dest = Path();
   for (final PathMetric metric in source.computeMetrics()) {
     double distance = dashOffset._calculate(metric.length);
@@ -173,27 +168,26 @@ Path dashPath(Path source,
       draw = !draw;
     }
   }
-
   return dest;
 }
 
 /// Specifies the starting position of a dashed array or line  on a path, either as a percentage or absolute
-enum _DashOffsetType { Absolute, Percentage }
+enum _DashOffsetType { absolute, percentage }
 
 class DashOffset {
   ///gives offset of the dashed path that will be measured as a percentage which ranges from 0.0 to 1.0
   DashOffset.percentage(double percentage)
       : _value = percentage.clamp(0.0, 1.0) ?? 0.0,
-        _dashOffsetType = _DashOffsetType.Percentage;
+        _dashOffsetType = _DashOffsetType.percentage;
 
   ///gives offset of the dashed path that will be measured as a absolute value
   const DashOffset.absolute(double start)
       : _value = start ?? 0.0,
-        _dashOffsetType = _DashOffsetType.Absolute;
+        _dashOffsetType = _DashOffsetType.absolute;
 
   final double _value;
   final _DashOffsetType _dashOffsetType;
 
   double _calculate(double length) =>
-      _dashOffsetType == _DashOffsetType.Absolute ? _value : length * _value;
+      _dashOffsetType == _DashOffsetType.absolute ? _value : length * _value;
 }

lib/components/bottom_sheet/gf_bottom_sheet.dart

@@ -2,6 +2,7 @@ import 'dart:async';
 import 'package:flutter/material.dart';
 
 class GFBottomSheet extends StatefulWidget {
+  /// Opens sheet from bottom as a popup on current sheets it has different customization options.
   GFBottomSheet({
     Key key,
     @required this.contentBody,
@@ -122,7 +123,6 @@ class _GFBottomSheetState extends State<GFBottomSheet>
         Theme.of(context).bottomSheetTheme;
     final double elevation =
         widget.elevation ?? bottomSheetTheme.elevation ?? 0;
-
     final Widget bottomSheet = Column(
       mainAxisSize: MainAxisSize.min,
       children: <Widget>[
@@ -246,9 +246,7 @@ class GFBottomSheetController extends ValueNotifier<bool> {
 
   // ignore: unnecessary_getters_setters
   double get height => _height;
-
   bool get isBottomSheetOpened => value;
-
   void hideBottomSheet() => value = false;
   void showBottomSheet() => value = true;
 }