Skip to content

Allow express' layout.sidebar to handle inline layouts #847

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

Allow express' layout.sidebar to handle inline layouts #847

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion shiny/express/_run.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@

__all__ = ("wrap_express_app",)

_DEFAULT_PAGE_FUNCTION = ui.page_fluid
_DEFAULT_PAGE_FUNCTION = ui.page_fillable


def wrap_express_app(file: Path) -> App:
Expand Down
87 changes: 36 additions & 51 deletions shiny/express/layout.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,59 +56,42 @@ def set_page(page_fn: RecallContextManager[Tag]):
# ======================================================================================
def sidebar(
*,
width: CssUnit = 250,
position: Literal["left", "right"] = "left",
open: Literal["desktop", "open", "closed", "always"] = "always",
id: Optional[str] = None,
title: TagChild | str = None,
fillable: bool = True,
fill: bool = True,
bg: Optional[str] = None,
fg: Optional[str] = None,
class_: Optional[str] = None, # TODO-future; Consider using `**kwargs` instead
max_height_mobile: Optional[str | float] = "auto",
border: Optional[bool] = None,
border_radius: Optional[bool] = None,
border_color: Optional[str] = None,
gap: Optional[CssUnit] = None,
padding: Optional[CssUnit | list[CssUnit]] = None,
) -> RecallContextManager[ui.Sidebar]:
height: Optional[CssUnit] = None,
**kwargs: TagAttrValue,
) -> RecallContextManager[ui.CardItem]:
"""
Sidebar element
A sidebar layout.

Create a collapsing sidebar layout. This function wraps :func:`~shiny.ui.sidebar`.
Create a collapsing sidebar layout. This function wraps :func:`~shiny.ui.layout_sidebar`.

Parameters
----------
width
A valid CSS unit used for the width of the sidebar.
position
Where the sidebar should appear relative to the main content.
open
The initial state of the sidebar. It can be `"desktop"` (the sidebar starts open
on desktop screen, closed on mobile), `"open"` or `True` (the sidebar starts
open), `"closed"` or `False` (the sidebar starts closed), or `"always"` or
`None` (the sidebar is always open and cannot be closed).

In :func:`~shiny.ui.update_sidebar`, `open` indicates the desired state of the
sidebar. Note that :func:`~shiny.ui.update_sidebar` can only open or close the
sidebar, so it does not support the `"desktop"` and `"always"` options.
id
A character string. Required if wanting to re-actively read (or update) the
`collapsible` state in a Shiny app.
title
A character title to be used as the sidebar title, which will be wrapped in a
`<div>` element with class `sidebar-title`. You can also provide a custom
:class:`~htmltools.Tag` for the title element, in which case you'll
likely want to give this element `class = "sidebar-title"`.
fillable
Whether or not the main content area should be wrapped in a fillable container.
See :func:`~shiny.ui.as_fillable_container` for details.
fill
Whether or not the sidebar layout should be wrapped in a fillable container. See
:func:`~shiny.ui.as_fill_item` for details.
bg,fg
A background or foreground color.
class_
CSS classes for the sidebar container element, in addition to the fixed
`.sidebar` class.
max_height_mobile
A CSS length unit (passed through :func:`~shiny.ui.css.as_css_unit`) defining
the maximum height of the horizontal sidebar when viewed on mobile devices. Only
applies to always-open sidebars that use `open = "always"`, where by default the
sidebar container is placed below the main content container on mobile devices.
border
Whether or not to show a border around the sidebar layout.
border_radius
Whether or not to round the corners of the sidebar layout.
border_color
A border color.
gap
A CSS length unit defining the vertical `gap` (i.e., spacing) between elements
provided to `*args`.
provided to `*args`. This value will only be used if `fillable` is `True`.
padding
Padding within the sidebar itself. This can be a numeric vector (which will be
interpreted as pixels) or a character vector with valid CSS lengths. `padding`
Expand All @@ -118,27 +101,29 @@ def sidebar(
be used for top, the second will be left and right, and the third will be
bottom. If four, then the values will be interpreted as top, right, bottom, and
left respectively.
height
Any valid CSS unit to use for the height.

Returns
-------
:
A :class:`~shiny.ui.Sidebar` object.
A :class:`~shiny.ui.CardItem` object.
"""
return RecallContextManager(
ui.sidebar,
default_page=page_sidebar(),
ui.layout_sidebar,
default_page=page_fillable(padding=0, gap=0),
kwargs=dict(
width=width,
position=position,
open=open,
id=id,
title=title,
fillable=fillable,
fill=fill,
bg=bg,
fg=fg,
class_=class_,
max_height_mobile=max_height_mobile,
border=border,
border_radius=border_radius,
border_color=border_color,
gap=gap,
padding=padding,
height=height,
**kwargs,
),
)

Expand Down Expand Up @@ -673,7 +658,7 @@ def page_fillable(
"""
Creates a fillable page.

This function wraps :func:`~shiny.ui.page_fixed`.
This function wraps :func:`~shiny.ui.page_fillable`.

Parameters
----------
Expand Down
14 changes: 8 additions & 6 deletions shiny/ui/_sidebar.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -289,7 +289,7 @@ def sidebar(

@add_example()
def layout_sidebar(
sidebar: Sidebar,
sidebar: Sidebar | TagChild,
*args: TagChild | TagAttrs,
fillable: bool = True,
fill: bool = True,
Expand Down Expand Up @@ -423,22 +423,20 @@ def layout_sidebar(


def _get_layout_sidebar_sidebar(
sidebar: Sidebar,
sidebar: Sidebar | DeprecatedPanelSidebar | TagChild,
args: tuple[TagChild | TagAttrs, ...],
) -> tuple[Sidebar, tuple[TagChild | TagAttrs, ...]]:
updated_args: list[TagChild | TagAttrs] = []
original_args = tuple(args)

# sidebar: Sidebar | None = None
sidebar_orig_arg: Sidebar | DeprecatedPanelSidebar = sidebar
sidebar_orig_arg = sidebar

if isinstance(sidebar, DeprecatedPanelSidebar):
sidebar = sidebar.sidebar

if not isinstance(sidebar, Sidebar):
raise ValueError(
"`layout_sidebar()` is not being supplied with a `sidebar()` object. Please supply a `sidebar()` object to `layout_sidebar(sidebar)`."
)
sidebar = _sidebar_func(sidebar)

# Use `original_args` here so `updated_args` can be safely altered in place
for i, arg in zip(range(len(original_args)), original_args):
Expand Down Expand Up @@ -496,6 +494,10 @@ def _get_layout_sidebar_sidebar(
return (sidebar, tuple(updated_args))


# Save an internal copy of sidebar func so we can use `sidebar` as an arg name
_sidebar_func = sidebar


@add_example()
def update_sidebar(
id: str,
Expand Down