Allow bypassing HTML content unescaping (#29)

* Allow bypassing HTML content unescaping

* Add minor code improvements

* Bump version. Update changelog

* Document unescapeContent flag

Author: fjwong

CHANGELOG.md

@@ -1,3 +1,6 @@
+## 4.0.1
+* Allow bypassing HTML content unescaping
+
 ## 4.0.0
 * Breaking change, this package now needs a Flutter version >= 3
 * Update dependencies

lib/src/html_stylist.dart

@@ -55,11 +55,23 @@ class HTML {
   ///   },
   /// );
   /// ```
+  ///
+  /// HTML content is unescaped by default before parsing to render escape
+  /// entities contained in the input. For example:
+  /// ```
+  /// <b>2 &times; 4 &#61; 8</b>
+  /// ```
+  ///
+  /// This may result in parsing errors if the input contains escaped angled
+  /// brackets (`&lt;`, `&gt;`). In such cases, automatic unescaping may be
+  /// disabled via the [unescapeContent] flag.
 
-  static TextSpan toTextSpan(BuildContext context, String htmlContent,
-      {Function(dynamic)? linksCallback,
-      Map<String, TextStyle>? overrideStyle,
-      TextStyle? defaultTextStyle}) {
+  static TextSpan toTextSpan(BuildContext context, String htmlContent, {
+    Function(dynamic)? linksCallback,
+    Map<String, TextStyle>? overrideStyle,
+    TextStyle? defaultTextStyle,
+    bool unescapeContent = true,
+  }) {
     // Validating empty content
     if (htmlContent.isEmpty) {
       return const TextSpan();
@@ -73,7 +85,11 @@ class HTML {
     // to fix a known issue with non self closing <br> tags
     content = content.replaceAll('<br>', '<br />');
 
-    final Parser parser = Parser(context, HtmlUnescape().convert(content),
+    if (unescapeContent) {
+      content = HtmlUnescape().convert(content);
+    }
+
+    final Parser parser = Parser(context, content,
         linksCallback: linksCallback,
         overrideStyleMap: overrideStyle ?? <String, TextStyle>{},
         defaultTextStyle: defaultTextStyle);
@@ -120,18 +136,31 @@ class HTML {
   ///   },
   /// );
   /// ```
+  ///
+  /// HTML content is unescaped by default before parsing to render escape
+  /// entities contained in the input. For example:
+  /// ```
+  /// <b>2 &times; 4 &#61; 8</b>
+  /// ```
+  ///
+  /// This may result in parsing errors if the input contains escaped angled
+  /// brackets (`&lt;`, `&gt;`). In such cases, automatic unescaping may be
+  /// disabled via the [unescapeContent] flag.
 
-  static RichText toRichText(BuildContext context, String htmlContent,
-      {Function(dynamic)? linksCallback,
-      Map<String, TextStyle>? overrideStyle,
-      TextStyle? defaultTextStyle}) {
+  static RichText toRichText(BuildContext context, String htmlContent, {
+    Function(dynamic)? linksCallback,
+    Map<String, TextStyle>? overrideStyle,
+    TextStyle? defaultTextStyle,
+    bool unescapeContent = true,
+  }) {
     return RichText(
       text: toTextSpan(
         context,
         htmlContent,
         linksCallback: linksCallback,
         overrideStyle: overrideStyle,
         defaultTextStyle: defaultTextStyle,
+        unescapeContent: unescapeContent,
       ),
     );
   }

pubspec.yaml

@@ -1,6 +1,6 @@
 name: simple_html_css
 description: This package allows you to use simple HTML and inline CSS styles to style your text in flutter. A fork of css_text package.
-version: 4.0.0
+version: 4.0.1
 homepage: https://github.com/ali-thowfeek/simple_html_css_flutter
 repository: https://github.com/ali-thowfeek/simple_html_css_flutter