Package {bs4Dashkit}

Interactive bs4Dashkit demo app

Description

Returns a richer runnable shiny.appobj for testing sidebar brand states, hover-expand behavior, theme presets, navbar controls, and footer styling in one place.

Usage

bs4dashkit_demo_app()

Value

A shiny.appobj.

Minimal bs4Dashkit example app

Description

Returns a tiny runnable shiny.appobj that demonstrates the recommended dash_titles() plus use_bs4Dashkit_core() flow.

Usage

bs4dashkit_example_app()

Value

A shiny.appobj.

Built-in bs4Dashkit theme presets

Description

Returns the theme presets shipped with bs4Dashkit so they are easy to discover in code completion, validation errors, and documentation.

Usage

bs4dashkit_theme_presets(values = FALSE)

Arguments

Value

A data frame with one row per preset and columns preset and description. If values = TRUE, the returned data frame also includes a tokens list-column.

Brand options for bs4Dashkit titles

Description

Creates a reusable brand configuration that can be converted to dash_titles() output with dash_titles_from().

Usage

dash_brand_options(
  name,
  icon = NULL,
  collapsed = NULL,
  expanded = NULL,
  app_name = NULL,
  collapsed_mode = NULL,
  expanded_mode = NULL,
  ...
)

Arguments

Value

A bs4dashkit_brand_options object.

Create sidebar / navbar brand UI

Description

Produces an icon + text block for bs4Dash brand slots with rich styling and optional visual effects. Supports Font Awesome icons or image logos.

Usage

dash_brand_ui(
  brand_text,
  icon = NULL,
  icon_img = NULL,
  icon_shape = c("circle", "rounded", "square"),
  icon_size = NULL,
  icon_color = NULL,
  weight = 700,
  spacing = "-0.02em",
  size = NULL,
  italic = FALSE,
  font_family = NULL,
  color = NULL,
  gradient = NULL,
  effect = c("none", "glow", "shimmer", "emboss"),
  glow_color = NULL
)

Arguments

Value

A named list with components:

ui

A shiny.tag.list containing the generated brand UI.

dep

A shiny.tag object containing scoped CSS dependencies for the brand styling.

Standard footer for bs4Dash dashboards

Description

Standard footer for bs4Dash dashboards

Usage

dash_footer(
  logo_src = NULL,
  left_text = NULL,
  right_text = NULL,
  right_date = NULL,
  date_format = "%B %d, %Y",
  logo_height = 20,
  logo_position = c("left", "right"),
  fixed = TRUE
)

Arguments

Value

A shiny.tag object representing a bs4DashFooter UI component.

Navbar help button (styled)

Description

Navbar help button (styled)

Usage

dash_nav_help_button(
  id,
  label = "Help",
  icon = "circle-question",
  class = NULL,
  ...
)

Arguments

Value

A shiny.tag object representing a styled navbar action button.

Navbar help item (complete bs4Dash rightUi child)

Description

Navbar help item (complete bs4Dash rightUi child)

Usage

dash_nav_help_item(
  id,
  label = "Help",
  icon = "circle-question",
  class = NULL,
  ...
)

Arguments

Value

A complete <li class="nav-item dropdown"> navbar child for use in bs4DashNavbar(rightUi = ...).

Wrap a navbar control in a list item (bs4Dash rightUi convention)

Description

Wrap a navbar control in a list item (bs4Dash rightUi convention)

Usage

dash_nav_item(...)

Arguments

Value

A shiny.tag object containing an HTML list item for use in bs4Dash navbar UI.

Navbar refresh button (styled)

Description

Navbar refresh button (styled)

Usage

dash_nav_refresh_button(
  id,
  label = "Refresh",
  icon = "rotate-right",
  class = NULL,
  ...
)

Arguments

Value

A shiny.tag object representing a styled navbar refresh button.

Navbar refresh item (complete bs4Dash rightUi child)

Description

Navbar refresh item (complete bs4Dash rightUi child)

Usage

