Merge remote-tracking branch 'upstream/master' into bugfix/677-swallow-duplicate-ids

Author: erickok

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,46 @@
+---
+name: Bug report
+about: Something isn't working as intended
+title: "[BUG]"
+labels: bug
+assignees: ''
+
+---
+
+<!--- 
+
+Please do not delete this issue template as it helps us organize and easily work on issues!!
+
+NOTE: Before posting, please make sure you have
+ 1. Searched the README
+ 2. Searched the Issues tab for similar bugs
+ 3. Please provide the required information in the template - HTML code and Html widget configuration
+ --->
+
+**Describe the bug:**
+<!--- Please provide a clear and concise description of the bug --->
+
+**HTML to reproduce the issue:**
+<!--- Please provide your HTML code below. If it contains sensitive information please post a minimal reproducible HTML snippet. --->
+
+**`Html` widget configuration:**
+<!--- Please provide your HTML widget configuration below --->
+
+**Expected behavior:**
+<!--- Expected behavior, if applicable, otherwise please delete --->
+
+**Screenshots:**
+<!--- Screenshots can be helpful to analyze your issue. Please delete this section if you don't provide any. --->
+
+**Device details and Flutter/Dart/`flutter_html` versions:**
+<!--- These details can be helpful to analyze your issue. Please delete this section if you don't provide any.  --->
+
+**Stacktrace/Logcat**
+<!--- The error stacktrace if applicable, otherwise please delete --->
+
+**Additional info:**
+<!--- Any other info relevant to the bug, otherwise please delete --->
+
+**A picture of a cute animal (not mandatory but encouraged)**
+<!--- A picture of a cute animal that would nicely complement this bug report. 
+If you don't have one, please delete, just know we will be a little disappointed ;) --->

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,27 @@
+---
+name: Feature request
+about: Suggest an idea for flutter_html
+title: "[FEATURE]"
+labels: enhancement
+assignees: ''
+
+---
+
+<!--- 
+
+Please do not delete this issue template as it helps us organize and easily work on issues!!
+
+NOTE: Before posting, please make sure you have
+ 1. Searched the README
+ 2. Searched the Issues tab for similar feature requests
+ --->
+ 
+**Describe your feature request**
+<!--- Please provide a clear and concise description of the feature request --->
+
+**Additional context**
+<!--- Any other info relevant to the feature request, otherwise please delete --->
+
+**A picture of a cute animal (not mandatory but encouraged)**
+<!--- A picture of a cute animal that would nicely complement this feature request. 
+If you don't have one, please delete, just know we will be a little disappointed ;) --->

.github/ISSUE_TEMPLATE/question.md

@@ -0,0 +1,20 @@
+---
+name: Question
+about: Ask a question about flutter_html
+title: "[QUESTION]"
+labels: question
+assignees: ''
+
+---
+
+<!--- 
+NOTE: Before posting, please make sure you have
+ 1. Searched the README
+ 2. Searched the Issues tab for similar questions
+ --->
+
+Type question here.
+
+**A picture of a cute animal (not mandatory but encouraged)**
+<!--- A picture of a cute animal that would nicely complement this question. 
+If you don't have one, please delete, just know we will be a little disappointed ;) --->

README.md

@@ -123,9 +123,9 @@ Add the following to your `pubspec.yaml` file:
 ## Currently Supported Inline CSS Attributes:
 |                  |        |            |          |              |                        |            |
 |------------------|--------|------------|----------|--------------|------------------------|------------|
-|`background-color`| `border` | `color`| `direction`| `display`| `font-family`| `font-feature-settings` |
-| `font-size`|`font-style`      | `font-weight`| `line-height` | `list-style-type`  | `list-style-position`|`padding`     |
-| `margin`| `text-align`| `text-decoration`| `text-decoration-color`| `text-decoration-style`| `text-shadow` | |
+|`background-color`| `border` (including specific directions) | `color`| `direction`| `display`| `font-family`| `font-feature-settings` |
+| `font-size`|`font-style`      | `font-weight`| `line-height` | `list-style-type`  | `list-style-position`|`padding`  (including specific directions)   |
+| `margin` (including specific directions) | `text-align`| `text-decoration`| `text-decoration-color`| `text-decoration-style`| `text-shadow` | |
 
 Don't see a tag or attribute you need? File a feature request or contribute to the project!
 
@@ -252,6 +252,8 @@ A powerful API that allows you to customize everything when rendering a specific
 
 To use this API, set the key as the tag of the HTML element you wish to provide a custom implementation for, and create a function with the above parameters that returns a `Widget` or `InlineSpan`.
 
+Note: If you add any custom tags, you must add these tags to the [`tagsList`](#tagslist) parameter, otherwise they will not be rendered. See below for an example.
+
 #### Example Usages - customRender:
 1. Simple example - rendering custom HTML tags
 
@@ -276,6 +278,7 @@ Widget html = Html(
         );
       },
     },
+  tagsList: Html.tags..addAll(["bird", "flutter"]),
 );
 ```
 
@@ -304,6 +307,8 @@ Widget html = Html(
 );
 ```
 
+</details>
+
 3. Complex example - rendering an `iframe` differently based on whether it is an embedded youtube video or some other embedded content.
 
 <details><summary>View code</summary>

example/lib/main.dart

@@ -315,6 +315,13 @@ class _MyHomePageState extends State<MyHomePage> {
           onImageError: (exception, stackTrace) {
             print(exception);
           },
+          onCssParseError: (css, messages) {
+            print("css that errored: $css");
+            print("error messages:");
+            messages.forEach((element) {
+              print(element);
+            });
+          },
         ),
       ),
     );

