Add output_code UI component and tests

Author: karangattu

shiny/api-examples/output_code/app-core.py

@@ -0,0 +1,29 @@
+from shiny import App, Inputs, Outputs, Session, render, ui
+
+app_ui = ui.page_fluid(
+    ui.input_text_area(
+        "source",
+        "Enter code to display below:",
+        "print('Hello, Shiny!')\nfor i in range(3):\n    print(i)",
+        rows=8,
+    ),
+    ui.card(
+        ui.output_code("code_default"),
+    ),
+    ui.card(
+        ui.output_code("code_no_placeholder", placeholder=False),
+    ),
+)
+
+
+def server(input: Inputs, output: Outputs, session: Session):
+    @render.code
+    def code_default():
+        return input.source()
+
+    @render.code
+    def code_no_placeholder():
+        return input.source()
+
+
+app = App(app_ui, server)

shiny/api-examples/output_code/app-express.py

@@ -0,0 +1,21 @@
+from shiny.express import input, output_args, render, ui
+
+ui.input_text_area(
+    "source",
+    "Enter code to display below:",
+    "print('Hello, Shiny!')\nfor i in range(3):\n    print(i)",
+    rows=8,
+)
+
+with ui.card():
+
+    @render.code
+    def code_default():
+        return input.source()
+
+
+with ui.card():
+
+    @render.code(placeholder=False)
+    def code_no_placeholder():
+        return input.source()

shiny/ui/_output.py

@@ -14,7 +14,7 @@
 
 from htmltools import Tag, TagAttrValue, TagFunction, css, div, tags
 
-from .._docstring import add_example, no_example
+from .._docstring import add_example
 from ..module import resolve_id
 from ..types import MISSING, MISSING_TYPE
 from ._plot_output_opts import (
@@ -271,7 +271,7 @@ def output_text(
     return container(id=resolve_id(id), class_="shiny-text-output")
 
 
-@no_example()
+@add_example()
 def output_code(id: str, placeholder: bool = True) -> Tag:
     """
     Create a output container for code (monospaced text).
@@ -304,9 +304,6 @@ def output_code(id: str, placeholder: bool = True) -> Tag:
     * :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 "")

tests/playwright/shiny/outputs/test_output_code.py

@@ -0,0 +1,29 @@
+from conftest import create_doc_example_core_fixture
+from playwright.sync_api import Page
+
+from shiny.playwright import controller
+from shiny.run import ShinyAppProc
+
+app = create_doc_example_core_fixture("output_code")
+
+
+def test_output_code_kitchen(page: Page, app: ShinyAppProc) -> None:
+    page.goto(app.url)
+
+    source = controller.InputTextArea(page, "source")
+    code_default = controller.OutputCode(page, "code_default")
+    code_no_placeholder = controller.OutputCode(page, "code_no_placeholder")
+
+    source.set("")
+
+    code_default.expect_value("")
+    code_default.expect_has_placeholder(True)
+
+    code_no_placeholder.expect_value("")
+    code_no_placeholder.expect_has_placeholder(False)
+
+    new_value = "print('testing output_code')\nfor i in range(2):\n    print(i)"
+    source.set(new_value)
+
+    code_default.expect_value(new_value)
+    code_no_placeholder.expect_value(new_value)