Add output_code

Author: wch

docs/_quartodoc.yml

@@ -158,6 +158,7 @@ quartodoc:
         - ui.output_table
         - ui.output_data_frame
         - ui.output_text
+        - ui.output_code
         - ui.output_text_verbatim
         - ui.output_ui
         - render.plot

shiny/render/_render.py

@@ -126,15 +126,15 @@ class code(Renderer[str]):
 
     When used in Shiny Express applications, this defaults to displaying the text in a
     monospace font in a code block. When used in Shiny Core applications, this should be
-    paired with :func:`~shiny.ui.output_text_verbatim` in the UI.
+    paired with :func:`~shiny.ui.output_code` in the UI.
 
     Parameters
     ----------
     placeholder
         Used in Shiny Express only. If the output is empty or ``None``, should an empty
         rectangle be displayed to serve as a placeholder? This does not affect behavior
         when the output is nonempty. (This argument is passed to
-        :func:`~shiny.ui.output_text_verbatim`.)
+        :func:`~shiny.ui.output_code`.)
 
 
     Returns
@@ -145,13 +145,13 @@ class code(Renderer[str]):
     Tip
     ----
     The name of the decorated function (or ``@output(id=...)``) should match the ``id``
-    of a :func:`~shiny.ui.output_text_verbatim` container (see
-    :func:`~shiny.ui.output_text_verbatim` for example usage).
+    of a :func:`~shiny.ui.output_code` container (see :func:`~shiny.ui.output_code` for
+    example usage).
 
     See Also
     --------
-    ~shiny.render.text
-    ~shiny.ui.output_text_verbatim
+    ~shiny.render.code
+    ~shiny.ui.output_code
     """
 
     def default_ui(
@@ -162,7 +162,7 @@ def default_ui(
     ) -> Tag:
         kwargs: dict[str, bool] = {}
         set_kwargs_value(kwargs, "placeholder", placeholder, self.placeholder)
-        return _ui.output_text_verbatim(id, **kwargs)
+        return _ui.output_code(id, **kwargs)
 
     def __init__(
         self,

shiny/ui/__init__.py

@@ -110,6 +110,7 @@
     output_plot,
     output_image,
     output_text,
+    output_code,
     output_text_verbatim,
     output_table,
     output_ui,
@@ -296,6 +297,7 @@
     "output_plot",
     "output_image",
     "output_text",
+    "output_code",
     "output_text_verbatim",
     "output_table",
     "output_ui",

shiny/ui/_output.py

@@ -4,6 +4,7 @@
     "output_plot",
     "output_image",
     "output_text",
+    "output_code",
     "output_text_verbatim",
     "output_table",
     "output_ui",
@@ -270,6 +271,47 @@ def output_text(
     return container(id=resolve_id(id), class_="shiny-text-output")
 
 
+def output_code(id: str, placeholder: bool = True) -> Tag:
+    """
+    Create a output container for code (monospaced text).
+
+    This is similar to :func:`~shiny.ui.output_text`, except that it displays the text
+    in a fixed-width container with a gray-ish background color and border.
+
+    Parameters
+    ----------
+    id
+        An output id.
+    placeholder
+        If the output is empty or ``None``, should an empty rectangle be displayed to
+        serve as a placeholder? (This does not affect behavior when the output is
+        nonempty.)
+
+    Returns
+    -------
+    :
+        A UI element
+
+    Note
+    ----
+    This function is currently the same as :func:`~shiny.ui.output_text_verbatim`, but
+    this may change in future versions of Shiny.
+
+    See Also
+    --------
+    * :func:`~shiny.render.text`
+    * :func:`~shiny.ui.output_text`
+    * :func:`~shiny.ui.output_text_verbatim`
+
+    Example
+    -------
+    See :func:`~shiny.ui.output_text`
+    """
+
+    cls = "shiny-text-output" + (" noplaceholder" if not placeholder else "")
+    return tags.pre(id=resolve_id(id), class_=cls)
+
+
 def output_text_verbatim(id: str, placeholder: bool = False) -> Tag:
     """
     Create a output container for some text.