nav-items: Navigation items

In bslib: Custom 'Bootstrap' 'Sass' Themes for 'shiny' and 'rmarkdown'

Navigation items

Description

Create nav item(s) for use inside nav containers (e.g., navset_tab(), navset_bar(), etc).

Usage

nav_panel(title, ..., value = title, icon = NULL)

nav_panel_hidden(value, ..., icon = NULL)

nav_menu(title, ..., value = title, icon = NULL, align = c("left", "right"))

nav_item(...)

nav_spacer()

Arguments

title	A title to display. Can be a character string or UI elements (i.e., htmltools::tags).
...	Depends on the function: For nav_panel() and nav_panel_hidden(): UI elements (i.e., htmltools::tags) to display when the item is active. For nav_menu(): a collection of nav items (e.g., nav_panel(), nav_item()). For nav_item(): UI elements (i.e., htmltools::tags) to place directly in the navigation panel (e.g., search forms, links to external content, etc).
value	A character string to assign to the nav item. This value may be supplied to the relevant container's selected argument in order to show particular nav item's content immediately on page load. This value is also useful for programmatically updating the selected content via nav_select(), nav_hide(), etc (updating selected tabs this way is often useful for showing/hiding panels of content via other UI controls like shiny::radioButtons() – in this scenario, consider using nav_panel_hidden() with navset_hidden()).
icon	Optional icon to appear next to the nav item's title.
align	horizontal alignment of the dropdown menu relative to dropdown toggle.

Value

A nav item that may be passed to a nav container (e.g. navset_tab()).

Functions

• nav_panel(): Content to display when the given item is selected.

• nav_panel_hidden(): Create nav content for use inside navset_hidden() (for creating custom navigation controls via navs_select()),

• nav_menu(): Create a menu of nav items.

• nav_item(): Place arbitrary content in the navigation panel (e.g., search forms, links to external content, etc.)

• nav_spacer(): Adding spacing between nav items.

See Also

navset create the navigation container holding the nav panels.

nav_menu(), nav_item(), nav_spacer() create menus, items, or space in the navset control area.

nav_insert(), nav_remove() programmatically add or remove nav panels.

nav_select(), nav_show(), nav_hide() change the state of a nav_panel() in a navset.

Other Panel container functions: nav_select(), navset

bslib documentation built on April 3, 2025, 10:15 p.m.