Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ Description: The Bootstrap framework lets you add some JavaScript functionality
popovers, and an accordion sidebar framework (not described at Bootstrap site).
Please note this package was designed for Bootstrap 3.3.
License: MIT + file LICENSE
URL: https://ijlyttle.github.io/bsplus/
Depends: R (>= 3.3.0)
Imports:
htmltools,
Expand All @@ -31,10 +32,9 @@ Imports:
glue,
jsonlite,
methods
URL: https://github.com/ijlyttle/bsplus
BugReports: https://github.com/ijlyttle/bsplus/issues
Roxygen: list(markdown = TRUE)
RoxygenNote: 7.2.1
RoxygenNote: 7.3.2
Encoding: UTF-8
Suggests:
testthat,
Expand Down
2 changes: 0 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@

<!-- badges: start -->
[![CRAN status](https://www.r-pkg.org/badges/version/bsplus)](https://cran.r-project.org/package=bsplus)
[![R build status](https://github.com/ijlyttle/bsplus/workflows/R-CMD-check/badge.svg)](https://github.com/ijlyttle/bsplus/actions)
[![Coverage Status](https://img.shields.io/codecov/c/github/ijlyttle/bsplus/main.svg)](https://codecov.io/github/ijlyttle/bsplus?branch=main)
[![R-CMD-check](https://github.com/ijlyttle/bsplus/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/ijlyttle/bsplus/actions/workflows/R-CMD-check.yaml)
<!-- badges: end -->

Expand Down
13 changes: 11 additions & 2 deletions man/bs_modal.Rd

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

35 changes: 13 additions & 22 deletions pkgdown/_pkgdown.yml
Original file line number Diff line number Diff line change
@@ -1,32 +1,23 @@
url: https://ijlyttle.github.io/bsplus/

development:
mode: auto

template:
params:
bootswatch: sandstone
assets: "inst/pkgdown/assets"

development:
mode: auto

navbar:
structure:
left: [setup, reference, articles, news]
right: [search, github]
components:
articles:
text: Articles
menu:
- text: "Function Families"
- text: "---"
- text: "collpase"
href: articles/collapse.html
- text: "accordion"
href: articles/accordion.html
- text: "accordion_sidebar"
href: articles/accordion_sidebar.html
- text: "tooltip_popover"
href: articles/tooltip_popover.html
- text: "modal"
href: articles/modal.html
- text: "carousel"
href: articles/carousel.html
- text: "shiny_help_links"
href: articles/shiny_help_links.html
setup:
text: Get Started
href: articles/bsplus.html



reference:
- title: "Components"
Expand Down
3 changes: 0 additions & 3 deletions vignettes/accordion.Rmd
Original file line number Diff line number Diff line change
@@ -1,8 +1,5 @@
---
title: "Accordion"
author: "Ian Lyttle"
date: "`r Sys.Date()`"
output: rmarkdown::html_vignette
---

```{r}
Expand Down
3 changes: 0 additions & 3 deletions vignettes/accordion_sidebar.Rmd
Original file line number Diff line number Diff line change
@@ -1,8 +1,5 @@
---
title: "Accordion Sidebar"
author: "Ian Lyttle"
date: "`r Sys.Date()`"
output: rmarkdown::html_vignette
---

```{r}
Expand Down
10 changes: 5 additions & 5 deletions vignettes/bsplus.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -205,19 +205,19 @@ An carousel can be useful to cycle through slides with related content. There li
```{r}
bs_carousel(id = "the_beatles", use_indicators = TRUE) %>%
bs_append(
content = bs_carousel_image(src = image_uri("img/john.jpg")),
content = bs_carousel_image(src = image_uri("img/john.jpg"), alt = "John Lennon"),
caption = bs_carousel_caption("John Lennon", "Rhythm guitar, vocals")
) %>%
bs_append(
content = bs_carousel_image(src = image_uri("img/paul.jpg")),
content = bs_carousel_image(src = image_uri("img/paul.jpg"), alt = "Paul McCartney"),
caption = bs_carousel_caption("Paul McCartney", "Bass guitar, vocals")
) %>%
bs_append(
content = bs_carousel_image(src = image_uri("img/george.jpg")),
content = bs_carousel_image(src = image_uri("img/george.jpg"), alt = "George Harrison"),
caption = bs_carousel_caption("George Harrison", "Lead guitar, vocals")
) %>%
bs_append(
content = bs_carousel_image(src = image_uri("img/ringo.jpg")),
content = bs_carousel_image(src = image_uri("img/ringo.jpg"), alt = "Ringo Starr"),
caption = bs_carousel_caption("Ringo Starr", "Drums, vocals")
)
```
Expand Down Expand Up @@ -260,7 +260,7 @@ shiny::runApp(system.file("shiny", "tooltip_popover_modal", package = "bsplus"))

Here's what it looks like:

![](img/popover.png)
![](img/popover.png){alt="Demonstration of popover with information icon"}

To see more of the help-link framework, including more examples and a proposed convention for icons, please read [this article](https://ijlyttle.github.io/bsplus/articles/shiny_help_links.html).

Expand Down
19 changes: 8 additions & 11 deletions vignettes/carousel.Rmd
Original file line number Diff line number Diff line change
@@ -1,8 +1,5 @@
---
title: "Carousel"
author: "Ian Lyttle"
date: "`r Sys.Date()`"
output: rmarkdown::html_vignette
---

```{r}
Expand All @@ -20,19 +17,19 @@ The `content` and `caption` arguments can be composed using the helper functions
```{r}
bs_carousel(id = "the_beatles", use_indicators = TRUE) %>%
bs_append(
content = bs_carousel_image(src = "img/john.jpg"),
content = bs_carousel_image(src = "img/john.jpg", alt = "John Lennon"),
caption = bs_carousel_caption("John Lennon", "Rhythm guitar, vocals")
) %>%
bs_append(
content = bs_carousel_image(src = "img/paul.jpg"),
content = bs_carousel_image(src = "img/paul.jpg", alt = "Paul McCartney"),
caption = bs_carousel_caption("Paul McCartney", "Bass guitar, vocals")
) %>%
bs_append(
content = bs_carousel_image(src = "img/george.jpg"),
content = bs_carousel_image(src = "img/george.jpg", alt = "George Harrison"),
caption = bs_carousel_caption("George Harrison", "Lead guitar, vocals")
) %>%
bs_append(
content = bs_carousel_image(src = "img/ringo.jpg"),
content = bs_carousel_image(src = "img/ringo.jpg", alt = "Ringo Starr"),
caption = bs_carousel_caption("Ringo Starr", "Drums, vocals")
)
```
Expand All @@ -46,10 +43,10 @@ Here's another rendering of the carousel, this time:
```{r}
bs_carousel(id = "with_the_beatles") %>%
bs_set_data(interval = FALSE) %>%
bs_append(content = bs_carousel_image(src = "img/john.jpg")) %>%
bs_append(content = bs_carousel_image(src = "img/paul.jpg")) %>%
bs_append(content = bs_carousel_image(src = "img/george.jpg")) %>%
bs_append(content = bs_carousel_image(src = "img/ringo.jpg"))
bs_append(content = bs_carousel_image(src = "img/john.jpg", alt = "John Lennon")) %>%
bs_append(content = bs_carousel_image(src = "img/paul.jpg", alt = "Paul McCartney")) %>%
bs_append(content = bs_carousel_image(src = "img/george.jpg", alt = "George Harrison")) %>%
bs_append(content = bs_carousel_image(src = "img/ringo.jpg", alt = "Ringo Starr"))
```

## Reference
Expand Down
3 changes: 0 additions & 3 deletions vignettes/collapse.Rmd
Original file line number Diff line number Diff line change
@@ -1,8 +1,5 @@
---
title: "Collapse"
author: "Ian Lyttle"
date: "`r Sys.Date()`"
output: rmarkdown::html_vignette
---

```{r}
Expand Down
3 changes: 0 additions & 3 deletions vignettes/modal.Rmd
Original file line number Diff line number Diff line change
@@ -1,8 +1,5 @@
---
title: "Modals"
author: "Ian Lyttle"
date: "`r Sys.Date()`"
output: rmarkdown::html_vignette
---

```{r}
Expand Down
5 changes: 1 addition & 4 deletions vignettes/shiny_help_links.Rmd
Original file line number Diff line number Diff line change
@@ -1,8 +1,5 @@
---
title: "Shiny-input help links"
author: "Ian Lyttle"
date: "`r Sys.Date()`"
output: rmarkdown::html_vignette
---

```{r}
Expand Down Expand Up @@ -38,7 +35,7 @@ As of writing, I don't know how to include operable **shiny** inputs in an html
shiny::runApp(system.file("shiny", "tooltip_popover_modal", package = "bsplus"))
```

![](img/popover.png)
![](img/popover.png){alt="Demonstration of popover with information icon"}

To promote consistency, the following convention is proposed:

Expand Down
5 changes: 1 addition & 4 deletions vignettes/tooltip_popover.Rmd
Original file line number Diff line number Diff line change
@@ -1,8 +1,5 @@
---
title: "Tooltips and popovers"
author: "Ian Lyttle"
date: "`r Sys.Date()`"
output: rmarkdown::html_vignette
title: "Tooltips and Popovers"
---

```{r}
Expand Down