Package 'bootstrict'

Description

Loads every JavaScript file shipped in inst/assets/js, forcing bootstrict-core.js first (it defines the window.bootstrict namespace that the per-component binding files rely on), followed by the supporting stylesheet. Component binding files are discovered dynamically, so adding a new binding is just a matter of dropping a .js file in that directory. The dependency is built once per session and cached (every widget calls this, and the installed files cannot change mid-session).

Usage

bootstrict_dep()

Value

An htmltools::htmlDependency.

Description

A thin wrapper around bslib::bs_theme() pinned to Bootstrap 5 that also accepts a designer's exported SASS variable sheet. Variables from variables are merged with (and overridden by) any variables passed through ..., then handed to bslib.

Usage

bootstrict_theme(..., variables = NULL, bootswatch = NULL, preset = NULL)

Arguments

Value

A bslib::bs_theme() object.

Examples

if (interactive()) {
  bootstrict_theme(primary = "#ff6600", "font-size-base" = "1rem")
}

Description

A vertically collapsing set of panels. The value(s) of the currently open panel(s) are reported to the server as input$id, and can be driven server-side with update_bs_accordion().

Usage

bs_accordion(
  id,
  ...,
  open = NULL,
  multiple = FALSE,
  flush = FALSE,
  class = NULL
)

bs_accordion_panel(
  title,
  ...,
  value = NULL,
  icon = NULL,
  class = NULL,
  body_class = NULL
)

Arguments

Value

An accordion tag.

Examples

bs_accordion(
  "acc",
  bs_accordion_panel("First", "Panel one body", value = "one"),
  bs_accordion_panel("Second", "Panel two body", value = "two"),
  open = "one"
)

Description

Bootstrap alert

Usage

bs_alert(..., color = "primary", dismissible = FALSE, class = NULL)

bs_alert_heading(..., level = 4, class = NULL)

bs_alert_link(..., href = "#", class = NULL)

Arguments

Value

An alert tag.

Examples

bs_alert("Well done!", color = "success")
bs_alert("Heads up.", color = "warning", dismissible = TRUE)

Description

A small count / labelling component rendered as a ⁠<span class="badge">⁠.

Usage

bs_badge(..., color = "primary", pill = FALSE, class = NULL)

Arguments

Value

A badge tag.

Examples

bs_badge("New", color = "success")

Description

Bootstrap blockquote

Usage

bs_blockquote(..., footer = NULL, class = NULL)

Arguments

Value

A figure tag wrapping the blockquote.

Examples

bs_blockquote("A well-known quote.", footer = "Someone famous")

Description

A navigation hierarchy. Compose with bs_breadcrumb_item().

Usage

bs_breadcrumb(..., divider = NULL, label = "breadcrumb", class = NULL)

bs_breadcrumb_item(..., active = FALSE, href = NULL, class = NULL)

Arguments

Value

A breadcrumb ⁠<nav>⁠ tag.

Examples

bs_breadcrumb(
  bs_breadcrumb_item("Home", href = "#"),
  bs_breadcrumb_item("Library", active = TRUE)
)

Description

Renders a Bootstrap 5 button. When id is supplied the button is wired as a Shiny action button: input$id holds the click count, exactly like shiny::actionButton().

Usage

bs_button(
  id = NULL,
  label = NULL,
  ...,
  color = "primary",
  outline = FALSE,
  size = NULL,
  disabled = FALSE,
  href = NULL,
  type = "button",
  class = NULL
)

Arguments

Value

A button (or anchor) tag.

Examples

bs_button("go", "Go", color = "primary")
bs_button(label = "Cancel", color = "secondary", outline = TRUE)

Description

Bootstrap button group / toolbar

Usage

bs_button_group(..., size = NULL, vertical = FALSE, label = NULL, class = NULL)

bs_button_toolbar(..., label = NULL, class = NULL)

Arguments

Value

A button group / toolbar tag.

Examples

bs_button_group(bs_button(label = "Left"), bs_button(label = "Right"))

Description

A flexible content container. Compose with bs_card_header(), bs_card_body(), bs_card_footer(), bs_card_img() and the card text helpers.

Usage

bs_card(..., color = NULL, border = NULL, class = NULL)

bs_card_body(..., class = NULL)

bs_card_header(..., class = NULL)

bs_card_footer(..., class = NULL)

bs_card_title(..., level = 5, class = NULL)

bs_card_subtitle(..., level = 6, class = NULL)

bs_card_text(..., class = NULL)

bs_card_link(..., href = "#", class = NULL)

bs_card_img(
  src,
  position = c("top", "bottom", "overlay"),
  alt = NULL,
  ...,
  class = NULL
)

bs_card_img_overlay(..., class = NULL)

bs_card_group(..., class = NULL)

Arguments

Value

A card tag.

Examples

bs_card(
  bs_card_header("Featured"),
  bs_card_body(
    bs_card_title("Card title"),
    bs_card_text("Some quick example text.")
  )
)

Description

A slideshow component for cycling through a series of items (bs_carousel_item()s). The 0-based index of the active slide is reported to the server as input$id, and can be driven server-side with update_bs_carousel().

