v0.0.2

Author: iamSahdeep

CHANGELOG.md

@@ -1,3 +1,10 @@
+
+## 0.0.2
+
+* Included LinkRender
+* Separated TextRenderer
+* Route Observers to remove Element from html
+
 ## 0.0.1
 
-* TODO: Describe initial release.
+* Initial Release

lib/helpers/utils.dart

@@ -1,11 +1,13 @@
 import 'package:flutter/material.dart';
 
-final RouteObserver<ModalRoute<void>> routeObserver = RouteObserver<ModalRoute<void>>();
+/// [RouteObserver] created to remove Element in case pop in [RouteAware]
+final RouteObserver<ModalRoute<void>> routeObserver =
+    RouteObserver<ModalRoute<void>>();
 
 ///Regex to detect Crawler for Search Engines
 RegExp regExpBots = RegExp(r'/bot|google|baidu|bing|msn|teoma|slurp|yandex/i');
 
-/// A GlobalKey Extension to get Rect from the RenderObject from a GlobalKey
+/// A [GlobalKey] Extension to get Rect from the RenderObject from a GlobalKey
 extension GlobalKeyExtension on GlobalKey {
   Rect? get globalPaintBounds {
     final renderObject = currentContext?.findRenderObject();
@@ -19,8 +21,8 @@ extension GlobalKeyExtension on GlobalKey {
   }
 }
 
-
 ///Controller class to refresh the position in case of Scrolling
+///[refresh] method to reposition the html tags in case widget is displaced somewhere.
 class RenderController {
   late VoidCallback refresh;
-}
+}

lib/renderers/link_renderer.dart

@@ -1,14 +1,20 @@
 import 'dart:html';
 
 import 'package:flutter/material.dart';
-import 'package:seo_renderer/renderers/text_renderer.dart';
 import 'package:seo_renderer/helpers/utils.dart';
 
-/// A Widget to create the HTML Tags from the TEXT widget.
+/// A Widget to create the HTML Tags but with Link (href) from any [Widget].
 class LinkRenderer extends StatefulWidget {
+  ///Any Widget with link in it
   final Widget child;
+
+  ///Anchor Text just like html, will work like a replacement to provided [child] with [link] to it.
   final String anchorText;
+
+  ///link to put in href
   final String link;
+
+  ///Optional : [RenderController] object if you want to perform certain actions.
   final RenderController? controller;
 
   const LinkRenderer(
@@ -43,7 +49,7 @@ class _LinkRendererState extends State<LinkRenderer> with RouteAware {
   void initState() {
     super.initState();
     WidgetsBinding.instance
-        ?.addPostFrameCallback((_) => addDivElement(context));
+        ?.addPostFrameCallback((_) => _addDivElement(context));
     widget.controller?.refresh = refresh;
   }
 
@@ -69,7 +75,7 @@ class _LinkRendererState extends State<LinkRenderer> with RouteAware {
     );
   }
 
-  addDivElement(BuildContext context) {
+  _addDivElement(BuildContext context) {
     if (!regExpBots.hasMatch(window.navigator.userAgent.toString())) {
       return;
     }

lib/renderers/text_renderer.dart

@@ -4,7 +4,10 @@ import 'package:seo_renderer/helpers/utils.dart';
 
 /// A Widget to create the HTML Tags from the TEXT widget.
 class TextRenderer extends StatefulWidget {
+  /// Provide with [Text] widget to get data from it.
   final Text text;
+
+  /// Controller to refresh position in any case you want.
   final RenderController? controller;
 
   const TextRenderer({Key? key, required this.text, this.controller})

lib/seo_renderer.dart

@@ -1,3 +1,3 @@
 export 'renderers/text_renderer.dart';
 export 'renderers/link_renderer.dart';
-export 'helpers/utils.dart';
+export 'helpers/utils.dart';

pubspec.yaml

@@ -1,6 +1,6 @@
 name: seo_renderer
 description: A flutter plugin to render text widgets as html for SEO purpose.
-version: 0.0.1
+version: 0.0.2
 homepage: https://github.com/iamSahdeep/seo_renderer
 
 environment: