Merge pull request #138 from rstudio/panel-title-fix

posit-dev · Apr 27, 2022 · 4b81a12 · 4b81a12
2 parents b4ec4fe + 893cf99
commit 4b81a12
Show file tree

Hide file tree

Showing 4 changed files with 91 additions and 33 deletions.
diff --git a/shiny/ui/_bootstrap.py b/shiny/ui/_bootstrap.py
@@ -37,7 +37,7 @@
 
 from .._docstring import add_example
 from ._html_dependencies import jqui_deps
-from ._page import get_window_title
+from ._utils import get_window_title
 
 
 # TODO: make a python version of the layout guide?

diff --git a/shiny/ui/_page.py b/shiny/ui/_page.py
@@ -6,28 +6,26 @@
 )
 
 import sys
-from typing import Optional, Any, List, Union, cast
-from warnings import warn
+from typing import Optional, Any, Union
 
 if sys.version_info >= (3, 8):
     from typing import Literal
 else:
     from typing_extensions import Literal
 
 from htmltools import (
-    HTMLDependency,
     tags,
     Tag,
     TagList,
     div,
     TagChildArg,
-    head_content,
 )
 
 from .._docstring import add_example
 from ._html_dependencies import bootstrap_deps
 from ._navs import navs_bar
 from ..types import MISSING, MISSING_TYPE
+from ._utils import get_window_title
 
 
 def page_navbar(
@@ -127,24 +125,6 @@ def page_navbar(
     )
 
 
-def get_window_title(
-    title: Optional[Union[str, Tag, TagList]],
-    window_title: Union[str, MISSING_TYPE] = MISSING,
-) -> Optional[HTMLDependency]:
-    if title is not None and isinstance(window_title, MISSING_TYPE):
-        # Try to infer window_title from contents of title
-        window_title = " ".join(_find_characters(title))
-        if not window_title:
-            warn(
-                "Unable to infer a `window_title` default from `title`. Consider providing a character string to `window_title`."
-            )
-
-    if isinstance(window_title, MISSING_TYPE):
-        return None
-    else:
-        return head_content(tags.title(window_title))
-
-
 @add_example()
 def page_fluid(
     *args: Any, title: Optional[str] = None, lang: Optional[str] = None, **kwargs: str
@@ -254,12 +234,3 @@ def page_bootstrap(
     page = TagList(*bootstrap_deps(), *args)
     head = tags.title(title) if title else None
     return tags.html(tags.head(head), tags.body(page), lang=lang)
-
-
-def _find_characters(x: Any) -> List[str]:
-    if isinstance(x, str):
-        return [x]
-    elif isinstance(x, list):
-        return [y for y in cast(List[Any], x) if isinstance(y, str)]
-    else:
-        return []
diff --git a/shiny/ui/_utils.py b/shiny/ui/_utils.py
@@ -1,6 +1,42 @@
-from htmltools import tags, Tag, TagChildArg
+from typing import Optional, Union
+
+from htmltools import (
+    tags,
+    Tag,
+    TagList,
+    TagChildArg,
+    TagChild,
+    HTMLDependency,
+    head_content,
+)
+
+from ..types import MISSING, MISSING_TYPE
 
 
 def shiny_input_label(id: str, label: TagChildArg = None) -> Tag:
     cls = "control-label" + ("" if label else " shiny-label-null")
     return tags.label(label, class_=cls, id=id + "-label", for_=id)
+
+
+def get_window_title(
+    title: Optional[Union[str, Tag, TagList]],
+    window_title: Union[str, MISSING_TYPE] = MISSING,
+) -> Optional[HTMLDependency]:
+    if title is not None and isinstance(window_title, MISSING_TYPE):
+        window_title = _find_child_strings(title)
+
+    if isinstance(window_title, MISSING_TYPE):
+        return None
+    else:
+        return head_content(tags.title(window_title))
+
+
+def _find_child_strings(x: Union[Tag, TagList, TagChild]) -> str:
+    if isinstance(x, Tag) and x.name not in ("script", "style"):
+        x = x.children
+    if isinstance(x, TagList):
+        strings = [_find_child_strings(y) for y in x]
+        return " ".join(filter(lambda x: x != "", strings))
+    if isinstance(x, str):
+        return x
+    return ""
diff --git a/tests/test_ui.py b/tests/test_ui.py
@@ -0,0 +1,51 @@
+import textwrap
+
+from shiny import ui
+from htmltools import HTMLDocument, TagList, tags
+
+
+def test_panel_title():
+    x = HTMLDocument(ui.panel_title("Hello Shiny UI")).render()["html"]
+    assert x == textwrap.dedent(
+        """\
+        <!DOCTYPE html>
+        <html>
+          <head>
+            <meta charset="utf-8"/>
+            <script type="application/html-dependencies">headcontent_648f698a6bce952fe1b165140306e01f4da9e164[0.0]</script>
+            <title>Hello Shiny UI</title>
+          </head>
+          <body>
+            <h2>Hello Shiny UI</h2>
+          </body>
+        </html>"""
+    )
+
+    title = TagList(
+        tags.h1("A title"),
+        tags.script("foo"),
+        tags.style("foo"),
+        tags.h5(tags.script("foo"), "A subtitle"),
+    )
+
+    x = HTMLDocument(ui.panel_title(title)).render()["html"]
+    assert x == textwrap.dedent(
+        """\
+        <!DOCTYPE html>
+        <html>
+          <head>
+            <meta charset="utf-8"/>
+            <script type="application/html-dependencies">headcontent_9e055af8ef9fa0fb1ba72eeba8053498fbc0d075[0.0]</script>
+            <title>A title A subtitle</title>
+          </head>
+          <body>
+            <h1>A title</h1>
+            <script>foo</script>
+            <style>foo</style>
+            <h5>
+              <script>foo</script>
+              A subtitle
+            </h5>
+          </body>
+        </html>"""
+    )