Usage

bs_carousel(
  id,
  ...,
  indicators = TRUE,
  controls = TRUE,
  fade = FALSE,
  autoplay = TRUE,
  interval = NULL,
  dark = FALSE,
  class = NULL
)

bs_carousel_item(
  ...,
  active = FALSE,
  interval = NULL,
  caption = NULL,
  class = NULL
)

Arguments

Value

A carousel tag.

Examples

bs_carousel(
  "demo",
  bs_carousel_item(htmltools::img(src = "1.jpg"), active = TRUE),
  bs_carousel_item(htmltools::img(src = "2.jpg"))
)

Description

Delegates to shiny::checkboxGroupInput() and rewrites the markup to Bootstrap 5 .form-check shape so the value stays available as input$id.

Usage

bs_checkbox_group_input(
  id,
  label = NULL,
  choices,
  selected = NULL,
  ...,
  inline = FALSE,
  reverse = FALSE,
  help = NULL,
  width = NULL
)

Arguments

Value

A form control tag.

See Also

shiny::checkboxGroupInput()

Examples

bs_checkbox_group_input("opts", "Options", c("A", "B", "C"), selected = "A")

Description

Bootstrap checkbox input

Usage

bs_checkbox_input(
  id,
  label = NULL,
  value = FALSE,
  ...,
  switch = FALSE,
  reverse = FALSE,
  help = NULL,
  width = NULL
)

bs_switch_input(
  id,
  label = NULL,
  value = FALSE,
  ...,
  reverse = FALSE,
  help = NULL,
  width = NULL
)

Arguments

Value

A form control tag.

See Also

shiny::checkboxInput()

Examples

bs_checkbox_input("agree", "I agree", TRUE)
bs_checkbox_input("dark", "Dark mode", switch = TRUE)

Description

Bootstrap close button

Usage

bs_close_button(..., label = "Close", white = FALSE, class = NULL)

Arguments

Value

A button tag.

Description

Bootstrap grid column

Usage

bs_col(
  ...,
  width = NULL,
  sm = NULL,
  md = NULL,
  lg = NULL,
  xl = NULL,
  xxl = NULL,
  offset = NULL,
  order = NULL,
  align_self = NULL,
  class = NULL
)

Arguments

Value

A column tag.

Examples

bs_col(width = 6, md = 4, "content")

Description

A toggleable container that shows or hides content. Pair it with a bs_collapse_trigger() (declarative, no server round trip) and/or drive it from the server with update_bs_collapse(). Its shown/hidden state is reported to the server as input$id (TRUE when visible).

Usage

bs_collapse(id, ..., open = FALSE, horizontal = FALSE, class = NULL)

Arguments

Value

A collapse tag.

Examples

bs_collapse("more", "Hidden content revealed on toggle.")

Description

Renders a control that toggles the bs_collapse() whose id matches target, using Bootstrap's declarative data-bs-toggle="collapse" attributes (no server round trip required).

Usage

bs_collapse_trigger(target, ..., button = TRUE, expanded = FALSE, class = NULL)

Arguments

Value

A button (or anchor) tag.

Examples

bs_collapse_trigger("more", "Toggle")

Description

A native ⁠<input type="color" class="form-control form-control-color">⁠ whose value (a "#rrggbb" string) is reported as input$id. Drive it server-side with update_bs_color().

Usage

bs_color_input(
  id,
  label = NULL,
  value = "#000000",
  ...,
  help = NULL,
  width = NULL
)

Arguments

Value

A form control tag.

Examples

bs_color_input("col", "Pick a colour", value = "#0d6efd")

Description

Bootstrap container

Usage

bs_container(..., fluid = FALSE, breakpoint = NULL, class = NULL)

Arguments

Value

A container tag.

See Also

bs_row(), bs_col()

Examples

bs_container(bs_row(bs_col("a"), bs_col("b")))

Description

Delegates to shiny::dateInput() and adds the Bootstrap .form-label / .form-control affordances.

Usage

bs_date_input(
  id,
  label = NULL,
  value = NULL,
  ...,
  min = NULL,
  max = NULL,
  help = NULL,
  width = NULL
)

Arguments

Value

A form control tag.

See Also

shiny::dateInput()

Examples

bs_date_input("day", "Pick a day", value = "2026-06-26")

Description

Delegates to shiny::dateRangeInput() and adds the Bootstrap .form-label / .form-control affordances.

Usage

bs_date_range_input(
  id,
  label = NULL,
  start = NULL,
  end = NULL,
  ...,
  min = NULL,
  max = NULL,
  help = NULL,
  width = NULL
)

Arguments

Value

A form control tag.

See Also

shiny::dateRangeInput()

Examples

bs_date_range_input("range", "Period", start = "2026-01-01", end = "2026-12-31")

Description

A larger, slightly more opinionated heading style (⁠.display-*⁠).

Usage

bs_display_heading(..., level = 1, class = NULL)

Arguments

Value

A heading tag.

Examples

bs_display_heading("Display heading", level = 2)

Description

A toggleable menu of links, headers and dividers. Compose the menu with bs_dropdown_item(), bs_dropdown_divider(), bs_dropdown_header() and bs_dropdown_text(). Bootstrap drives the toggle; give an item an id to wire it as a Shiny action button (input$id).

Usage

bs_dropdown(
  label,
  ...,
  color = "secondary",
  outline = FALSE,
  size = NULL,
  split = FALSE,
  direction = "down",
  dark = FALSE,
  align = NULL,
  class = NULL
)

bs_dropdown_item(
  ...,
  id = NULL,
  href = "#",
  active = FALSE,
  disabled = FALSE,
  class = NULL
)

bs_dropdown_divider(class = NULL)

bs_dropdown_header(..., level = 6, class = NULL)

bs_dropdown_text(..., class = NULL)

Arguments

Value

A dropdown tag.

Examples

bs_dropdown("Menu", bs_dropdown_item("Action", id = "act"))

Description

Group an image with a caption. Compose bs_figure() with bs_figure_img() and bs_figure_caption().

Usage

bs_figure(..., class = NULL)

bs_figure_img(src, ..., alt = NULL, class = NULL)

bs_figure_caption(..., class = NULL)

Arguments

Value

A figure tag.

Examples

bs_figure(
  bs_figure_img("photo.jpg", alt = "A photo"),
  bs_figure_caption("A caption for the image.")
)

Description

Delegates to shiny::fileInput() and adapts its markup to Bootstrap 5.

Usage

bs_file_input(
  id,
  label = NULL,
  ...,
  multiple = FALSE,
  accept = NULL,
  button_label = "Browse...",
  placeholder = "No file selected",
  width = NULL
)

Arguments

Details

shiny hides the real ⁠<input type="file">⁠ off-screen (⁠top: -99999px⁠) and relies on Bootstrap 3 .btn-file CSS to bring it back over the browse button. That CSS is absent under Bootstrap 5, so clicking the button focuses the off-screen input and the browser scrolls the page to the top. We fix this by overlaying the input on the button (invisible, opacity: 0) so a click lands on it directly, and restyle the browse button as a real Bootstrap 5 button.

Value

A form control tag.

See Also

shiny::fileInput()

Examples

bs_file_input("upload", "Upload a file", accept = ".csv")

Description

Reshape a control built by one of the ⁠bs_*_input()⁠ constructors (e.g. bs_text_input(), bs_select_input()) into a Bootstrap 5 floating-label group, where the label animates into the control's border. The existing control and its Shiny input wiring are preserved (the element is moved, not rebuilt), so the value still reports as input$id.

Usage

bs_floating_label(input, label = NULL, class = NULL)

Arguments

Value

A .form-floating wrapper tag.

Examples

bs_floating_label(bs_text_input("email", "Email address"))

Description

A plain ⁠<form>⁠ container for grouping form controls.

Usage

bs_form(..., novalidate = FALSE, class = NULL)

Arguments

Value

A form tag.

Examples

bs_form(
  bs_text_input("email", "Email"),
  bs_button("Submit", color = "primary")
)

Description

A ⁠<label class="form-label">⁠ tied to a control via its for attribute.

Usage

bs_form_label(for_id, ..., class = NULL)

Arguments

Value

A label tag.

Examples

bs_form_label("email", "Email address")

Description

Muted helper text rendered below a control (.form-text).

Usage

bs_form_text(..., class = NULL)

Arguments

Value

A div tag.

Examples

bs_form_text("Must be 8-20 characters long.")

Description

Shorthand flex helpers added in Bootstrap 5.1. bs_hstack() lays children out in a row, bs_vstack() in a column.

Usage

bs_hstack(..., gap = NULL, class = NULL)

bs_vstack(..., gap = NULL, class = NULL)

Arguments

Value

A stack tag.

Examples

bs_hstack(bs_button(label = "A"), bs_button(label = "B"), gap = 2)
bs_vstack(bs_alert("one"), bs_alert("two"), gap = 3)

Description

The Bootstrap 5.3 icon-link helper: an inline flex ⁠<a>⁠ that pairs an icon (e.g. an SVG) with text, with an optional hover translation of the icon (.icon-link-hover).

Usage

bs_icon_link(..., href = "#", hover = FALSE, class = NULL)

Arguments

Value

An anchor tag.

Examples

bs_icon_link("Icon link", href = "#")

Description

Bootstrap image

Usage

bs_img(
  src,
  ...,
  fluid = FALSE,
  thumbnail = FALSE,
  rounded = FALSE,
  object_fit = NULL,
  alt = NULL,
  class = NULL
)

Arguments

Value

An image tag.

Examples

bs_img("logo.png", alt = "Logo", fluid = TRUE)

Description

Groups one or more form controls together with add-ons (text, buttons, dropdowns) on a single line.

Usage

bs_input_group(..., size = NULL, class = NULL)

bs_input_group_text(..., class = NULL)

Arguments

Details

