Skip to content

Commit

Permalink
update links, cran comments
Browse files Browse the repository at this point in the history
  • Loading branch information
ijlyttle committed Jun 24, 2020
1 parent c12a9bd commit 1820eda
Show file tree
Hide file tree
Showing 24 changed files with 42 additions and 37 deletions.
2 changes: 1 addition & 1 deletion R/accordion.R
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@
#' bs_set_opts(panel_type = "info") %>%
#' bs_append(title = "Paul McCartney", content = "Bass guitar, vocals")
#'
#' @seealso <http://getbootstrap.com/javascript/#collapse-example-accordion>
#' @seealso <http://getbootstrap.com/docs/3.3/javascript/#collapse-example-accordion>
#' @export
#
bs_accordion <- function(id){
Expand Down
2 changes: 1 addition & 1 deletion R/button.R
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
#' @return Object with S3 class, `shiny.tag`, `<button/>`.
#' @examples
#' bs_button("Click me", button_type = "primary", button_size = "small")
#' @seealso <http://getbootstrap.com/css/#buttons>
#' @seealso <http://getbootstrap.com/docs/3.3/css/#buttons>
#' @export
#'
bs_button <- function(
Expand Down
2 changes: 1 addition & 1 deletion R/carousel.R
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@
#' bs_append(content = bs_carousel_image(src = "img/george.jpg")) %>%
#' bs_append(content = bs_carousel_image(src = "img/ringo.jpg"))
#'
#' @seealso <http://getbootstrap.com/javascript/#carousel>,
#' @seealso <http://getbootstrap.com/docs/3.3/javascript/#carousel>,
#' [bs_carousel_image()], [bs_carousel_caption()]
#'
#' @export
Expand Down
2 changes: 1 addition & 1 deletion R/collapse.R
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@
#' bs_button("She Loves You", button_type = "primary") %>%
#' bs_attach_collapse("id_yeah")
#'
#' @seealso <https://getbootstrap.com/javascript/#collapse>
#' @seealso <https://getbootstrap.com/docs/3.3/javascript/#collapse>
#'
#' @export
#'
Expand Down
2 changes: 1 addition & 1 deletion R/embed_popover.R
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
#'
#' @return `htmltools::[tag][htmltools::tag]`, modified copy of `tag`
#' @seealso [bs_embed_tooltip()],
#' <http://getbootstrap.com/javascript/#popovers>
#' <http://getbootstrap.com/docs/3.3/javascript/#popovers>
#' @examples
#' library("htmltools")
#'
Expand Down
2 changes: 1 addition & 1 deletion R/embed_tooltip.R
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
#' @param ... other named arguments, passed to `bs_set_data()`
#'
#' @return `htmltools::[tag][htmltools::tag]`, modified copy of `tag`
#' @seealso [bs_embed_popover()], <http://getbootstrap.com/javascript/#tooltips>
#' @seealso [bs_embed_popover()], <http://getbootstrap.com/docs/3.3/javascript/#tooltips>
#' @examples
#' library("htmltools")
#' bs_button("I'm a button") %>%
Expand Down
2 changes: 1 addition & 1 deletion R/panel.R
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
#' heading = tags$h3("title"),
#' body = tags$p("Some very important content")
#' )
#' @seealso <http://getbootstrap.com/css/#panels>
#' @seealso <http://getbootstrap.com/docs/3.3/css/#panels>
#' @export
#'
bs_panel <- function(
Expand Down
2 changes: 1 addition & 1 deletion R/set_attr.R
Original file line number Diff line number Diff line change
Expand Up @@ -179,7 +179,7 @@ bs_set_attr <- function(tag, .prefix = "data", ...){
#' bs_set_aria(expanded = FALSE)
#' @export
#'
#' @seealso [Bootstrap JavaScript Components](http://getbootstrap.com/javascript)
#' @seealso [Bootstrap JavaScript Components](http://getbootstrap.com/docs/3.3/javascript)
#
bs_set_data <- function(tag, ...){
bs_set_attr(tag, .prefix = "data", ...)
Expand Down
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,23 +32,23 @@ To see all of this in action, you are referred to the [getting-started article](

The goals of this package are:

- to provide a framework to use Bootstrap's JavaScript-markup API: http://getbootstrap.com/javascript/
- to provide a framework to use Bootstrap's JavaScript-markup API: https://getbootstrap.com/docs/3.3/javascript/
- 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.

### Highlights

#### Accordion-sidebar

This family of functions lets you build another dimension to your **shiny** apps, although you can still use it **rmarkdown** HTML documents. Rather than explain, you can see it demonstrated in a [**shiny** app](https://ijlyttle.shinyapps.io/tooltip_popover_modal/). If you would like some explanation, please see this [article](http://ijlyttle.github.io/bsplus/articles/accordion_sidebar.html).
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](http://ijlyttle.github.io/bsplus/articles/accordion_sidebar.html).

#### Shiny-help links

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. You can see this [**shiny** app](https://ijlyttle.shinyapps.io/tooltip_popover_modal/) for a demonstration, and this [article](http://ijlyttle.github.io/bsplus/articles/shiny_help_links.html) for some explanation.
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](http://ijlyttle.github.io/bsplus/articles/shiny_help_links.html).

#### Carousel

A carousel is a [Boostrap JavaScript component](http://getbootstrap.com/javascript/#carousel) used to enclose a set of (typically) images, providing controls to move slides back-and-forth - as shown in this [article](https://ijlyttle.github.io/bsplus/articles/carousel.html). I think that this could be a more-useful tool if an "easy" way can be found to populate a carousel with images produced by [**gganimate**](https://github.com/dgrtwo/gganimate).
A carousel is a [Boostrap JavaScript component](http://getbootstrap.com/javascript/#carousel) used to enclose a set of (typically) images, providing controls to move slides back-and-forth - as shown in this [article](https://ijlyttle.github.io/bsplus/articles/carousel.html). I think that this could be a more-useful tool if an "easy" way can be found to populate a carousel with images produced by [**gganimate**](https://github.com/thomasp85/gganimate).

### Function families

Expand Down Expand Up @@ -106,4 +106,4 @@ This package draws inspiration from [**shinyBS**](https://ebailey78.github.io/sh

## Code of conduct

Please note that this project is released with a [Contributor Code of Conduct](CONDUCT.md). By participating in this project you agree to abide by its terms.
Please note that this project is released with a [Contributor Code of Conduct](http://ijlyttle.github.io/bsplus/CONDUCT.html). By participating in this project you agree to abide by its terms.
11 changes: 8 additions & 3 deletions cran-comments.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,16 @@

This is a small patch release to address the CRAN-test failures idenified by Prof. Ripley (email 2020-06-24).

## Test environments

* local OS X install, R 3.4.4
* win-builder (devel)
* GitHub actions (ubuntu-16.04): release
* GitHub actions (windows): release
* Github actions (macOS): release, devel
* win-builder: devel
* r-hub: Fedora Linux, R-devel, clang, gfortran
* r-hub: Ubuntu Linux 16.04 LTS, R-release, GCC
* r-hub: Windows Server 2008 R2 SP1, R-devel, 32/64 bit

0 errors | 0 warnings | 0 notes

## Reverse dependencies

Expand Down
2 changes: 1 addition & 1 deletion man/bs_accordion.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/bs_button.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/bs_carousel.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/bs_collapse.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/bs_embed_popover.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/bs_embed_tooltip.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/bs_panel.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/bs_set_data.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion vignettes/accordion.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -58,5 +58,5 @@ bs_accordion(id = "bootstrap_types") %>%

## Reference

For more information, please see the [Bootstrap JavaScript page](http://getbootstrap.com/javascript/#collapse-example-accordion).
For more information, please see the [Bootstrap JavaScript page](http://getbootstrap.com/docs/3.3/javascript/#collapse-example-accordion).

14 changes: 7 additions & 7 deletions vignettes/bsplus.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,13 @@ output: rmarkdown::html_document

One of the goals of **bsplus** is to provide access to some useful Bootstrap components for **rmarkdown** html-documents and **shiny** apps:

- Basic components: [button](http://getbootstrap.com/css/#buttons), [panel](http://getbootstrap.com/components/#panels), and [well](http://getbootstrap.com/components/#wells)
- Basic components: [button](http://getbootstrap.com/docs/3.3/css/#buttons), [panel](http://getbootstrap.com/docs/3.3/components/#panels), and [well](http://getbootstrap.com/docs/3.3/components/#wells)

- Collapsible components: [collapse](http://getbootstrap.com/javascript/#collapse) and [accordion](http://getbootstrap.com/javascript/#collapse-example-accordion)
- Collapsible components: [collapse](http://getbootstrap.com/docs/3.3/javascript/#collapse) and [accordion](http://getbootstrap.com/docs/3.3/javascript/#collapse-example-accordion)

- Tools to help with documentation: [tooltip](http://getbootstrap.com/javascript/#tooltips), [popover](http://getbootstrap.com/javascript/#popovers), and [modal](http://getbootstrap.com/javascript/#modals), talk about the responsive embed function, once it is made.
- Tools to help with documentation: [tooltip](http://getbootstrap.com/docs/3.3/javascript/#tooltips), [popover](http://getbootstrap.com/docs/3.3/javascript/#popovers), and [modal](http://getbootstrap.com/docs/3.3/javascript/#modals), talk about the responsive embed function, once it is made.

- Present more information: [carousel](http://getbootstrap.com/javascript/#carousel)
- Present more information: [carousel](http://getbootstrap.com/docs/3.3/javascript/#carousel)

Another goal is to provide some tools to help build **shiny** apps.

Expand Down Expand Up @@ -166,7 +166,7 @@ bs_button("John Lennon", button_type = "default") %>%
bs_embed_tooltip(title = "Rhythm Guitar, vocals")
```

According to the [Bootstrap site](http://getbootstrap.com/javascript/#tooltips), tooltips are not activated automatically; to activate them you can call `use_bs_tooltip()` once on your page.
According to the [Bootstrap site](http://getbootstrap.com/docs/3.3/javascript/#tooltips), tooltips are not activated automatically; to activate them you can call `use_bs_tooltip()` once on your page.

```{r}
use_bs_tooltip()
Expand All @@ -187,7 +187,7 @@ bs_button("John Lennon", button_type = "default") %>%
)
```

According to the [Bootstrap site](http://getbootstrap.com/javascript/#popovers), popovers are not activated automatically; to activate them you can call `use_bs_popovers()` once on your page.
According to the [Bootstrap site](http://getbootstrap.com/docs/3.3/javascript/#popovers), popovers are not activated automatically; to activate them you can call `use_bs_popovers()` once on your page.

```{r}
use_bs_popover()
Expand Down Expand Up @@ -268,7 +268,7 @@ To see more of the help-link framework, including more examples and a proposed c

Finally, there are a couple of helper functions for customizing Bootstrap tags: `bs_set_data()` and `bs_set_aria()`. These can be useful because not all of the options for Bootstrap components are represented in the arguments of functions in this package.

Consider the [options for popovers](http://getbootstrap.com/javascript/#popovers-options); there are close to a dozen. The only one that I thought might be commonly used was `placement`, so this became an explicit argument to `bs_embed_popover()`.
Consider the [options for popovers](http://getbootstrap.com/docs/3.3/javascript/#popovers-options); there are close to a dozen. The only one that I thought might be commonly used was `placement`, so this became an explicit argument to `bs_embed_popover()`.

Let's say that you want to be able to dismiss a popover by clicking anywhere in the browser window other than the button. To do this, you have to set the attribute `data-trigger` to the value `"focus"`. The function `bs_set_data()` makes things a little easier for you by prepending `"data-"` to each name and serializing the values to the format specified by the Bootstrap API.

Expand Down
4 changes: 2 additions & 2 deletions vignettes/carousel.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ Here's another rendering of the carousel, this time:

- without indicators
- without captions
- the slides do not auto-advance (using `bs_set_data()` to set [Bootstrap options](http://getbootstrap.com/javascript/#carousel-options))
- the slides do not auto-advance (using `bs_set_data()` to set [Bootstrap options](http://getbootstrap.com/docs/3.3/javascript/#carousel-options))

```{r}
bs_carousel(id = "with_the_beatles") %>%
Expand All @@ -54,4 +54,4 @@ bs_carousel(id = "with_the_beatles") %>%

## Reference

For more information, please see the [Bootstrap JavaScript page](http://getbootstrap.com/javascript/#carousel).
For more information, please see the [Bootstrap JavaScript page](http://getbootstrap.com/docs/3.3/javascript/#carousel).
2 changes: 1 addition & 1 deletion vignettes/collapse.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -37,4 +37,4 @@ bs_button("Sie Liebt Dich", button_type = "primary") %>%

## Reference

For more information, please see the [Bootstrap JavaScript page](http://getbootstrap.com/javascript/#collapse).
For more information, please see the [Bootstrap JavaScript page](http://getbootstrap.com/docs/3.3/javascript/#collapse).
2 changes: 1 addition & 1 deletion vignettes/modal.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -56,4 +56,4 @@ bs_button("Large modal") %>%

## Reference

For more information, please see the [Bootstrap JavaScript page](http://getbootstrap.com/javascript/#modals).
For more information, please see the [Bootstrap JavaScript page](http://getbootstrap.com/docs/3.3/javascript/#modals).
2 changes: 1 addition & 1 deletion vignettes/tooltip_popover.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -38,5 +38,5 @@ use_bs_popover()

## Reference

For more information, please see the Bootstrap JavaScript page on [tooltips](http://getbootstrap.com/javascript/#tooltips) or [popovers](http://getbootstrap.com/javascript/#popovers).
For more information, please see the Bootstrap JavaScript page on [tooltips](http://getbootstrap.com/docs/3.3/javascript/#tooltips) or [popovers](http://getbootstrap.com/docs/3.3/javascript/#popovers).

0 comments on commit 1820eda

Please sign in to comment.