dash_nav_refresh_item(
  id,
  label = "Refresh",
  icon = "rotate-right",
  class = NULL,
  ...
)

Arguments

Value

A complete <li class="nav-item dropdown"> navbar child for use in bs4DashNavbar(rightUi = ...).

Navbar status badge

Description

Navbar status badge

Usage

dash_nav_status_badge(
  label,
  status = c("success", "primary", "secondary", "info", "warning", "danger", "light",
    "dark"),
  icon = NULL,
  class = NULL
)

Arguments

Value

A shiny.tag badge suitable for wrapping in dash_nav_item().

Navbar status item (complete bs4Dash rightUi child)

Description

Navbar status item (complete bs4Dash rightUi child)

Usage

dash_nav_status_item(
  label,
  status = c("success", "primary", "secondary", "info", "warning", "danger", "light",
    "dark"),
  icon = NULL,
  class = NULL
)

Arguments

Value

A complete <li class="nav-item dropdown"> navbar child for use in bs4DashNavbar(rightUi = ...).

Navbar title (center, right, or left)

Description

Creates a consistent title block for bs4Dash navbars, with optional subtitle and icon. Alignment can be "center", "right", or "left".

Usage

dash_nav_title(
  title,
  subtitle = NULL,
  icon = NULL,
  align = c("center", "right", "left")
)

Arguments

Details

IMPORTANT:

• align = "left" is intended to be placed in dashboardHeader(leftUi = ...)

• align = "right" is intended to be placed in dashboardHeader(rightUi = ...)

• align = "center" can be placed anywhere (it is positioned by CSS/JS)

Value

A shiny.tag object representing the navbar title UI.

Dashboard brand and sidebar configuration

Description

Single entry point for branding and sidebar brand behavior. Creates a reusable object you place into bs4DashPage(), bs4DashNavbar(), and bs4DashBody().

Usage

dash_titles(
  brand_text,
  app_name = NULL,
  icon = NULL,
  icon_img = NULL,
  icon_shape = c("circle", "rounded", "square"),
  icon_size = NULL,
  icon_color = NULL,
  weight = 700,
  spacing = "-0.02em",
  size = NULL,
  italic = FALSE,
  font_family = NULL,
  color = NULL,
  gradient = NULL,
  effect = c("none", "glow", "shimmer", "emboss"),
  glow_color = NULL,
  collapsed = NULL,
  expanded = NULL,
  collapsed_text = NULL,
  expanded_text = NULL,
  collapsed_text_size = NULL,
  expanded_text_size = NULL,
  collapsed_text_weight = NULL,
  expanded_text_weight = NULL,
  brand_divider = NULL,
  debug = NULL
)

Arguments

Value

A named list with components:

app_name

A character string for use in bs4DashPage(title = ...).

brand

A shiny.tag object for use in bs4DashNavbar(title = ...). In a standard bs4DashPage(), the sidebar brand mirrors the navbar brand automatically.

deps

A shiny.tag.list containing CSS and JavaScript dependencies to include once in bs4DashBody(...).

Create dashboard titles from brand options

Description

Create dashboard titles from brand options

Usage

dash_titles_from(brand, ...)

Arguments

Value

A named list with app_name, brand, and deps; see dash_titles().

Top navigation options

Description

Bundles the top-navigation settings used by use_bs4Dashkit_core(layout = "topnav"). This keeps app setup compact while preserving the same options accepted by use_dash_topnav().

Usage

dash_topnav_options(
  align = c("left", "center", "right"),
  gap = 0,
  style = c("underline", "pill", "compact"),
  mobile = c("collapse", "scroll"),
  overflow = c("auto", "more", "scroll"),
  more_after = Inf,
  title = c("auto", "show", "compact", "hide"),
  page_title = c("none", "tab"),
  brand = TRUE,
  debug = FALSE
)

Arguments

Value

A named list with class bs4dashkit_topnav_options.

Examples