When a full ⁠bs_*_input()⁠ is passed, only its bare control is kept so it sits flush with the add-ons: the input's label and help text are dropped (compose them outside the group). Inputs whose Shiny binding lives on their container — bs_date_input(), bs_date_range_input(), bs_file_input(), bs_radio_input(), bs_checkbox_group_input() — cannot be unwrapped this way and raise an error.

Value

An input-group tag.

Examples

bs_input_group(
  bs_input_group_text("@"),
  bs_text_input("user", placeholder = "Username")
)

Description

A standout opening paragraph (.lead).

Usage

bs_lead(..., class = NULL)

Arguments

Value

A paragraph tag.

Examples

bs_lead("This is a lead paragraph.")

Description

A flexible container for displaying a series of content. Compose with bs_list_group_item(). When id is supplied the group becomes selectable: clicking an action item (action = TRUE or href) reports that item's value (its data-value) as input$id, and the selection can be driven server-side with update_bs_list_group().

Usage

bs_list_group(
  id = NULL,
  ...,
  flush = FALSE,
  numbered = FALSE,
  horizontal = FALSE,
  class = NULL
)

bs_list_group_item(
  ...,
  value = NULL,
  active = FALSE,
  disabled = FALSE,
  color = NULL,
  action = FALSE,
  href = NULL,
  class = NULL
)

Arguments

Value

A list group tag.

Examples

bs_list_group(
  bs_list_group_item("An item"),
  bs_list_group_item("A second item", active = TRUE)
)
bs_list_group_item("A link item", href = "#", value = "a")

Description

Remove a list's default styling (.list-unstyled) or lay items out inline (.list-inline). Each unnamed ... argument becomes one ⁠<li>⁠; named arguments become attributes of the ⁠<ul>⁠.

Usage

bs_list_unstyled(..., class = NULL)

bs_list_inline(..., class = NULL)

Arguments

Value

An unordered list tag.

Examples

bs_list_unstyled("First", "Second", "Third")
bs_list_inline("One", "Two", "Three")

Description

A faithful Bootstrap 5 modal dialog. The modal's open/closed state is reported to the server as input$id (TRUE when shown), and can be driven server-side with show_bs_modal(), hide_bs_modal() and toggle_bs_modal().

Usage

bs_modal(
  id,
  ...,
  title = NULL,
  footer = NULL,
  size = NULL,
  centered = FALSE,
  scrollable = FALSE,
  fullscreen = FALSE,
  backdrop = TRUE,
  keyboard = TRUE,
  class = NULL
)

bs_modal_header(..., class = NULL)

bs_modal_title(..., level = 1, class = NULL)

bs_modal_body(..., class = NULL)

bs_modal_footer(..., class = NULL)

Arguments

Details

For full control over the dialog structure (in place of the title and footer shortcuts) compose the body yourself with bs_modal_header(), bs_modal_body() and bs_modal_footer().

Value

A modal tag.

Examples

bs_modal("info", "Modal body text.", title = "Heads up")

Description

Renders a button that opens the modal whose id matches target, using Bootstrap's declarative data-bs-toggle="modal" attributes (no server round trip required).

Usage

bs_modal_trigger(target, ..., class = NULL)

Arguments

Value

A button tag.

Examples

bs_modal_trigger("info", "Open modal", color = "primary")

Description

A static navigation container rendered as a Bootstrap ⁠<ul class="nav">⁠. Compose it with bs_nav_item() and bs_nav_link(). For an interactive, server-reporting tabset use bs_tabset() instead.

Usage

bs_nav(
  ...,
  type = NULL,
  fill = FALSE,
  justified = FALSE,
  vertical = FALSE,
  class = NULL
)

bs_nav_item(..., class = NULL)

bs_nav_link(
  ...,
  href = "#",
  active = FALSE,
  disabled = FALSE,
  id = NULL,
  class = NULL
)

Arguments

Value

A nav tag.

Examples

bs_nav(
  bs_nav_item(bs_nav_link("Active", active = TRUE)),
  bs_nav_item(bs_nav_link("Link")),
  type = "tabs"
)

Description

A responsive navigation header. Compose with bs_navbar_brand(), bs_navbar_nav() (containing bs_nav_item() / bs_nav_link() from the nav-tabs group), bs_navbar_text() and, optionally, bs_dropdown(). The navbar collapses behind a toggler below the expand breakpoint.

Usage

bs_navbar(
  ...,
  brand = NULL,
  id = NULL,
  expand = "lg",
  bg = NULL,
  theme = NULL,
  placement = NULL,
  fluid = TRUE,
  class = NULL
)

bs_navbar_brand(..., href = "#", class = NULL)

bs_navbar_nav(..., scroll = FALSE, scroll_height = NULL, class = NULL)

bs_navbar_text(..., class = NULL)

Arguments

Value

A navbar tag.

Examples

bs_navbar(brand = bs_navbar_brand("Navbar"), bg = "light", theme = "light")
bs_navbar_brand("Acme", href = "/")
bs_navbar_nav(bs_nav_item(bs_nav_link("Home", active = TRUE)))
bs_navbar_text("Signed in as Mark Otto")

Description

