adding descriptions to variables

Author: shravyackm

example/lib/main.dart

@@ -10,11 +10,29 @@ class MyApp extends StatelessWidget {
   Widget build(BuildContext context) => MaterialApp(
         title: 'GetWidget',
         debugShowCheckedModeBanner: false,
-        home: MyHomePage(),
+        home: GF(),
       );
 }
 
-//
+class GF extends StatefulWidget {
+  @override
+  _GFState createState() => _GFState();
+}
+
+class _GFState extends State<GF> {
+  @override
+  Widget build(BuildContext context) {
+    return Scaffold(
+        body: Container(
+      child: GFBorder(
+        child: Text('gvhjnk'),
+        type: GFBorderType.Oval,
+        dashedLine: [2, 2],
+      ),
+    ));
+  }
+}
+
 class MyHomePage extends StatefulWidget {
   @override
   _MyHomePageState createState() => _MyHomePageState();

example/pubspec.lock

@@ -1,69 +1,69 @@
 # Generated by pub
 # See https://dart.dev/tools/pub/glossary#lockfile
 packages:
-  archive:
+  async:
     dependency: transitive
     description:
-      name: archive
+      name: async
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "2.0.11"
-  args:
+    version: "2.5.0-nullsafety"
+  boolean_selector:
     dependency: transitive
     description:
-      name: args
+      name: boolean_selector
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "1.5.2"
-  async:
+    version: "2.1.0-nullsafety"
+  characters:
     dependency: transitive
     description:
-      name: async
+      name: characters
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "2.4.0"
-  boolean_selector:
+    version: "1.1.0-nullsafety.2"
+  charcode:
     dependency: transitive
     description:
-      name: boolean_selector
+      name: charcode
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "1.0.5"
-  charcode:
+    version: "1.2.0-nullsafety"
+  clock:
     dependency: transitive
     description:
-      name: charcode
+      name: clock
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "1.1.2"
+    version: "1.1.0-nullsafety"
   collection:
     dependency: transitive
     description:
       name: collection
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "1.14.11"
+    version: "1.15.0-nullsafety.2"
   convert:
     dependency: transitive
     description:
       name: convert
       url: "https://pub.dartlang.org"
     source: hosted
     version: "2.1.1"
-  crypto:
-    dependency: transitive
-    description:
-      name: crypto
-      url: "https://pub.dartlang.org"
-    source: hosted
-    version: "2.1.3"
   cupertino_icons:
     dependency: "direct main"
     description:
       name: cupertino_icons
       url: "https://pub.dartlang.org"
     source: hosted
     version: "0.1.3"
+  fake_async:
+    dependency: transitive
+    description:
+      name: fake_async
+      url: "https://pub.dartlang.org"
+    source: hosted
+    version: "1.1.0-nullsafety"
   flutter:
     dependency: "direct main"
     description: flutter
@@ -75,7 +75,7 @@ packages:
       name: flutter_svg
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "0.17.1"
+    version: "0.18.1"
   flutter_test:
     dependency: "direct dev"
     description: flutter
@@ -93,76 +93,55 @@ packages:
       relative: true
     source: path
     version: "1.1.3"
-  image:
-    dependency: transitive
-    description:
-      name: image
-      url: "https://pub.dartlang.org"
-    source: hosted
-    version: "2.1.4"
   matcher:
     dependency: transitive
     description:
       name: matcher
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "0.12.6"
+    version: "0.12.10-nullsafety"
   meta:
     dependency: transitive
     description:
       name: meta
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "1.1.8"
+    version: "1.3.0-nullsafety.2"
   path:
     dependency: transitive
     description:
       name: path
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "1.6.4"
+    version: "1.8.0-nullsafety"
   path_drawing:
     dependency: transitive
     description:
       name: path_drawing
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "0.4.1"
+    version: "0.4.1+1"
   path_parsing:
     dependency: transitive
     description:
       name: path_parsing
       url: "https://pub.dartlang.org"
     source: hosted
     version: "0.1.4"
-  pedantic:
-    dependency: transitive
-    description:
-      name: pedantic
-      url: "https://pub.dartlang.org"
-    source: hosted
-    version: "1.8.0+1"
   petitparser:
     dependency: transitive
     description:
       name: petitparser
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "2.4.0"
+    version: "3.0.4"
   plugin_platform_interface:
     dependency: transitive
     description:
       name: plugin_platform_interface
       url: "https://pub.dartlang.org"
     source: hosted
     version: "1.0.1"
-  quiver:
-    dependency: transitive
-    description:
-      name: quiver
-      url: "https://pub.dartlang.org"
-    source: hosted
-    version: "2.0.5"
   sky_engine:
     dependency: transitive
     description: flutter
@@ -174,49 +153,49 @@ packages:
       name: source_span
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "1.5.5"
+    version: "1.8.0-nullsafety"
   stack_trace:
     dependency: transitive
     description:
       name: stack_trace
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "1.9.3"
+    version: "1.10.0-nullsafety"
   stream_channel:
     dependency: transitive
     description:
       name: stream_channel
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "2.0.0"
+    version: "2.1.0-nullsafety"
   string_scanner:
     dependency: transitive
     description:
       name: string_scanner
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "1.0.5"
+    version: "1.1.0-nullsafety"
   term_glyph:
     dependency: transitive
     description:
       name: term_glyph
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "1.1.0"
+    version: "1.2.0-nullsafety"
   test_api:
     dependency: transitive
     description:
       name: test_api
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "0.2.11"
+    version: "0.2.19-nullsafety"
   typed_data:
     dependency: transitive
     description:
       name: typed_data
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "1.1.6"
+    version: "1.3.0-nullsafety.2"
   url_launcher:
     dependency: "direct main"
     description:
@@ -251,14 +230,14 @@ packages:
       name: vector_math
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "2.0.8"
+    version: "2.1.0-nullsafety.2"
   xml:
     dependency: transitive
     description:
       name: xml
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "3.5.0"
+    version: "4.2.0"
 sdks:
-  dart: ">=2.4.0 <3.0.0"
-  flutter: ">=1.12.8 <2.0.0"
+  dart: ">=2.10.0-0.0.dev <2.10.0"
+  flutter: ">=1.18.0-6.0.pre <2.0.0"

example/pubspec.yaml

@@ -12,7 +12,7 @@ dependencies:
   getwidget:
     path: ../
   cupertino_icons: ^0.1.2
-  flutter_svg: ^0.17.1
+  flutter_svg: ^0.18.0
   url_launcher: ^5.4.1
 
 dev_dependencies:

lib/components/border/gf_border.dart

@@ -0,0 +1,76 @@
+import 'dart:ui';
+import 'package:flutter/material.dart';
+import 'package:getwidget/components/border/gf_dashed_border.dart';
+import 'package:getwidget/types/gf_border_type.dart';
+
+class GFBorder extends StatelessWidget {
+  GFBorder({
+    @required this.child,
+    this.color = Colors.black,
+    this.strokeWidth = 1,
+    this.type = GFBorderType.Rect,
+    this.dashedLine = const <double>[3, 1],
+    this.padding = const EdgeInsets.all(10),
+    this.radius = const Radius.circular(0),
+    this.customPath,
+  })  : assert(child != null),
+        assert(_isValiddashedLine(dashedLine), 'Invalid dash pattern');
+
+  /// child of  type [Widget] which can be any component or text , etc
+  final Widget child;
+
+  /// padding of time [EdgeInsets] where in padding is given to the border types
+  final EdgeInsets padding;
+
+  /// storkeWidth of type [double] which is used to define the thickness of the border
+  final double strokeWidth;
+
+  /// color of type [Color] or GFColor which is used to change the color of the border type
+  final Color color;
+
+  /// dashedLine of type [List<double>] which is used for the linear and simple dashed line of border
+  final List<double> dashedLine;
+
+  /// type of [GFBorderType] which is used to define the different types of borders ie, circle, Rect, RRect and oval
+  final GFBorderType type;
+
+  /// radius of type [Radius] used to give a curved border only when the border type is RRect, in other cases radius will not work
+  final Radius radius;
+
+  /// customPath of type [PathBuilder] used for drawing the paths
+  final PathBuilder customPath;
+
+  @override
+  Widget build(BuildContext context) => Stack(
+        children: <Widget>[
+          Positioned.fill(
+            child: CustomPaint(
+              painter: DashedType(
+                strokeWidth: strokeWidth,
+                radius: radius,
+                color: color,
+                type: type,
+                dashedLine: dashedLine,
+                customPath: customPath,
+              ),
+            ),
+          ),
+          Container(padding: padding, child: child),
+        ],
+      );
+}
+
+/// the value of dashedLine cannot be 0 or null, it should have some definite and proper value
+bool _isValiddashedLine(List<double> dash) {
+  final Set<double> _dashSet = dash.toSet();
+  if (_dashSet == null) {
+    return false;
+  }
+  if (_dashSet.length == 1 && _dashSet.elementAt(0) == 0.0) {
+    return false;
+  }
+  if (_dashSet.isEmpty) {
+    return false;
+  }
+  return true;
+}