Please note that if you are viewing this page at this package's pkgdown site, despite the "released" tag, this site represents a recent development version of this package. The most-recent version of the development package has its own pkgdown site.
You can install the latest released version from CRAN with:
or the latest development version from GitHub with:
# install.packages("devtools") devtools::install_github("ijlyttle/bsplus")
To see all of this in action, you are referred to the getting-started article at this package's pkgdown site.
The goals of this package are:
- to provide functions that work for both rmarkdown HTML documents and for shiny apps - the only exceptions are some functions that work with only the UI side of shiny.
- to promote composition of HTML using pipes.
This family of functions lets you build another dimension to your shiny apps, although you can still use it rmarkdown HTML documents, explained further in this article.
These functions make it easier to incorporate help-documentation into your shiny apps - functions for incorporating tooltips, popovers, and modals into the labels of shiny inputs, explained further in this article.
In this package, there are function families for:
- collapsible elements:
- accordion panels:
- accordion-sidebar sets:
There are also helper functions:
- embed help-links into shiny inputs:
aria-attributes of tags:
Grammar and vocabulary
One of the goals of this package is to implement consistent grammar and vocabulary. To keep the namespace clean(er), many of the functions have the prefix
Let's start with the conventions used to name the functions:
bs_noun(), used to create a
tag. For example, use
bs_accordion()to create an accordion panel-set.
bs_verb(tag, ...), used to take an action on a
tag. For example, use
bs_append()to append a panel to an accordion panel-set.
bs_verb_noun(tag, ...)used to take an action on a
thing. For example, use
bs_embed_tooltip()to embed a tooltip into a
useShinyJS(). This is necessary for
bs_embed_popover()to work properly.
Often we use the words element and tag interchangeably - we are talking about HTML elements. In the grammar of this documentation (and package), it can be useful to think about direct objects and indirect objects, so the word tag is used to denote direct objects, and the words element or thing are used to denote indirect objects.
In the context of a set of piped functions, the first argument will always be the direct object; the name of the first argument of many functions is
tag - you will be sending the tag through the pipe.
bs_append(tag, ...)used to append something to a tag, perhaps a panel into an accordion-group.
bs_attach_foo(tag, ...)used to attach the
idof an element (foo) to another tag, for example, you could create a modal window using
bs_modal(), then you could attach the
idof the modal window to the tag using
bs_emded_foo(tag, ...)used to embed something (a foo) into a tag, for example,
bs_set_opts(tag, ...)used to set some options for the items yet to be appended to a tag.
Let's consider the differences between
- You can append more than one element to a tag, i.e., you could append multiple panels to an accordion-group.
- You can attach only one id of a thing to a tag. When we are attaching, we attach the
idof an element, not the element itself. However, we can attach an
idof an element to more than one tag.
- You can embed only one thing into a tag. i.e., into a given tag, you can embed a tooltip or a popover, modifying the tag's attributes and setting a child element in the tag.
Code of conduct
Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.