Builds a toast on the client and shows it, much like shiny::showNotification(). A toast container is created on demand at placement if one is not already present, and the toast removes itself from the DOM once hidden.

Usage

bs_notify_toast(
  body,
  ...,
  title = NULL,
  color = NULL,
  autohide = TRUE,
  delay = 5000,
  placement = "top-end",
  session = shiny::getDefaultReactiveDomain()
)

Arguments

Value

Invisibly NULL, called for its side effect.

Examples

if (interactive()) bs_notify_toast("Saved!", title = "Status", color = "success")

Description

Bootstrap numeric input

Usage

bs_numeric_input(
  id,
  label = NULL,
  value = NULL,
  ...,
  min = NULL,
  max = NULL,
  step = NULL,
  size = NULL,
  help = NULL,
  width = NULL
)

Arguments

Value

A form control tag.

See Also

shiny::numericInput()

Description

A hidden sidebar panel that slides in from an edge of the viewport. The open/closed state is reported to the server as input$id (TRUE when shown), and can be driven server-side with show_bs_offcanvas(), hide_bs_offcanvas() and toggle_bs_offcanvas(). Open it declaratively from the UI with bs_offcanvas_trigger().

Usage

bs_offcanvas(
  id,
  ...,
  title = NULL,
  placement = "start",
  backdrop = TRUE,
  scroll = FALSE,
  responsive = NULL,
  class = NULL
)

Arguments

Value

An offcanvas tag.

Examples

bs_offcanvas("menu", "Sidebar content.", title = "Menu")
bs_offcanvas("nav", "Shown inline on lg+.", responsive = "lg")

Description

Renders a button that opens the offcanvas whose id matches target, using Bootstrap's declarative data-bs-toggle="offcanvas" attributes (no server round trip required).

Usage

bs_offcanvas_trigger(target, ..., class = NULL)

Arguments

Value

A button tag.

Examples

bs_offcanvas_trigger("menu", "Open menu")

Description

Thin wrappers over bslib::page() / bslib::page_fluid() pinned to Bootstrap 5 that wire in the bootstrict dependency and default theme. Use these as the outermost call of a Shiny UI.

Usage

bs_page(
  ...,
  title = NULL,
  theme = bootstrict_theme(),
  color_mode = NULL,
  lang = "en"
)

bs_page_fluid(
  ...,
  title = NULL,
  theme = bootstrict_theme(),
  color_mode = NULL,
  lang = "en"
)

bs_page_fillable(
  ...,
  title = NULL,
  theme = bootstrict_theme(),
  color_mode = NULL,
  lang = "en"
)

Arguments

Value

A UI definition.

Examples

if (interactive()) {
  bs_page(
    theme = bootstrict_theme(primary = "#ff6600"),
    bs_container(bs_card(bs_card_body("Hello")))
  )
}

Description

A single ⁠<li class="page-item">⁠ carrying a .page-link anchor. Use inside bs_pagination().

Usage

bs_page_item(..., href = "#", active = FALSE, disabled = FALSE, class = NULL)

Arguments

Value

A ⁠<li>⁠ page-item tag.

Examples

bs_page_item("1", href = "#", active = TRUE)

Description

A list of page links, built from bs_page_item()s. For a quick numbered pager use bs_pagination_numbered().

Usage

bs_pagination(
  ...,
  size = NULL,
  align = NULL,
  label = "Page navigation",
  class = NULL
)

Arguments

Value

A ⁠<nav>⁠ pagination tag.

Examples

bs_pagination(
  bs_page_item("Previous", href = "#"),
  bs_page_item("1", href = "#", active = TRUE),
  bs_page_item("2", href = "#"),
  bs_page_item("Next", href = "#")
)

Description

Convenience wrapper around bs_pagination() that lays out a "Previous" control, page numbers ⁠1..n⁠ (the current one active) and a "Next" control.

Usage

bs_pagination_numbered(
  n,
  current = 1,
  ...,
  href_template = NULL,
  size = NULL,
  align = NULL,
  label = "Page navigation",
  class = NULL
)

Arguments

Value

A ⁠<nav>⁠ pagination tag.

Examples

bs_pagination_numbered(5, current = 2)

Description

Bootstrap password input

Usage

bs_password_input(
  id,
  label = NULL,
  value = "",
  ...,
  size = NULL,
  help = NULL,
  width = NULL
)

Arguments

Value

A form control tag.

See Also

shiny::passwordInput()

Description

Loading placeholders ("skeletons") that mimic the shape of content while it loads. Use bs_placeholder() for an individual placeholder and wrap one or more in bs_placeholder_glow() or bs_placeholder_wave() to animate them.

Usage

bs_placeholder(..., width = NULL, color = NULL, size = NULL, class = NULL)

bs_placeholder_glow(..., class = NULL)

bs_placeholder_wave(..., class = NULL)

Arguments

Value

A placeholder tag.

Examples

bs_placeholder_glow(bs_placeholder(width = 6))

Description

Decorates an existing tag with the data attributes Bootstrap needs to render a popover. Popovers are initialised client-side by bootstrict (Bootstrap does not auto-initialise them).

