Smarter, lazier, and more complete page default/api for express #893

cpsievert · 2023-12-11T21:46:14Z

This PR currently just introduces a TopLevelRecallContextManager(), which inspects it's args to determine a smarter page (i.e., page_sidebar()/page_navbar()/something else) based on the presence of top-level layout.sidebar()/layout.nav()/other components.

As result, this PR makes multi-page apps (with/without a sidebar) possible. It also closes Shiny express, placing UI elements above the sidebar context manager causes error. #841.

This new approach isn't compatible with the more immediate/imperative layout.set_page(layout.page_*()) API, so I'm removing it for now. This does bring up, however, more questions as to how to the page API (#866) should look. Originally I was thinking .set_page_*() + .set_title() would be sensible, but on second thought, a set_page_preferences() is probably more ideal. There you could not only control page kwargs (e.g., title, lang, etc), but also parameters related to default page container decision (e.g., fillable, wider (i.e., page_fluid() vs page_fixed()), etc))

Also note that, we still currently have the issue of layout.sidebar() in a non-top-level context. I think, ideally, a non-top-level RecallContextManager could handle this by doing essentially the same as TopLevelRecallContextManager (i.e., wrapping any Sidebar(s) into a layout_sidebar())

…fault. Gut layout.page_*() for now.

wch · 2023-12-11T22:56:19Z

Things the user needs to control:

Title
Fillable
Width
(Maybe) If inference is wrong, explicit way of setting page function

Possible interface for this:

set_page_xxx()
set_title(), set_fillable(), set_restrict_width()
set_page_preferences(*, title, fillable, width, **kwargs)

wch · 2023-12-16T00:59:15Z

I've added the following functions:

set_page_title()
set_page_lang()

# The two below affect heuristics for which page function is used.
set_page_fillable()
set_page_wider()

If the user wants to explicitly choose which page function is used, there are the following:

use_page_fixed()
use_page_fluid()
use_page_fillable()
use_page_sidebar()
use_page_navbar()

All of these functions live in express._page, but I haven't imported them into express.layout, because that will introduce merge conflicts with #904. I think we should merge these two PRs and then export the functions here from express.ui.

cpsievert · 2023-12-18T15:39:00Z

shiny/express/_page.py

+                if _fillable:
+                    _page_fn = (
+                        ui.page_fillable
+                    )  # pyright: ignore[reportGeneralTypeIssues]


Not that we absolutely need this now, but I think we could support wider=F when fillable=T by including a {"class": "container"} (probably on the <body>)?

shiny/express/_page.py

wch · 2023-12-18T20:16:45Z

From a conversation with @cpsievert, @gadenbuie, @jcheng5:

Things we can do now:

Add page_opts() function. Make all args keyword only (first arg is *).
Make page_auto() the default page. Also add that function to core UI.

Add set_page_fn()

layout.set_page_fn(
    lambda *args: ui.page_navbar(*args, ...)
)

# or

def my_page_fn(*args):
    return ui.page_navbar(*args, ...)

layout.set_page_fn(my_page_fn)

Things we can do possibly in the future:

Maybe add page_opts(mode = "navbar", ...) or page_opts_navbar(...)
Allow passing *kwargs to page_opts()? How to distinguish between HTML attributes and proper args?

wch · 2023-12-21T06:17:07Z

I've retargeted this PR against express-layout-to-ui (#904) to make the changes make more sense.

I implemented the changes as described in the previous comment:

Add page_opts() function. Make all args keyword only (first arg is *).
Make page_auto() the default page. Also add that function to core UI.
However, for the third item, I made a change. Instead of adding a function set_page_fn(), I added a page_fn parameter to page_opts(). It would be used like this:
```
page_opts(page_fn=shiny.ui.page_fillable)
```
I did this because the parameters to page_opts() basically map to page_auto() parameters, and page_auto() already accepts _page_fn.

jcheng5 · 2023-12-21T18:14:10Z

shiny/ui/_page.py

+        The page function to use. If ``None`` (the default), will automatically choose
+        one based on the arguments provided.
+    _fillable
+        This has an effect only if there are no sidebars or top-level navs. If ``True``,


page_navbar and page_sidebar both take a fillable argument, we could pass it through

jcheng5 · 2023-12-21T18:14:55Z

shiny/ui/_page.py

+        ``False`` (the default), the value of ``_full_width`` will determine which page
+        function is used.
+    _full_width
+        This has an effect only if there are no sidebars or top-level navs, and


Not as part of this PR, but we should support narrow layouts with sidebars or top-level navs.

jcheng5 · 2023-12-21T18:20:40Z

shiny/ui/_page.py

+    _page_fn: Callable[..., Tag] | None = None,
+    _fillable: bool = False,
+    _full_width: bool = False,
+    **kwargs: object,


Remove underscore prefixes, and make the **kwargs a dictionary argument instead

Or don't take _page_fn

I considered taking out page_fn, but I think we should keep it because it's useful when, in Express, you call page_opts(page_fn=...). The page_opts function can just pass it through to this function.

* main: (24 commits) Use dynamic version of py-shiny for deploy tests (#970) Add underscores to hide some imports (#978) Add rsconnect json files(shinyapps.io tests) and folium tests (#928) Express' `value_box()` no longer includes named positional args (#966) Include `tooltip()` and `popover()` in express (#949) Remove extra call to run_express() Call `tagify()` early to intercept `AttributeErrors` (#941) Don't pass sidebar twice to navbar_page Update changelog Update changelog Switch from `requests` to `urllib` (#940) Bump version to 0.6.1.1 Fix docstring for page_opts Fix API doc sections for Express Smarter, lazier, and more complete page default/api for express (#893) Change `express.layout` to `express.ui` (#904) Remove `@output` from examples (#790) feat: Allow for `App` `server=` to take `input` only (#920) Add fixes for type stub generation (#828) Move quarto express docs to bottom ...

Add TopLevelRecallContextManager which inspects args to infer page de…

1716b1d

…fault. Gut layout.page_*() for now.

wch added 4 commits December 12, 2023 10:28

WIP convert layout to ui

5fa9a52

Add remaining components to shiny.express.ui

19b8f44

Install htmltools from github

fac3ca2

Update examples

d9361d2

cpsievert mentioned this pull request Dec 13, 2023

Change express.layout to express.ui #904

Merged

wch added 8 commits December 13, 2023 14:47

Better test error messages

f03bb44

Update express UI components

74412af

Merge remote-tracking branch 'origin/main' into express-layout-to-ui

63e7307

Remove row and column from express.ui

9d75b26

Merge branch 'main' into express-inspect-args

d3e5f32

Move TopLevelRecallContextManager code to page_auto

b552067

For multiple sidebars, require use of layout_sidebar()

1a8935d

Add set_page_*, use_page_* functions

8afcc28

cpsievert commented Dec 18, 2023

View reviewed changes

shiny/express/_page.py Outdated Show resolved Hide resolved

cpsievert commented Dec 18, 2023

View reviewed changes

shiny/express/_page.py Outdated Show resolved Hide resolved

Update docstrings

af25ce2

schloerke added this to the v0.7.0 milestone Dec 18, 2023

schloerke modified the milestones: v0.6.1, v0.7.0 Dec 19, 2023

wch added 6 commits December 19, 2023 23:18

Merge branch 'main' into express-layout-to-ui

38472f0

Add .tagify() method to RecallContextManager

55b60fd

Add shiny.express.layout compatibility shim

16d03f2

Remove navset and navset_card

364cbad

Fix example app

b3db4db

Fix exports

b084224

wch added 8 commits December 20, 2023 19:22

Update docstrings

675d015

Update test apps

0366460

Import fixes in test apps

8df8d94

Documentation updates

2f801f7

Merge branch 'express-layout-to-ui' into express-inspect-args-2

1a7cdd8

Update known missing items

a7b6664

Update quartodoc entries

31c8130

API updates

06b31e0

wch changed the base branch from main to express-layout-to-ui December 21, 2023 06:07

jcheng5 mentioned this pull request Dec 21, 2023

Add rsconnect json files and folium tests #928

Merged

jcheng5 reviewed Dec 21, 2023

View reviewed changes

Base automatically changed from express-layout-to-ui to main December 21, 2023 19:24

wch added 2 commits December 21, 2023 17:44

Update page_auto

c03f684

Replace set_page() with page_opts()

cdf8a3e

wch force-pushed the express-inspect-args branch from 94348ac to cdf8a3e Compare December 21, 2023 23:59

wch marked this pull request as ready for review December 22, 2023 00:00

Merge remote-tracking branch 'origin/main' into express-inspect-args

cb7886e

wch merged commit 22b1db3 into main Dec 22, 2023
26 checks passed

wch deleted the express-inspect-args branch December 22, 2023 00:17

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Smarter, lazier, and more complete page default/api for express #893

Smarter, lazier, and more complete page default/api for express #893

cpsievert commented Dec 11, 2023 •

edited

Loading

wch commented Dec 11, 2023 •

edited

Loading

wch commented Dec 16, 2023

cpsievert Dec 18, 2023 •

edited

Loading

wch commented Dec 18, 2023

wch commented Dec 21, 2023

jcheng5 Dec 21, 2023

jcheng5 Dec 21, 2023

jcheng5 Dec 21, 2023

jcheng5 Dec 21, 2023

wch Dec 21, 2023

Smarter, lazier, and more complete page default/api for express #893

Smarter, lazier, and more complete page default/api for express #893

Conversation

cpsievert commented Dec 11, 2023 • edited Loading

wch commented Dec 11, 2023 • edited Loading

wch commented Dec 16, 2023

cpsievert Dec 18, 2023 • edited Loading

Choose a reason for hiding this comment

wch commented Dec 18, 2023

wch commented Dec 21, 2023

jcheng5 Dec 21, 2023

Choose a reason for hiding this comment

jcheng5 Dec 21, 2023

Choose a reason for hiding this comment

jcheng5 Dec 21, 2023

Choose a reason for hiding this comment

jcheng5 Dec 21, 2023

Choose a reason for hiding this comment

wch Dec 21, 2023

Choose a reason for hiding this comment

cpsievert commented Dec 11, 2023 •

edited

Loading

wch commented Dec 11, 2023 •

edited

Loading

cpsievert Dec 18, 2023 •

edited

Loading