Add some examples (not finished)

Author: schloerke

docs/_quartodoc-core.yml

@@ -104,7 +104,6 @@ quartodoc:
         - ui.input_bookmark_button
         - bookmark.restore_input
         - bookmark.Bookmark
-        - session.Session.bookmark.exclude
         - bookmark.BookmarkState
         - bookmark.RestoreState
         - kind: page

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

@@ -0,0 +1,33 @@
+from starlette.requests import Request
+
+from shiny import App, Inputs, Outputs, Session, reactive, render, ui
+
+
+# App UI **must** be a function to ensure that each user restores their own UI values.
+def app_ui(request: Request):
+    return ui.page_fluid(
+        ui.markdown(
+            "Directions: "
+            "\n1. Change the radio button selection below"
+            "\n2. Save the bookmark."
+            "\n3. Then, refresh your browser page to see the radio button selection has been restored."
+        ),
+        ui.hr(),
+        ui.input_radio_buttons("letter", "Choose a letter", choices=["A", "B", "C"]),
+        ui.input_bookmark_button(label="Save bookmark!"),
+    )
+
+
+def server(input: Inputs, output: Outputs, session: Session):
+
+    # @reactive.effect
+    # @reactive.event(input.letter, ignore_init=True)
+    # async def _():
+    #     await session.bookmark()
+
+    @session.bookmark.on_bookmarked
+    async def _(url: str):
+        await session.bookmark.update_query_string(url)
+
+
+app = App(app_ui, server, bookmark_store="url")

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

@@ -0,0 +1,23 @@
+from starlette.requests import Request
+
+from shiny import reactive, render
+from shiny.express import app_opts, input, session, ui
+
+app_opts(bookmark_store="url")
+
+
+ui.markdown(
+    "Directions: "
+    "\n1. Change the radio button selection below"
+    "\n2. Save the bookmark."
+    "\n3. Then, refresh your browser page to see the radio button selection has been restored."
+)
+
+
+ui.input_radio_buttons("letter", "Choose a letter", choices=["A", "B", "C"])
+ui.input_bookmark_button()
+
+
+@session.bookmark.on_bookmarked
+async def _(url: str):
+    await session.bookmark.update_query_string(url)

shiny/api-examples/restore_input/app.py

@@ -0,0 +1,51 @@
+from htmltools import tags
+from starlette.requests import Request
+
+from shiny import App, Inputs, Outputs, Session, reactive, render, ui
+from shiny._namespaces import resolve_id
+
+
+def custom_input_text(
+    id: str,
+    value: str = "",
+) -> Tag:
+
+    resolved_id = resolve_id(id)
+    return tags.div(
+        "Custom input text:",
+        tags.input(
+            id=resolve_id(id),
+            type="text",
+            value=value,
+            placeholder="Type here...",
+        ),
+        class_="shiny-input-container",
+        style=css(width=width),
+    )
+
+
+# App UI **must** be a function to ensure that each user restores their own UI values.
+def app_ui(request: Request):
+    return ui.page_fluid(
+        custom_input_text("myid", value="Default value - Hello, world!"),
+        ui.input_bookmark_button(),
+        # ui.markdown(
+        #     "Directions: "
+        #     "\n1. Change the radio button selection below"
+        #     "\n2. Save the bookmark."
+        #     "\n3. Then, refresh your browser page to see the radio button selection has been restored."
+        # ),
+        # ui.hr(),
+        # ui.input_radio_buttons("letter", "Choose a letter", choices=["A", "B", "C"]),
+        # ui.input_bookmark_button(label="Save bookmark!"),
+    )
+
+
+def server(input: Inputs, output: Outputs, session: Session):
+
+    @session.bookmark.on_bookmarked
+    async def _(url: str):
+        await session.bookmark.update_query_string(url)
+
+
+app = App(app_ui, server, bookmark_store="url")

shiny/bookmark/_button.py

@@ -2,13 +2,15 @@
 
 from htmltools import HTML, Tag, TagAttrValue, TagChild
 
+from .._docstring import add_example
 from .._namespaces import resolve_id
 from ..types import MISSING, MISSING_TYPE
 from ..ui._input_action_button import input_action_button
 
 BOOKMARK_ID = "._bookmark_"
 
 
+@add_example()
 def input_bookmark_button(
     label: TagChild = "Bookmark...",
     *,

shiny/playwright/controller/_navs.py

@@ -6,8 +6,7 @@
 from playwright.sync_api import expect as playwright_expect
 from typing_extensions import Literal
 
-from shiny.types import ListOrTuple
-
+from ...types import ListOrTuple
 from .._types import PatternOrStr, Timeout
 from ..expect import expect_to_have_class, expect_to_have_style
 from ..expect._internal import expect_attribute_to_have_value

shiny/playwright/controller/_output.py

@@ -6,8 +6,7 @@
 from playwright.sync_api import Locator, Page
 from playwright.sync_api import expect as playwright_expect
 
-from shiny.render._data_frame import ColumnFilter, ColumnSort
-
+from ...render._data_frame import ColumnFilter, ColumnSort
 from .._types import AttrValue, ListPatternOrStr, PatternOrStr, StyleValue, Timeout
 from ..expect import expect_not_to_have_class, expect_to_have_class
 from ..expect._internal import (

shiny/session/_session.py

@@ -64,10 +64,9 @@
 from ._utils import RenderedDeps, read_thunk_opt, session_context
 
 if TYPE_CHECKING:
-    from shiny.bookmark._serializers import Unserializable
-
     from .._app import App
     from ..bookmark import Bookmark
+    from ..bookmark._serializers import Unserializable
 
 
 class ConnectionState(enum.Enum):
@@ -1457,6 +1456,7 @@ async def _serialize(
                 # TODO: Barret - Q: Should this be ignoring any Input key that starts with a "."?
                 if key.startswith(".clientdata_"):
                     continue
+                # Ignore all bookmark inputs
                 if key == BOOKMARK_ID or key.endswith(
                     f"{ResolvedId._sep}{BOOKMARK_ID}"
                 ):

shiny/ui/_input_task_button.py

@@ -7,13 +7,12 @@
 
 from htmltools import HTML, Tag, TagAttrValue, TagChild, css, tags
 
-from shiny.types import MISSING, MISSING_TYPE
-
 from .._docstring import add_example
 from .._namespaces import resolve_id
 from .._typing_extensions import ParamSpec
 from ..reactive._extended_task import ExtendedTask
 from ..reactive._reactives import effect
+from ..types import MISSING, MISSING_TYPE
 from ._html_deps_py_shiny import spin_dependency
 from ._html_deps_shinyverse import components_dependencies