Usage

bs_popover(
  tag,
  content,
  ...,
  title = NULL,
  placement = "right",
  trigger = "click",
  html = FALSE
)

Arguments

Value

The decorated tag, with the bootstrict dependency attached.

Examples

bs_popover(shiny::tags$button("Click me"), "Popover body", title = "Heads up")

Description

A progress display. bs_progress_bar() builds one bar (a .progress track with its .progress-bar); bs_progress() finalises it, or stacks several bars into a Bootstrap 5.3 .progress-stacked group. Progress is display-only (it reports no value to the server); drive it from the server with update_bs_progress().

Usage

bs_progress(..., height = NULL, class = NULL)

bs_progress_bar(
  value = 0,
  ...,
  min = 0,
  max = 100,
  color = NULL,
  striped = FALSE,
  animated = FALSE,
  label = NULL,
  aria_label = NULL,
  id = NULL,
  class = NULL
)

Arguments

Value

A progress tag.

Examples

bs_progress(bs_progress_bar(value = 25, id = "load"))
# stacked (Bootstrap 5.3):
bs_progress(
  bs_progress_bar(value = 15, color = "success"),
  bs_progress_bar(value = 30, color = "danger")
)
bs_progress_bar(value = 75, color = "success", striped = TRUE)

Description

Delegates to shiny::radioButtons() and rewrites the markup to Bootstrap 5 .form-check shape so the value stays available as input$id.

Usage

bs_radio_input(
  id,
  label = NULL,
  choices,
  selected = NULL,
  ...,
  inline = FALSE,
  reverse = FALSE,
  help = NULL,
  width = NULL
)

Arguments

Value

A form control tag.

See Also

shiny::radioButtons()

Examples

bs_radio_input("size", "Size", c("S", "M", "L"), selected = "M")

Description

A native ⁠<input type="range" class="form-range">⁠ whose value is reported to the server as input$id. Drive it server-side with update_bs_range().

Usage

bs_range_input(
  id,
  label = NULL,
  value = NULL,
  min = 0,
  max = 100,
  step = NULL,
  ...,
  help = NULL,
  width = NULL
)

Arguments

Value

A form control tag.

Examples

bs_range_input("vol", "Volume", value = 50, min = 0, max = 100)

Description

Wraps an embedded element (image, iframe, video, ...) so it keeps a fixed aspect ratio (.ratio).

Usage

bs_ratio(..., ratio = "16x9", class = NULL)

Arguments

Value

A ⁠<div>⁠ tag.

Examples

bs_ratio(shiny::tags$iframe(src = "https://example.com"), ratio = "16x9")

Description

Bootstrap grid row

Usage

bs_row(
  ...,
  cols = NULL,
  gutters = NULL,
  gx = NULL,
  gy = NULL,
  justify = NULL,
  align = NULL,
  class = NULL
)

Arguments

Value

A row tag.

Examples

bs_row(bs_col("a"), bs_col("b"), gutters = 3)

Description

Wraps content in a scrollable region whose nav (identified by target) is updated as the user scrolls.

Usage

bs_scrollspy(
  target,
  ...,
  id = NULL,
  offset = NULL,
  smooth = TRUE,
  class = NULL
)

Arguments

Value

A scrollspy container tag, with the bootstrict dependency attached.

Examples

bs_scrollspy("nav-menu", shiny::tags$h4("Section"), offset = 100)

Description

Renders a native Bootstrap 5 ⁠<select class="form-select">⁠ (selectize is disabled to stay faithful to the Bootstrap markup).

Usage

bs_select_input(
  id,
  label = NULL,
  choices = NULL,
  selected = NULL,
  ...,
  multiple = FALSE,
  size = NULL,
  help = NULL,
  width = NULL
)

Arguments

Value

A form control tag.

See Also

shiny::selectInput()

Examples

bs_select_input("fruit", "Fruit", c("Apple", "Pear"))

Description

An animated loading indicator. Render either a spinning border (type = "border") or a pulsing dot (type = "grow"), optionally tinted with a theme colour and shrunk to the small variant.

Usage

bs_spinner(
  type = c("border", "grow"),
  color = NULL,
  size = NULL,
  label = "Loading...",
  ...,
  class = NULL
)

Arguments

Value

A spinner tag.

Examples

bs_spinner(type = "border", color = "primary")

Description

Render a faithful Bootstrap 5 ⁠<table class="table">⁠. Pass a data frame or matrix in data to have the header and body built automatically from its column names and rows; otherwise supply ⁠<thead>⁠/⁠<tbody>⁠ markup (or any table children) through ....

Usage

bs_table(
  data = NULL,
  ...,
  striped = FALSE,
  bordered = FALSE,
  borderless = FALSE,
  hover = FALSE,
  small = FALSE,
  variant = NULL,
  responsive = FALSE,
  align = NULL,
  caption = NULL,
  class = NULL
)

Arguments

Value

A table tag (wrapped in a responsive container when responsive is set).

Examples

