Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/feddelegrand7/scrollrevealR
Animate shiny elements when they scroll into view 🍁 🍁 🍁
https://github.com/feddelegrand7/scrollrevealR
javascript r rstats shiny
Last synced: 3 months ago
JSON representation
Animate shiny elements when they scroll into view 🍁 🍁 🍁
- Host: GitHub
- URL: https://github.com/feddelegrand7/scrollrevealR
- Owner: feddelegrand7
- License: other
- Created: 2020-06-13T15:43:25.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2020-12-09T21:52:46.000Z (almost 4 years ago)
- Last Synced: 2024-07-08T23:26:03.636Z (4 months ago)
- Topics: javascript, r, rstats, shiny
- Language: R
- Homepage:
- Size: 38.7 MB
- Stars: 21
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.Rmd
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-shiny-extensions - scrollrevealR - Animate shiny elements when they scroll into view using the scrollrevealjs library. (UI Components / Walkthrough / Tooltip / Help)
- jimsghstars - feddelegrand7/scrollrevealR - Animate shiny elements when they scroll into view 🍁 🍁 🍁 (R)
README
---
output: github_document
---
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```
# scrollrevealR
[](https://cran.r-project.org/package=scrollrevealR)
[](https://cran.r-project.org/package=scrollrevealR)
[](https://cran.r-project.org/package=scrollrevealR)
[](https://cran.r-project.org/package=scrollrevealR)
[](https://travis-ci.com/feddelegrand7/scrollrevealR)
[](https://github.com/feddelegrand7/scrollrevealR)
`scrollrevealR` allows you to animate `shiny` elements when they scroll into view using the [scrollrevealjs library](https://scrollrevealjs.org/).
## Installation
You can install the `scrollrevealR` package from [CRAN](https://CRAN.R-project.org/package=scrollrevealR) with:
```{r, eval=FALSE}
install.packages("scrollrevealR")
```
You can install the development version of `scrollrevealR` from [GitHub](https://github.com/) with:
```{r eval=FALSE}
# install.packages("devtools")
devtools::install_github("feddelegrand7/scrollrevealR")
```
## Example
In order to use `scrollrevealR`, you only need to use one function:
+ `scroll_reveal()`: allows you to animate one or many shiny elements as they scroll into view.
#### Important: when you apply the `scroll_reveal()` function on Shiny Tables, they tend to disappear when you scroll down to check the last observations of the table which is annoying. In order to deal with this issue, you can use the `reset = FALSE` argument which will trigger an animation only once.
Below an example of a simple shiny app that uses the `scrollrevealR` package:
```{r eval=FALSE}
library(shiny)
library(scrollrevealR)
ui <- fluidPage(
h1("Mtcars Plot"),
br(), br(),
plotOutput(outputId = "plt1"),
br(), br(),
h1("Iris Plot"),
plotOutput(outputId = "plt2"),
br(), br(),
h1("ChickWeight Plot"),
plotOutput(outputId = "plt3"),
# Using the scroll_reveal() function -------------------------------------------
scroll_reveal(target = c("#plt1", "#plt2", "#plt3"), duration = 2000, distance = "100px"),
scroll_reveal(target = "h1", duration = 2000, distance = "100px"),
# -----------------------------------------------------------------------------
# Making some space at the end
br(), br(), br(), br(), br(), br(), br(), br(), br(), br(), br(), br()
)
server <- function(input, output) {
output$plt1 <- renderPlot({
plot(mtcars)
})
output$plt2 <- renderPlot({
plot(iris)
})
output$plt3 <- renderPlot({
plot(ChickWeight)
})
}
shinyApp(ui = ui, server = server)
```
## Commercial License
If you use the `scrollrevealR` package for commercial usage, You can buy a Commercial License from the `scrollreveal` [website](https://scrollrevealjs.org/pricing/).
## Code of Conduct
Please note that the scrollrevealR project is released with a [Contributor Code of Conduct](https://contributor-covenant.org/version/2/0/CODE_OF_CONDUCT.html). By contributing to this project, you agree to abide by its terms.