🐛 [HTML] Fix support to styled strings

Author: ronisbr

Project.toml

@@ -32,6 +32,7 @@ julia = "1.10"
 
 [extras]
 OffsetArrays = "6fe1bfb0-de20-5000-8ca7-80f57d26f881"
+StyledStrings = "f489334b-da3d-4c2e-b8f0-e476e12c162b"
 Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
 
 [targets]

src/backends/html/render_cell.jl

@@ -29,7 +29,14 @@ function _html__cell_to_str(cell::Any, context::IOContext, ::Val{:show})
 end
 
 function _html__cell_to_str(cell::AbstractString, context::IOContext, ::Val{:show})
-    return string(cell)
+    if showable(MIME("text/html"), cell)
+        # This code handles, for example, StyledStrings.jl objects.
+        cell_str = sprint(show, MIME("text/html"), cell; context)
+    else
+        cell_str = string(cell)
+    end
+
+    return cell_str
 end
 
 _html__cell_to_str(cell::HTML, context::IOContext, ::Val{:print}) = cell.content
@@ -63,8 +70,27 @@ function _html__render_cell(
     # Check if we need to replace `\n` with `<br>`.
     replace_newline = line_breaks
 
-    # If the cell type is `HTML`, we should not escape the string.
-    cell isa HTML && return cell_str
+    # If the user wants HTML code inside cell, we must not escape the HTML characters.
+    return _html__escape_str(cell_str, replace_newline, !allow_html_in_cells)
+end
+
+function _html__render_cell(
+    cell::AbstractString,
+    context::IOContext,
+    renderer::Union{Val{:print}, Val{:show}};
+    allow_html_in_cells::Bool = false,
+    line_breaks::Bool = false,
+)
+    cell_str = _html__cell_to_str(cell, context, renderer)
+
+    # Check if we need to replace `\n` with `<br>`.
+    replace_newline = line_breaks
+
+    # If the string is showable as HTML, we assume it contains HTML code and we do not
+    # escape it.
+    if showable(MIME("text/html"), cell)
+        allow_html_in_cells = true
+    end
 
     # If the user wants HTML code inside cell, we must not escape the HTML characters.
     return _html__escape_str(cell_str, replace_newline, !allow_html_in_cells)

test/backends/html/issues.jl

@@ -0,0 +1,73 @@
+## Description #############################################################################
+#
+# HTML Back End: Issues.
+#
+############################################################################################
+
+@testset "Issues" verbose = true begin
+    @testset "StyledStrings Support" begin
+        A = [
+            (1, 1)                          styled"({red:2}, {blue:3})"
+            styled"({green:2}, {yellow:3})" "(2, 4)"
+        ]
+
+        expected = """
+<table>
+  <thead>
+    <tr class = "columnLabelRow">
+      <th style = "text-align: right; font-weight: bold;"><Column 1></th>
+      <th style = "text-align: right; font-weight: bold;"><Column 2></th>
+    </tr>
+  </thead>
+  <tbody>
+    <tr class = "dataRow">
+      <td style = "text-align: right;">(1, 1)</td>
+      <td style = "text-align: right;">(2, 3)</td>
+    </tr>
+    <tr class = "dataRow">
+      <td style = "text-align: right;">(2, 3)</td>
+      <td style = "text-align: right;">(2, 4)</td>
+    </tr>
+  </tbody>
+</table>
+"""
+
+        result = pretty_table(
+            String,
+            A;
+            backend       = :html,
+            column_labels = [styled"<{red:Column 1}>", "<Column 2>"]
+        )
+
+        @test result == expected
+
+        expected = """
+<table>
+  <thead>
+    <tr class = "columnLabelRow">
+      <th style = "text-align: right; font-weight: bold;">&lt;<span style="color: #a51c2c">Column 1</span>&gt;</th>
+      <th style = "text-align: right; font-weight: bold;">&lt;Column 2&gt;</th>
+    </tr>
+  </thead>
+  <tbody>
+    <tr class = "dataRow">
+      <td style = "text-align: right;">(1, 1)</td>
+      <td style = "text-align: right;">(<span style="color: #a51c2c">2</span>, <span style="color: #195eb3">3</span>)</td>
+    </tr>
+    <tr class = "dataRow">
+      <td style = "text-align: right;">(<span style="color: #25a268">2</span>, <span style="color: #e5a509">3</span>)</td>
+      <td style = "text-align: right;">(2, 4)</td>
+    </tr>
+  </tbody>
+</table>
+"""
+
+        result = pretty_table(
+            String,
+            A;
+            backend       = :html,
+            column_labels = [styled"<{red:Column 1}>", "<Column 2>"],
+            renderer      = :show
+        )
+    end
+end

test/runtests.jl

@@ -1,9 +1,10 @@
 using Test
 using PrettyTables
 
+using LaTeXStrings
 using Markdown
 using OffsetArrays
-using LaTeXStrings
+using StyledStrings
 using Tables
 
 ############################################################################################
@@ -24,14 +25,15 @@ end
 
 @testset "HTML Back End Tests" verbose = true begin
     include("./backends/html/alignment.jl")
-    include("./backends/html/circular_reference.jl")
     include("./backends/html/cell_titles.jl")
+    include("./backends/html/circular_reference.jl")
     include("./backends/html/column_width.jl")
     include("./backends/html/cropping.jl")
     include("./backends/html/default.jl")
     include("./backends/html/divs.jl")
     include("./backends/html/full.jl")
     include("./backends/html/highlighters.jl")
+    include("./backends/html/issues.jl")
     include("./backends/html/minify.jl")
     include("./backends/html/offset_arrays.jl")
     include("./backends/html/renderers.jl")