bs_table(head(mtcars), striped = TRUE, hover = TRUE)

Description

An interactive set of tabbed panels. The data-value of the currently shown panel is reported to the server as input$id, and the active tab can be driven server-side with update_bs_tabset().

Usage

bs_tabset(
  id,
  ...,
  type = "tabs",
  selected = NULL,
  fill = FALSE,
  justified = FALSE,
  vertical = FALSE,
  class = NULL
)

bs_tab_panel(title, ..., value = NULL, icon = NULL, class = NULL)

Arguments

Value

A tabset tag.

Examples

bs_tabset(
  "tabs",
  bs_tab_panel("Home", "Home content", value = "home"),
  bs_tab_panel("Profile", "Profile content", value = "profile"),
  selected = "profile"
)

Description

Bootstrap text input

Usage

bs_text_input(
  id,
  label = NULL,
  value = "",
  ...,
  placeholder = NULL,
  size = NULL,
  help = NULL,
  width = NULL
)

Arguments

Value

A form control tag.

See Also

shiny::textInput()

Examples

bs_text_input("name", "Your name", placeholder = "Jane Doe")

Description

Bootstrap textarea input

Usage

bs_textarea_input(
  id,
  label = NULL,
  value = "",
  ...,
  placeholder = NULL,
  rows = NULL,
  cols = NULL,
  size = NULL,
  help = NULL,
  width = NULL
)

Arguments

Value

A form control tag.

See Also

shiny::textAreaInput()

Description

A lightweight, dismissible notification. The toast's visibility is reported to the server as input$id (TRUE when shown), and can be driven server-side with show_bs_toast() / hide_bs_toast(). Place one or more toasts inside a bs_toast_container() to position them on screen, or push transient notifications entirely from the server with bs_notify_toast().

Usage

bs_toast(
  id,
  ...,
  title = NULL,
  icon = NULL,
  autohide = TRUE,
  delay = 5000,
  animation = TRUE,
  class = NULL
)

Arguments

Value

A toast tag.

Examples

bs_toast("hello", "Hello, world!", title = "Bootstrict")

Description

A fixed-position container that holds and lays out one or more bs_toast()s.

Usage

bs_toast_container(..., placement = "top-end", class = NULL)

Arguments

Value

A toast container tag.

Examples

bs_toast_container(
  bs_toast("hello", "Hi there", title = "Greeting"),
  placement = "top-end"
)

Description

Decorates an existing tag with the data attributes Bootstrap needs to render a tooltip. Tooltips are initialised client-side by bootstrict (Bootstrap does not auto-initialise them).

Usage

bs_tooltip(tag, title, ..., placement = "top", html = FALSE, trigger = NULL)

Arguments

Value

The decorated tag, with the bootstrict dependency attached.

Examples

bs_tooltip(shiny::tags$button("Hover me"), "Tooltip text")

Description

Inline messages shown next to a control to convey its validation state. bs_valid_feedback() renders .valid-feedback; bs_invalid_feedback() renders .invalid-feedback.

Usage

bs_valid_feedback(..., class = NULL)

bs_invalid_feedback(..., class = NULL)

Arguments

Value

A div tag.

Examples

bs_valid_feedback("Looks good!")
bs_invalid_feedback("Please choose a username.")

Description

Renders content available to assistive technologies but hidden from sighted users (.visually-hidden).

Usage

bs_visually_hidden(..., class = NULL)

Arguments

Value

A ⁠<span>⁠ tag.

Examples

bs_visually_hidden("Loading, please wait")

Description

A vertical divider (.vr), the vertical counterpart of ⁠<hr>⁠.

Usage

bs_vr(class = NULL)

Arguments

Value

A ⁠<div>⁠ tag.

Examples

bs_vr()

Description

Reads a ⁠_variables.scss⁠ style file (the kind a designer exports) and extracts top-level ⁠$name: value;⁠ declarations into a named list suitable for passing to bootstrict_theme() or bslib::bs_theme(). Trailing !default / !global flags and line/block comments are stripped. Values are returned verbatim as strings (Sass resolves them at compile time), so maps, functions and colour expressions all pass straight through.

Usage

parse_scss_variables(path)

Arguments

Value

A named list of Sass variable values. Names use the Bootstrap convention without the leading $ (e.g. primary, font-family-base).

Examples

tmp <- tempfile(fileext = ".scss")
writeLines(c("$primary: #ff6600;", "$border-radius: 0.5rem !default;"), tmp)
parse_scss_variables(tmp)

Description

Sets the Bootstrap 5.3 colour mode (data-bs-theme) on the page body, switching every component between light and dark. Set the initial mode with the color_mode argument of bs_page().

Usage

set_bs_color_mode(mode, session = shiny::getDefaultReactiveDomain())

Arguments

Value

Invisibly NULL, called for its side effect.

Examples

if (interactive()) set_bs_color_mode("dark")

Description

Show, hide or toggle a bs_modal() from server code.

Usage

show_bs_modal(id, session = shiny::getDefaultReactiveDomain())

hide_bs_modal(id, session = shiny::getDefaultReactiveDomain())

