R: Sidebar layouts

sidebar {bslib}

R Documentation

Description

Create a collapsing sidebar layout by providing a sidebar() object to the sidebar argument of:

page_sidebar()
- Creates a "page-level" sidebar.
page_navbar()
- Creates a multi-page app with a "page-level" sidebar.
- Creates a multi page/tab UI with a singular sidebar() (which is shown on every page/tab).
layout_sidebar()
- Creates a "floating" sidebar layout component which can be dropped inside any page() and/or card() context.
navset_card_tab() and navset_card_pill()
- Creates a multi-tab card with a sidebar inside of it.

See this article to learn more.

Usage

sidebar(
  ...,
  width = 250,
  position = c("left", "right"),
  open = c("desktop", "open", "closed", "always"),
  id = NULL,
  title = NULL,
  bg = NULL,
  fg = NULL,
  class = NULL,
  max_height_mobile = NULL,
  gap = NULL,
  padding = NULL
)

layout_sidebar(
  ...,
  sidebar = NULL,
  fillable = TRUE,
  fill = TRUE,
  bg = NULL,
  fg = NULL,
  border = NULL,
  border_radius = NULL,
  border_color = NULL,
  padding = NULL,
  gap = NULL,
  height = NULL
)

toggle_sidebar(id, open = NULL, session = get_current_session())

sidebar_toggle(id, open = NULL, session = get_current_session())

Arguments

`...`	Unnamed arguments can be any valid child of an htmltools tag and named arguments become HTML attributes on returned UI element. In the case of `layout_sidebar()`, these arguments are passed to the main content tag (not the sidebar+main content container).
`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, choosing from the following options: `"desktop"`: The sidebar starts open on desktop screen, closed on mobile. This is default sidebar behavior. `"open"` or `TRUE`: The sidebar starts open. `"closed"` or `FALSE`: The sidebar starts closed. `"always"` or `NA`: The sidebar is always open and cannot be closed. In `sidebar_toggle()`, `open` indicates the desired state of the sidebar, where the default of `open = NULL` will cause the sidebar to be toggled open if closed or vice versa. Note that `sidebar_toggle()` 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 `htmltools::tag()` for the title element, in which case you'll likely want to give this element `class = "sidebar-title"`.
`bg`, `fg`	A background or foreground color. If only one of either is provided, an accessible contrasting color is provided for the opposite color, e.g. setting `bg` chooses an appropriate `fg` color.
`class`	CSS classes for the sidebar container element, in addition to the fixed `.sidebar` class.
`max_height_mobile`	The maximum height of the horizontal sidebar when viewed on mobile devices. The default is `⁠250px⁠` unless the sidebar is included in a `layout_sidebar()` with a specified height, in which case the default is to take up no more than 50% of the layout container.
`gap`	A CSS length unit defining the vertical `gap` (i.e., spacing) between adjacent elements provided to `...`.
`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` may be one to four values. If one, then that value will be used for all four sides. If two, then the first value will be used for the top and bottom, while the second value will be used for left and right. If three, then the first will 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.
`sidebar`	A `sidebar()` object.
`fillable`	Whether or not the `main` content area should be considered a fillable (i.e., flexbox) container.
`fill`	Whether or not to allow the layout container to grow/shrink to fit a fillable container with an opinionated height (e.g., `page_fillable()`).
`border`	Whether or not to add a border.
`border_radius`	Whether or not to add a border radius.
`border_color`	The border color that is applied to the entire layout (if `border = TRUE`) and the color of the border between the sidebar and the main content area.
`height`	Any valid CSS unit (e.g., `height="200px"`). Doesn't apply when a card is made `full_screen` (in this case, consider setting a `height` in `card_body()`).
`session`	A Shiny session object (the default should almost always be used).

Functions

toggle_sidebar(): Toggle a sidebar() state during an active Shiny user session.
sidebar_toggle(): An alias for toggle_sidebar().

[Package bslib version 0.5.1 Index]