dash_topnav_options(
  align = "left",
  gap = 6,
  style = "compact",
  mobile = "collapse",
  overflow = "more",
  more_after = 4,
  title = "auto",
  page_title = "tab"
)

Standard wrapper for a navbar user menu

Description

Standard wrapper for a navbar user menu

Usage

dash_user_menu(ui)

Arguments

Value

A shiny.tag object representing the user menu UI for the navbar.

Internal helper: get bs4Dashkit option with fallback

Description

Internal helper: get bs4Dashkit option with fallback

Usage

dashkit_opt(name, default = NULL)

Ensure bs4Dashkit resource path is registered

Description

Ensure bs4Dashkit resource path is registered

Usage

dashkit_register_resources()

Load core CSS and JS for bs4Dashkit

Description

Adds the package's bundled CSS (core, theme, sidebar) and optional JS helpers. All assets are attached as named htmltools::htmlDependency objects, so they are included once per page regardless of how many bs4Dashkit helpers request them.

Usage

use_bs4Dashkit(include_center_js = TRUE)

Arguments

Value

A htmltools::tagList containing htmltools::htmlDependency objects for the package CSS and optional JavaScript helpers.

Load bs4Dashkit core dependencies in one call

Description

Recommended entry point for bs4Dashkit in bs4DashBody(). For most apps, this should be the first element inside bs4DashBody(...).

Usage

use_bs4Dashkit_core(
  ttl,
  preset = NULL,
  accent = NULL,
  ...,
  topbar_h = 56,
  collapsed_w = 4.2,
  expanded_w = 250,
  layout = c("sidebar", "topnav"),
  topnav = NULL,
  topnav_align = c("left", "center", "right"),
  topnav_gap = 0,
  topnav_style = c("underline", "pill", "compact"),
  topnav_mobile = c("collapse", "scroll"),
  topnav_overflow = c("auto", "more", "scroll"),
  topnav_more_after = Inf,
  topnav_title = c("auto", "show", "compact", "hide"),
  topnav_page_title = c("none", "tab"),
  topnav_brand = TRUE,
  topnav_debug = FALSE
)

Arguments

Value

A shiny.tag.list containing core CSS and/or JavaScript dependencies for bs4Dashkit.

Sidebar behavior: icon-only collapse + hover expand + ellipsis labels

Description

Sidebar behavior: icon-only collapse + hover expand + ellipsis labels

Usage

use_dash_sidebar_behavior(topbar_h = 56, collapsed_w = 4.2, expanded_w = 250)

Arguments

Value

A shiny.tag or shiny.tag.list containing sidebar behavior dependencies to include in the UI.

Toggle the sidebar header divider (line under the brand area)

Description

Toggle the sidebar header divider (line under the brand area)

Usage

use_dash_sidebar_brand_divider(show = TRUE)

Arguments

Value

If show is TRUE, an empty shiny.tag.list. If show is FALSE, a shiny.tag object containing CSS that hides the sidebar brand divider.

Set sidebar brand display mode for expanded and collapsed states

Description

Controls icon visibility, text visibility, and text content in both collapsed and expanded sidebar states.

Usage

use_dash_sidebar_brand_mode(
  icon = NULL,
  collapsed = c("icon-only", "icon-text", "text-only"),
  expanded = c("icon-text", "icon-only", "text-only"),
  collapsed_text = NULL,
  expanded_text = NULL,
  collapsed_text_size = NULL,
  expanded_text_size = NULL,
  collapsed_text_weight = NULL,
  expanded_text_weight = NULL,
  debug = FALSE
)

Arguments

Details

Modes:

• "icon-only" : icon shown, label hidden — requires icon

• "text-only" : label shown, icon hidden — collapsed_text / expanded_text optional

• "icon-text" : both shown — requires icon; text args optional

Value

A shiny.tag or shiny.tag.list containing sidebar brand mode styling or dependencies.

Apply a theme via CSS variables

Description

Sets bs4Dashkit CSS custom properties (variables) for background, surfaces, borders, text, and accent color.

Usage

