navbarPage: Create a page with a top level navigation bar
In shiny: Web Application Framework for R

navbarPage

R Documentation

Create a page with a top level navigation bar

Description

Create a page that contains a top level navigation bar that can be used to toggle a set of tabPanel() elements.

Usage

navbarPage(
  title,
  ...,
  id = NULL,
  selected = NULL,
  position = c("static-top", "fixed-top", "fixed-bottom"),
  header = NULL,
  footer = NULL,
  inverse = FALSE,
  collapsible = FALSE,
  fluid = TRUE,
  theme = NULL,
  windowTitle = NA,
  lang = NULL
)

navbarMenu(title, ..., menuName = title, icon = NULL)

Arguments

`title`	The title to display in the navbar
`...`	`tabPanel()` elements to include in the page. The `navbarMenu` function also accepts strings, which will be used as menu section headers. If the string is a set of dashes like `"----"` a horizontal separator will be displayed in the menu.
`id`	If provided, you can use `⁠input$⁠``id` in your server logic to determine which of the current tabs is active. The value will correspond to the `value` argument that is passed to `tabPanel()`.
`selected`	The `value` (or, if none was supplied, the `title`) of the tab that should be selected by default. If `NULL`, the first tab will be selected.
`position`	Determines whether the navbar should be displayed at the top of the page with normal scrolling behavior (`"static-top"`), pinned at the top (`"fixed-top"`), or pinned at the bottom (`"fixed-bottom"`). Note that using `"fixed-top"` or `"fixed-bottom"` will cause the navbar to overlay your body content, unless you add padding, e.g.: `tags$style(type="text/css", "body {padding-top: 70px;}")`
`header`	Tag or list of tags to display as a common header above all tabPanels.
`footer`	Tag or list of tags to display as a common footer below all tabPanels
`inverse`	`TRUE` to use a dark background and light text for the navigation bar
`collapsible`	`TRUE` to automatically collapse the navigation elements into an expandable menu on mobile devices or narrow window widths.
`fluid`	`TRUE` to use a fluid layout. `FALSE` to use a fixed layout.
`theme`	One of the following: `NULL` (the default), which implies a "stock" build of Bootstrap 3. A `bslib::bs_theme()` object. This can be used to replace a stock build of Bootstrap 3 with a customized version of Bootstrap 3 or higher. A character string pointing to an alternative Bootstrap stylesheet (normally a css file within the www directory, e.g. `www/bootstrap.css`).
`windowTitle`	the browser window title (as a character string). The default value, `NA`, means to use any character strings that appear in `title` (if none are found, the host URL of the page is displayed by default).
`lang`	ISO 639-1 language code for the HTML page, such as "en" or "ko". This will be used as the lang in the `<html>` tag, as in `<html lang="en">`. The default (NULL) results in an empty string.
`menuName`	A name that identifies this `navbarMenu`. This is needed if you want to insert/remove or show/hide an entire `navbarMenu`.
`icon`	Optional icon to appear on a `navbarMenu` tab.

Details

The navbarMenu function can be used to create an embedded menu within the navbar that in turns includes additional tabPanels (see example below).

Value

A UI definition that can be passed to the shinyUI function.

Examples

navbarPage("App Title",
  tabPanel("Plot"),
  tabPanel("Summary"),
  tabPanel("Table")
)

navbarPage("App Title",
  tabPanel("Plot"),
  navbarMenu("More",
    tabPanel("Summary"),
    "----",
    "Section header",
    tabPanel("Table")
  )
)

shiny documentation built on Sept. 11, 2024, 7:24 p.m.