Fix nits and other minor code issues

tneotia · tneotia · commit 056a9b39bf1e · 2021-05-19T18:08:43.000-04:00
diff --git a/README.md b/README.md
@@ -161,15 +161,11 @@ The difference between the two is the same as noted above.
 
 Please note: Due to Flutter [#38474](https://github.com/flutter/flutter/issues/38474), selectable text support is significantly watered down compared to the standard non-selectable version of the widget. The changes are as follows:
 
-1. No support for `customRender`, `customImageRender`, `onImageError`, `onImageTap`, `onMathError`, and `navigationDelegateForIframe`. (Support for `customRender` may be added in the future).
+1. The list of tags that can be rendered is significantly reduced. Key omissions include no support for images/video/audio, table, and ul/ol.
 
-2. You cannot whitelist tags, you must use `blacklistedElements` to remove any tags that shouldn't be rendered. This is to make sure unsupported tags are not accidentally whitelisted, causing errors in the widget code.
+2. No support for `customRender`, `customImageRender`, `onImageError`, `onImageTap`, `onMathError`, and `navigationDelegateForIframe`. (Support for `customRender` may be added in the future).
 
-3. The list of tags that can be rendered is significantly reduced. Key omissions include no support for images/video/audio, table, and ul/ol.
-
-4. Styling support is significantly reduced. Only text-related styling works (e.g. bold or italic), while container related styling (e.g. borders or padding/margin) do not work.
-
-5. Due to the above, the margins between elements no longer appear. As a result, the HTML content will not have proper spacing between elements like `<h1>`. The default margin for `<body>` is removed, so it is recommended to wrap the `Html()` widget in a `Container()` with padding to achieve the same effect.
+3. Styling support is significantly reduced. Only text-related styling works (e.g. bold or italic), while container related styling (e.g. borders or padding/margin) do not work.
 
 Once the above issue is resolved, the aforementioned compromises will go away. Currently the `SelectableText.rich()` constructor does not support `WidgetSpan`s, resulting in the feature losses above.
 
@@ -192,7 +188,7 @@ Once the above issue is resolved, the aforementioned compromises will go away. C
 
 ### Getters:
 
-1. `Html.tags`. This provides a list of all the tags the package renders. The main use case is to assist in blacklisting elements using `tagsList`. See an [example](#example-usage---tagslist---excluding-tags) below.
+1. `Html.tags`. This provides a list of all the tags the package renders. The main use case is to assist in excluding elements using `tagsList`. See an [example](#example-usage---tagslist---excluding-tags) below.
 
 2. `SelectableHtml.tags`. This provides a list of all the tags that can be rendered in selectable mode.
 
@@ -440,7 +436,7 @@ A list of elements the `Html` widget should render. The list should contain the
 #### Example Usage - tagsList - Excluding Tags:
 You may have instances where you can choose between two different types of HTML tags to display the same content. In the example below, the `<video>` and `<iframe>` elements are going to display the same content.
 
-The `blacklistedElements` parameter allows you to change which element is rendered. Iframes can be advantageous because they allow parallel loading - Flutter just has to wait for the webview to be initialized before rendering the page, possibly cutting down on load time. Video can be advantageous because it provides a 100% native experience with Flutter widgets, but it may take more time to render the page. You may know that Flutter webview is a little janky in its current state on Android, so using `blacklistedElements` and a simple condition, you can get the best of both worlds - choose the video widget to render on Android and the iframe webview to render on iOS.
+The `tagsList` parameter allows you to change which element is rendered. Iframes can be advantageous because they allow parallel loading - Flutter just has to wait for the webview to be initialized before rendering the page, possibly cutting down on load time. Video can be advantageous because it provides a 100% native experience with Flutter widgets, but it may take more time to render the page. You may know that Flutter webview is a little janky in its current state on Android, so using `tagsList` and a simple condition, you can get the best of both worlds - choose the video widget to render on Android and the iframe webview to render on iOS.
 
 ```dart
 Widget html = Html(
diff --git a/lib/flutter_html.dart b/lib/flutter_html.dart
@@ -180,7 +180,7 @@ class SelectableHtml extends StatelessWidget {
   /// **onLinkTap** This function is called whenever a link (`<a href>`)
   /// is tapped.
   ///
-  /// **blacklistedElements** Tag names in this array will not be rendered.
+  /// **tagsList** Tag names in this array will be the only tags rendered. By default all tags that support selectable content are rendered.
   ///
   /// **style** Pass in the style information for the Html here.
   /// See [its wiki page](https://github.com/Sub6Resources/flutter_html/wiki/Style) for more info.
@@ -189,28 +189,23 @@ class SelectableHtml extends StatelessWidget {
   ///
   /// There are a few caveats due to Flutter [#38474](https://github.com/flutter/flutter/issues/38474):
   ///
-  /// 1. No support for `customRender`, `customImageRender`, `onImageError`, `onImageTap`, `onMathError`, and `navigationDelegateForIframe`.
-  ///
-  /// 2. You cannot whitelist tags, you must use `blacklistedElements` to remove any tags that shouldn't be rendered.
-  /// This is to make sure unsupported tags are not accidentally whitelisted, causing errors in the widget code.
-  ///
-  /// 3. The list of tags that can be rendered is significantly reduced.
+  /// 1. The list of tags that can be rendered is significantly reduced.
   /// Key omissions include no support for images/video/audio, table, and ul/ol because they all require widgets and `WidgetSpan`s.
   ///
-  /// 4. Styling support is significantly reduced. Only text-related styling works
+  /// 2. No support for `customRender`, `customImageRender`, `onImageError`, `onImageTap`, `onMathError`, and `navigationDelegateForIframe`.
+  ///
+  /// 3. Styling support is significantly reduced. Only text-related styling works
   /// (e.g. bold or italic), while container related styling (e.g. borders or padding/margin)
   /// do not work because we can't use the `ContainerSpan` class (it needs an enclosing `WidgetSpan`).
-  ///
-  /// 5. Due to the above, the margins between elements no longer appear.
-  /// As a result, the HTML content will not have proper spacing between elements like `h1`. The default margin for `body` is removed as well.
+
   SelectableHtml({
     Key? key,
     required this.data,
     this.onLinkTap,
     this.onCssParseError,
     this.shrinkWrap = false,
     this.style = const {},
-    this.blacklistedElements = const [],
+    this.tagsList = const [],
   }) : document = null,
         super(key: key);
 
@@ -221,7 +216,7 @@ class SelectableHtml extends StatelessWidget {
     this.onCssParseError,
     this.shrinkWrap = false,
     this.style = const {},
-    this.blacklistedElements = const [],
+    this.tagsList = const [],
   }) : data = null,
         super(key: key);
 
@@ -242,7 +237,7 @@ class SelectableHtml extends StatelessWidget {
   final bool shrinkWrap;
 
   /// A list of HTML tags that defines what elements are not rendered
-  final List<String> blacklistedElements;
+  final List<String> tagsList;
 
   /// An API that allows you to override the default style for any HTML element
   final Map<String, Style> style;
@@ -270,7 +265,7 @@ class SelectableHtml extends StatelessWidget {
         customRender: {},
         imageRenders: {}
           ..addAll(defaultImageRenders),
-        tagsList: SelectableHtml.tags..removeWhere((element) => (blacklistedElements).contains(element)),
+        tagsList: tagsList.isEmpty ? SelectableHtml.tags : tagsList,
         navigationDelegateForIframe: null,
       ),
     );
diff --git a/lib/html_parser.dart b/lib/html_parser.dart
@@ -304,7 +304,7 @@ class HtmlParser extends StatelessWidget {
       tree: tree,
       style: context.style.copyOnlyInherited(tree.style),
     );
-    List<int> indices = [];
+    List<int> lineEndingIndices = [];
     tree.children.forEachIndexed((index, element) {
       //we want the element to be a block element, but we don't want to add
       //new-lines before/after the html and body
@@ -315,17 +315,17 @@ class HtmlParser extends StatelessWidget {
         //if the parent element is body and the element is first, we don't want
         //to add a new-line before
         if (index == 0 && element.element?.parent?.localName == "body") {
-          indices.add(index + 1);
+          lineEndingIndices.add(index + 1);
         } else {
-          indices.addAll([index, index + 1]);
+          lineEndingIndices.addAll([index, index + 1]);
         }
       }
     });
     //we don't need a new-line at the end
-    if (indices.isNotEmpty && indices.last == tree.children.length) {
-      indices.removeLast();
+    if (lineEndingIndices.isNotEmpty && lineEndingIndices.last == tree.children.length) {
+      lineEndingIndices.removeLast();
     }
-    indices = indices.toSet().toList();
+    lineEndingIndices = lineEndingIndices.toSet().toList();
     if (customRender.containsKey(tree.name)) {
       final render = customRender[tree.name]!.call(
         newContext,
@@ -359,7 +359,7 @@ class HtmlParser extends StatelessWidget {
         final children = tree.children.map((tree) => parseTree(newContext, tree)).toList();
         //use provided indices to insert new-lines at those locations
         //makes sure to account for list size changes with "+ i"
-        indices.forEachIndexed((i, element) {
+        lineEndingIndices.forEachIndexed((i, element) {
           children.insert(element + i, TextSpan(text: "\n"));
         });
         return TextSpan(
@@ -927,16 +927,13 @@ class StyledText extends StatelessWidget {
   @override
   Widget build(BuildContext context) {
     if (_selectable) {
-      return SizedBox(
-        width: calculateWidth(style.display, renderContext),
-        child: SelectableText.rich(
-          textSpan as TextSpan,
-          style: style.generateTextStyle(),
-          textAlign: style.textAlign,
-          textDirection: style.direction,
-          textScaleFactor: textScaleFactor,
-          maxLines: style.maxLines,
-        ),
+      return SelectableText.rich(
+        textSpan as TextSpan,
+        style: style.generateTextStyle(),
+        textAlign: style.textAlign,
+        textDirection: style.direction,
+        textScaleFactor: textScaleFactor,
+        maxLines: style.maxLines,
       );
     }
     return SizedBox(