use_dash_theme(
  bg = "#f5f6f8",
  surface = "#ffffff",
  border = "#e2e3e7",
  text = "#1d1f23",
  muted = "#6b6f76",
  accent = "#2f6f8f",
  accent_soft = "#e8f1f5",
  navbar_bg = "#ffffff",
  navbar_text = "#1d1f23",
  sidebar_bg = "#ffffff",
  sidebar_text = "#1d1f23",
  sidebar_hover = "#eef4f7",
  footer_bg = "#ffffff",
  footer_text = "#6b6f76",
  success = "#2d8a56",
  warning = "#c37a14",
  danger = "#b94a48",
  radius = 12,
  shadow = "0 1px 3px rgba(0,0,0,0.07)"
)

Arguments

Value

A shiny.tag.list containing stylesheet dependencies and inline CSS variables for the app theme.

Apply a theme preset

Description

Apply a theme preset

Usage

use_dash_theme_preset(preset = c("professional", "modern", "dark-lite"), ...)

Arguments

Value

A shiny.tag or shiny.tag.list containing theme preset CSS and related UI dependencies.

Top navigation layout: replace the sidebar with a navbar menu

Description

Turns a regular bs4Dash app into a top-navigation app, similar to bslib::page_navbar(). The sidebar is hidden and its menu is mirrored as a horizontal menu inside the navbar. Clicks on the horizontal menu are delegated back to the original sidebar links, so everything wired to the sidebar keeps working: ⁠input$<sidebarMenu id>⁠, bs4Dash::updateTabItems(), badges, and bookmarking.

Usage

use_dash_topnav(
  topbar_h = 56,
  align = c("left", "center", "right"),
  gap = 0,
  style = c("underline", "pill", "compact"),
  mobile = c("collapse", "scroll"),
  overflow = c("auto", "more", "scroll"),
  more_after = Inf,
  title = c("auto", "show", "compact", "hide"),
  page_title = c("none", "tab"),
  brand = TRUE,
  debug = FALSE
)

Arguments

Details

Keep your app exactly as it is - bs4DashSidebar(), bs4SidebarMenu(), bs4TabItems() - and add use_dash_topnav() (or use_bs4Dashkit_core(layout = "topnav")) to the body. The sidebar stays in the DOM as the single source of truth but is never shown.

Menu items with sub-items (bs4SidebarMenuSubItem()) are rendered as navbar dropdowns. Menus rendered on the fly (renderMenu()) and updates via updateTabItems() are picked up automatically.

On screens narrower than 992px the menu stays on one horizontally scrollable row instead of collapsing into a hamburger.

Value

A shiny.tag.list with the top-nav CSS/JS dependencies and the initialization script. Include it once in bs4DashBody(...).

Examples

if (interactive()) {
  library(shiny)
  library(bs4Dash)

  ttl <- dash_titles(brand_text = "Top-nav demo", icon = icon("bolt"))

  ui <- bs4DashPage(
    title = ttl$app_name,
    header = bs4DashNavbar(title = ttl$brand),
    sidebar = bs4DashSidebar(
      bs4SidebarMenu(
        id = "sidebar",
        bs4SidebarMenuItem("Home", tabName = "home", icon = icon("house")),
        bs4SidebarMenuItem("Data", tabName = "data", icon = icon("table"))
      )
    ),
    body = bs4DashBody(
      use_bs4Dashkit_core(ttl, preset = "professional", layout = "topnav"),
      bs4TabItems(
        bs4TabItem(tabName = "home", "Home content"),
        bs4TabItem(tabName = "data", "Data content")
      )
    )
  )

  shinyApp(ui, function(input, output, session) {})
}

Validate bs4Dash navbar rightUi structure

Description

Checks that each direct child supplied to bs4DashNavbar(rightUi = ...) is a complete navbar list item with the dropdown class expected by bs4Dash/AdminLTE.

Usage

validate_bs4dash_navbar(rightUi)

Arguments

Value

Invisibly returns TRUE when valid; otherwise errors with a targeted message.