Add support and styling for custom <callout-box> HTML tags (#4264)

Author: szakarias

CHANGELOG.md

@@ -1,3 +1,6 @@
+## 9.0.7-wip
+* Add built-in CSS styling for the `<callout-box>` HTML tag.
+
 ## 9.0.6
 * Require analyzer 13.0.2 APIs.
 * Introduce the {@example} directive for embedding external files, with support for extracting specific code blocks via #region tags.

dartdoc_options.yaml

@@ -1,4 +1,4 @@
 dartdoc:
   linkToSource:
     root: '.'
-    uriTemplate: 'https://github.com/dart-lang/dartdoc/blob/v9.0.6/%f%#L%l%'
+    uriTemplate: 'https://github.com/dart-lang/dartdoc/blob/v9.0.7-wip/%f%#L%l%'

lib/resources/docs.dart.js.map

@@ -206,6 +206,7 @@ final _allowedElements = <String>{
   'SPAN',
   'TIME',
   'WBR',
+  'CALLOUT-BOX',
 };
 
 // Inspired by the set of HTML attributes allowed in GFM.

lib/resources/styles.css

@@ -1 +1 @@
-const packageVersion = '9.0.6';
+const packageVersion = '9.0.7';

lib/src/render/documentation_renderer.dart

@@ -1,5 +1,5 @@
 name: dartdoc
-version: 9.0.6
+version: 9.0.7-wip
 description: A non-interactive HTML documentation generator for Dart source code.
 repository: https://github.com/dart-lang/dartdoc
 

lib/src/version.dart

@@ -182,6 +182,7 @@ void main() {
     Class classWithHtml;
     late final Method blockHtml;
     late final Method inlineHtml;
+    late final Method customCalloutBoxHtml;
     late final PackageGraph packageGraph;
     late final Library exLibrary;
 
@@ -198,6 +199,7 @@ void main() {
       classWithHtml = exLibrary.classes.named('SanitizableHtml');
       blockHtml = classWithHtml.instanceMethods.named('blockHtml');
       inlineHtml = classWithHtml.instanceMethods.named('inlineHtml');
+      customCalloutBoxHtml = classWithHtml.instanceMethods.named('customCalloutBoxHtml');
       for (var modelElement in packageGraph.localPublicLibraries
           .expand((l) => l.allModelElements)) {
         // Accessing this getter triggers documentation-processing.
@@ -240,6 +242,10 @@ void main() {
     test('removes bad block HTML', () {
       expect(blockHtml.documentationAsHtml, isNot(contains('bad-idea')));
     });
+
+    test('can have callout-box HTML', () {
+      expect(customCalloutBoxHtml.documentationAsHtml, contains('<callout-box>'));
+    });
   });
 
   group('HTML Injection when allowed', () {

pubspec.yaml

@@ -29,4 +29,9 @@ abstract class SanitizableHtml {
   ///
   /// This is a <a href="javascript:alert('bad-idea');">bad</a> link.
   void inlineHtml();
+
+  /// Tests custom callout-box tags
+  ///
+  /// <callout-box>A fine example</callout-box>
+  void customCalloutBoxHtml();
 }

test/end2end/model_special_cases_test.dart

@@ -1 +1 @@
-67C19593977E0B284E58447F539D330E
+AE937D022C3148CCD0F12D78DF21EA08