mirror of
https://github.com/rstudio/shiny.git
synced 2026-02-03 03:05:13 -05:00
e9fc873c8d
These functions were temporarily ripped out of Shiny and moved to the htmltools package. We've discovered that it's safe to keep including them in shiny; as long as the functions in shiny and the functions in htmltools are identical, the user won't receive a conflict warning.
79 lines
2.3 KiB
R
79 lines
2.3 KiB
R
% Generated by roxygen2 (4.0.1): do not edit by hand
|
|
\name{navbarPage}
|
|
\alias{navbarMenu}
|
|
\alias{navbarPage}
|
|
\title{Create a page with a top level navigation bar}
|
|
\usage{
|
|
navbarPage(title, ..., id = NULL, header = NULL, footer = NULL,
|
|
inverse = FALSE, collapsable = FALSE, fluid = TRUE, responsive = TRUE,
|
|
theme = NULL)
|
|
|
|
navbarMenu(title, ..., icon = NULL)
|
|
}
|
|
\arguments{
|
|
\item{title}{The title to display in the navbar}
|
|
|
|
\item{...}{\code{\link{tabPanel}} elements to include in the page}
|
|
|
|
\item{id}{If provided, you can use \code{input$}\emph{\code{id}} in your
|
|
server logic to determine which of the current tabs is active. The value
|
|
will correspond to the \code{value} argument that is passed to
|
|
\code{\link{tabPanel}}.}
|
|
|
|
\item{header}{Tag of list of tags to display as a common header above all
|
|
tabPanels.}
|
|
|
|
\item{footer}{Tag or list of tags to display as a common footer below all
|
|
tabPanels}
|
|
|
|
\item{inverse}{\code{TRUE} to use a dark background and light text for the
|
|
navigation bar}
|
|
|
|
\item{collapsable}{\code{TRUE} to automatically collapse the navigation
|
|
elements into a menu when the width of the browser is less than 940 pixels
|
|
(useful for viewing on smaller touchscreen device)}
|
|
|
|
\item{fluid}{\code{TRUE} to use a fluid layout. \code{FALSE} to use a fixed
|
|
layout.}
|
|
|
|
\item{responsive}{\code{TRUE} to use responsive layout (automatically adapt
|
|
and resize page elements based on the size of the viewing device)}
|
|
|
|
\item{theme}{Alternative Bootstrap stylesheet (normally a css file within the
|
|
www directory). For example, to use the theme located at
|
|
\code{www/bootstrap.css} you would use \code{theme = "bootstrap.css"}.}
|
|
|
|
\item{icon}{Optional icon to appear on a \code{navbarMenu} tab.}
|
|
}
|
|
\value{
|
|
A UI defintion that can be passed to the \link{shinyUI} function.
|
|
}
|
|
\description{
|
|
Create a page that contains a top level navigation bar that can be used to
|
|
toggle a set of \code{\link{tabPanel}} elements.
|
|
}
|
|
\details{
|
|
The \code{navbarMenu} function can be used to create an embedded
|
|
menu within the navbar that in turns includes additional tabPanels (see
|
|
example below).
|
|
}
|
|
\examples{
|
|
shinyUI(navbarPage("App Title",
|
|
tabPanel("Plot"),
|
|
tabPanel("Summary"),
|
|
tabPanel("Table")
|
|
))
|
|
|
|
shinyUI(navbarPage("App Title",
|
|
tabPanel("Plot"),
|
|
navbarMenu("More",
|
|
tabPanel("Summary"),
|
|
tabPanel("Table")
|
|
)
|
|
))
|
|
}
|
|
\seealso{
|
|
\code{\link{tabPanel}}, \code{\link{tabsetPanel}}
|
|
}
|
|
|