These functions are small wrappers around shiny's page constructors (i.e., shiny::fluidPage()
, shiny::navbarPage()
, etc) that differ in two ways:
The
theme
parameter defaults bslib's recommended version of Bootstrap (for new projects).The return value is rendered as an static HTML page when printed interactively at the console.
Usage
page(..., title = NULL, theme = bs_theme(), lang = NULL)
page_fluid(..., title = NULL, theme = bs_theme(), lang = NULL)
page_fixed(..., title = NULL, theme = bs_theme(), lang = NULL)
page_fillable(
...,
padding = NULL,
gap = NULL,
fillable_mobile = FALSE,
title = NULL,
theme = bs_theme(),
lang = NULL
)
page_navbar(
...,
title = NULL,
id = NULL,
selected = NULL,
sidebar = NULL,
fillable = TRUE,
fillable_mobile = FALSE,
gap = NULL,
padding = NULL,
position = c("static-top", "fixed-top", "fixed-bottom"),
header = NULL,
footer = NULL,
bg = NULL,
inverse = "auto",
underline = TRUE,
collapsible = TRUE,
fluid = TRUE,
theme = bs_theme(),
window_title = NA,
lang = NULL
)
Arguments
- ...
The contents of the document body.
- title
The browser window title (defaults to the host URL of the page)
- theme
A
bs_theme()
object.- 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.- padding
Padding to use for the body. This can be a numeric vector (which will be interpreted as pixels) or a character vector with valid CSS lengths. The length can be between one and four. If one, then that value will be used for all four sides. If two, then the first value will be used for the top and bottom, while the second value will be used for left and right. If three, then the first will be used for top, the second will be left and right, and the third will be bottom. If four, then the values will be interpreted as top, right, bottom, and left respectively.
- gap
A CSS length unit defining the
gap
(i.e., spacing) between elements provided to...
.- fillable_mobile
Whether or not
fillable
pages should fill the viewport's height on mobile devices (i.e., narrow windows).- id
a character string used for dynamically updating the container (see
nav_select()
).- selected
a character string matching the
value
of a particularnav_panel()
item to selected by default.- sidebar
A
sidebar()
component to display on everynav_panel()
page.- fillable
Whether or not to allow
fill
items to grow/shrink to fit the browser window. IfTRUE
, allnav_panel()
pages arefillable
. A character vector, matching thevalue
ofnav_panel()
s to be filled, may also be provided. Note that, if asidebar
is provided,fillable
makes the main content portion fillable.- 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
UI element(s) (tags) to display above the nav content.
- footer
UI element(s) (tags) to display below the nav content.
- bg
a CSS color to use for the navbar's background color.
- inverse
Either
TRUE
for a light text color orFALSE
for a dark text color. If"auto"
(the default), the best contrast tobg
is chosen.- underline
Whether or not to add underline styling to page links when active or focused.
- collapsible
TRUE
to automatically collapse the navigation elements into an expandable menu on mobile devices or narrow window widths.- fluid
TRUE
to use fluid layout;FALSE
to use fixed layout.- window_title
the browser window title. The default value,
NA
, means to use any character strings that appear intitle
(if none are found, the host URL of the page is displayed by default).