lib/flutter_html.dart

@@ -1,25 +1,38 @@
 library flutter_html;
 
-//export image render api
-export 'package:flutter_html/image_render.dart';
-//export style api
-export 'package:flutter_html/style.dart';
-//export render context api
-export 'package:flutter_html/html_parser.dart';
-//export src for advanced custom render uses (e.g. casting context.tree)
-export 'package:flutter_html/src/layout_element.dart';
-export 'package:flutter_html/src/replaced_element.dart';
-export 'package:flutter_html/src/styled_element.dart';
-export 'package:flutter_html/src/interactable_element.dart';
-
 import 'package:flutter/material.dart';
 import 'package:flutter/rendering.dart';
 import 'package:flutter_html/html_parser.dart';
 import 'package:flutter_html/image_render.dart';
 import 'package:flutter_html/src/html_elements.dart';
 import 'package:flutter_html/style.dart';
-import 'package:webview_flutter/webview_flutter.dart';
 import 'package:html/dom.dart' as dom;
+import 'package:webview_flutter/webview_flutter.dart';
+
+//export render context api
+export 'package:flutter_html/html_parser.dart';
+//export render context api
+export 'package:flutter_html/html_parser.dart';
+//export image render api
+export 'package:flutter_html/image_render.dart';
+//export image render api
+export 'package:flutter_html/image_render.dart';
+export 'package:flutter_html/src/anchor.dart';
+export 'package:flutter_html/src/anchor.dart';
+export 'package:flutter_html/src/interactable_element.dart';
+export 'package:flutter_html/src/interactable_element.dart';
+//export src for advanced custom render uses (e.g. casting context.tree)
+export 'package:flutter_html/src/layout_element.dart';
+//export src for advanced custom render uses (e.g. casting context.tree)
+export 'package:flutter_html/src/layout_element.dart';
+export 'package:flutter_html/src/replaced_element.dart';
+export 'package:flutter_html/src/replaced_element.dart';
+export 'package:flutter_html/src/styled_element.dart';
+export 'package:flutter_html/src/styled_element.dart';
+//export style api
+export 'package:flutter_html/style.dart';
+//export style api
+export 'package:flutter_html/style.dart';
 
 class Html extends StatelessWidget {
   /// The `Html` widget takes HTML as input and displays a RichText
@@ -49,42 +62,46 @@ class Html extends StatelessWidget {
   /// See [its wiki page](https://github.com/Sub6Resources/flutter_html/wiki/Style) for more info.
   Html({
     Key? key,
+    GlobalKey? anchorKey,
     required this.data,
     this.onLinkTap,
     this.customRender = const {},
     this.customImageRenders = const {},
+    this.onCssParseError,
     this.onImageError,
     this.onMathError,
     this.shrinkWrap = false,
     this.onImageTap,
     this.tagsList = const [],
     this.style = const {},
     this.navigationDelegateForIframe,
-  }) : document = null,
-        assert (data != null),
-        anchorKey = GlobalKey(),
+  })  : document = null,
+        assert(data != null),
+        _anchorKey = anchorKey ?? GlobalKey(),
         super(key: key);
 
   Html.fromDom({
     Key? key,
+    GlobalKey? anchorKey,
     @required this.document,
     this.onLinkTap,
     this.customRender = const {},
     this.customImageRenders = const {},
+    this.onCssParseError,
     this.onImageError,
     this.onMathError,
     this.shrinkWrap = false,
     this.onImageTap,
     this.tagsList = const [],
     this.style = const {},
     this.navigationDelegateForIframe,
-  }) : data = null,
+  })  : data = null,
         assert(document != null),
-  anchorKey = GlobalKey(),
+        _anchorKey = anchorKey ?? GlobalKey(),
         super(key: key);
 
   /// A unique key for this Html widget to ensure uniqueness of anchors
-  final Key anchorKey;
+  final GlobalKey _anchorKey;
 
   /// The HTML data passed to the widget as a String
   final String? data;
@@ -99,14 +116,16 @@ class Html extends StatelessWidget {
   /// See the README for more details.
   final Map<ImageSourceMatcher, ImageRender> customImageRenders;
 
+  /// A function that defines what to do when CSS fails to parse
+  final OnCssParseError? onCssParseError;
+
   /// A function that defines what to do when an image errors
   final ImageErrorListener? onImageError;
 
   /// A function that defines what to do when either <math> or <tex> fails to render
   /// You can return a widget here to override the default error widget.
   final OnMathError? onMathError;
 
-
   /// A parameter that should be set when the HTML widget is expected to be
   /// flexible
   final bool shrinkWrap;
@@ -138,16 +157,18 @@ class Html extends StatelessWidget {
 
   @override
   Widget build(BuildContext context) {
-    final dom.Document doc = data != null ? HtmlParser.parseHTML(data!) : document!;
+    final dom.Document doc =
+        data != null ? HtmlParser.parseHTML(data!) : document!;
     final double? width = shrinkWrap ? null : MediaQuery.of(context).size.width;
 
     return Container(
       width: width,
       child: HtmlParser(
-        key: anchorKey,
+        key: _anchorKey,
         htmlData: doc,
         onLinkTap: onLinkTap,
         onImageTap: onImageTap,
+        onCssParseError: onCssParseError,
         onImageError: onImageError,
         onMathError: onMathError,
         shrinkWrap: shrinkWrap,