toggle_bs_modal(id, session = shiny::getDefaultReactiveDomain())

Arguments

Value

Invisibly NULL, called for its side effect.

Examples

if (interactive()) show_bs_modal("info")
if (interactive()) hide_bs_modal("info")
if (interactive()) toggle_bs_modal("info")

Description

Show, hide or toggle a bs_offcanvas() from server code.

Usage

show_bs_offcanvas(id, session = shiny::getDefaultReactiveDomain())

hide_bs_offcanvas(id, session = shiny::getDefaultReactiveDomain())

toggle_bs_offcanvas(id, session = shiny::getDefaultReactiveDomain())

Arguments

Value

Invisibly NULL, called for its side effect.

Examples

if (interactive()) show_bs_offcanvas("menu")
if (interactive()) hide_bs_offcanvas("menu")
if (interactive()) toggle_bs_offcanvas("menu")

Description

Show or hide a bs_toast() from server code.

Usage

show_bs_toast(id, session = shiny::getDefaultReactiveDomain())

hide_bs_toast(id, session = shiny::getDefaultReactiveDomain())

Arguments

Value

Invisibly NULL, called for its side effect.

Examples

if (interactive()) show_bs_toast("hello")
if (interactive()) hide_bs_toast("hello")

Description

Control an accordion from the server

Usage

update_bs_accordion(
  id,
  open = NULL,
  close = NULL,
  session = shiny::getDefaultReactiveDomain()
)

Arguments

Value

Invisibly NULL, called for its side effect.

Description

Control a carousel from the server

Usage

update_bs_carousel(
  id,
  to = NULL,
  slide = NULL,
  session = shiny::getDefaultReactiveDomain()
)

Arguments

Value

Invisibly NULL, called for its side effect.

Examples

## Not run: 
update_bs_carousel("demo", to = 2)
update_bs_carousel("demo", slide = "next")

## End(Not run)

Description

Show, hide or toggle a bs_collapse() from server code.

Usage

update_bs_collapse(
  id,
  action = c("toggle", "show", "hide"),
  session = shiny::getDefaultReactiveDomain()
)

Arguments

Value

Invisibly NULL, called for its side effect.

Examples

if (interactive()) update_bs_collapse("more", "show")

Description

Routes through shiny::session's sendInputMessage() so the colour binding's receiveMessage updates the swatch.

Usage

update_bs_color(id, value, session = shiny::getDefaultReactiveDomain())

Arguments

Value

Invisibly NULL, called for its side effect.

Examples

if (interactive()) update_bs_color("col", "#198754")

Description

Activates the item whose value matches selected in a selectable bs_list_group() (one created with an id).

Usage

update_bs_list_group(
  id,
  selected = NULL,
  session = shiny::getDefaultReactiveDomain()
)

Arguments

Value

Invisibly NULL, called for its side effect.

Examples

## Not run: 
update_bs_list_group("my_group", selected = "two")

## End(Not run)

Description

Update a progress bar from the server

Usage

update_bs_progress(
  id,
  value = NULL,
  label = NULL,
  color = NULL,
  min = NULL,
  max = NULL,
  session = shiny::getDefaultReactiveDomain()
)

Arguments

Value

Invisibly NULL, called for its side effect.

Examples

## Not run: 
update_bs_progress("load", value = 80)

## End(Not run)

Description

Routes through shiny::session's sendInputMessage() so the range binding's receiveMessage updates the slider (the "shiny-like" update path).

Usage

update_bs_range(id, value, session = shiny::getDefaultReactiveDomain())

Arguments

Value

Invisibly NULL, called for its side effect.

Examples

if (interactive()) update_bs_range("vol", 75)

Description

Control a tabset from the server

Usage

update_bs_tabset(id, selected, session = shiny::getDefaultReactiveDomain())

Arguments

Value

Invisibly NULL, called for its side effect.

Examples

## Not run: 
update_bs_tabset("tabs", selected = "profile")

## End(Not run)

Description

Returns the bootstrict HTML dependency (Shiny input bindings + supporting CSS) so it can be dropped anywhere in a UI. Page constructors such as bs_page() call this for you; use it directly when embedding bootstrict widgets into a UI you build by hand.

Usage

use_bootstrict()

Value

An htmltools::htmlDependency.

Description

A golem::create_golem() project_hook that turns a freshly created golem skeleton into a minimal bootstrict application:

Usage

use_bootstrict_golem(path, package_name, ...)

Arguments

Details

• R/app_ui.R is rewritten to use bs_page() and shows a "Hello world" inside a bs_container().

• An (empty by default) ⁠inst/app/www/_variables.scss⁠ designer variable sheet is created and wired into bootstrict_theme(), so a designer can drop SCSS variables (⁠$name: value;⁠) in and have them picked up automatically.

golem sets the working directory to the new project before calling the hook, so every path below is relative to the application root.

Value

Invisibly NULL. Called for its side effects on the project files.

Examples

if (interactive()) {
  golem::create_golem(
    "my.app",
    project_hook = bootstrict::use_bootstrict_golem
  )
}