{"Package":"scrollrevealR","Type":"Package","Title":"Animate 'shiny' Elements when They Scroll into View using the\n'scrollrevealjs' Library","Version":"0.2.0","Authors@R":"c(\nperson(\"Mohamed El Fodil\", \"Ihaddaden\", email = \"ihaddaden.fodeil@gmail.com\", role = c(\"aut\", \"cre\")),\nperson(\"Julian\", \"Lloyd\", role = c(\"ctb\", \"cph\"), comment = \"scrollreveal.js library developer\"))","Description":"Allows the user to animate 'shiny' elements when scrolling to view them.\nThe animations are activated using the 'scrollrevealjs' library. See for more information.","License":"MIT + file LICENSE","Encoding":"UTF-8","LazyData":"true","URL":"https://github.com/feddelegrand7/scrollrevealR","BugReports":"https://github.com/feddelegrand7/scrollrevealR/issues","Imports":"htmltools, glue","Suggests":"knitr, rmarkdown","VignetteBuilder":"knitr","RoxygenNote":"7.1.1","NeedsCompilation":"no","Packaged":"2020-10-14 09:31:57 UTC; Administrateur","Author":"Mohamed El Fodil Ihaddaden [aut, cre],\nJulian Lloyd [ctb, cph] (scrollreveal.js library developer)","Maintainer":"Mohamed El Fodil Ihaddaden ","Repository":"CRAN","Date/Publication":"2020-10-14 10:00:02 UTC","repoType":"cran","tarballUrl":"ftp://cran.r-project.org/pub/R/src/contrib/scrollrevealR_0.2.0.tar.gz","jsonAuthors":[{"name":"Mohamed El Fodil Ihaddaden","email":"ihaddaden.fodeil@gmail.com","maintainer":true},{"name":"Julian Lloyd","email":null,"maintainer":false}],"readme":"\n\n\n# scrollrevealR\n\n\n\n[![CRAN\\_Status\\_Badge](https://www.r-pkg.org/badges/version/scrollrevealR)](https://cran.r-project.org/package=scrollrevealR)\n\n[![CRAN\\_time\\_from\\_release](https://www.r-pkg.org/badges/ago/scrollrevealR)](https://cran.r-project.org/package=scrollrevealR)\n\n[![metacran\ndownloads](https://cranlogs.r-pkg.org/badges/scrollrevealR)](https://cran.r-project.org/package=scrollrevealR)\n\n[![metacran\ndownloads](https://cranlogs.r-pkg.org/badges/grand-total/scrollrevealR)](https://cran.r-project.org/package=scrollrevealR)\n\n[![Travis build\nstatus](https://travis-ci.com/feddelegrand7/scrollrevealR.svg?branch=master)](https://travis-ci.com/feddelegrand7/scrollrevealR)\n\n[![R\nbadge](https://img.shields.io/badge/Build%20with-♥%20and%20R-blue)](https://github.com/feddelegrand7/scrollrevealR)\n\n\n\n`scrollrevealR` allows you to animate `shiny` elements when they scroll\ninto view using the [scrollrevealjs\nlibrary](https://scrollrevealjs.org/).\n\n![](man/figures/exampleapp2.gif)\n\n
\n\n## Installation\n\nYou can install the `scrollrevealR` package from\n[CRAN](https://CRAN.R-project.org/package=scrollrevealR) with:\n\n``` r\n\ninstall.packages(\"scrollrevealR\")\n```\n\nYou can install the development version of `scrollrevealR` from\n[GitHub](https://github.com/) with:\n\n``` r\n# install.packages(\"devtools\")\ndevtools::install_github(\"feddelegrand7/scrollrevealR\")\n```\n\n## Example\n\nIn order to use `scrollrevealR`, you only need to use one function:\n\n - `scroll_reveal()`: allows you to animate one or many shiny elements\n as they scroll into view.\n\n#### 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.\n\nBelow an example of a simple shiny app that uses the `scrollrevealR`\npackage:\n\n``` r\nlibrary(shiny)\nlibrary(scrollrevealR)\n\nui <- fluidPage(\n\n h1(\"Mtcars Plot\"),\n\n br(), br(),\n\n plotOutput(outputId = \"plt1\"),\n\n br(), br(),\n\n h1(\"Iris Plot\"),\n \n plotOutput(outputId = \"plt2\"),\n\n br(), br(),\n\n h1(\"ChickWeight Plot\"),\n\n plotOutput(outputId = \"plt3\"),\n\n # Using the scroll_reveal() function -------------------------------------------\n scroll_reveal(target = c(\"#plt1\", \"#plt2\", \"#plt3\"), duration = 2000, distance = \"100px\"),\n\n scroll_reveal(target = \"h1\", duration = 2000, distance = \"100px\"),\n # ----------------------------------------------------------------------------- \n\n # Making some space at the end\n\n br(), br(), br(), br(), br(), br(), br(), br(), br(), br(), br(), br()\n\n)\n\nserver <- function(input, output) {\n\n\noutput$plt1 <- renderPlot({\n\n plot(mtcars)\n\n })\n\n\noutput$plt2 <- renderPlot({\n\n\n plot(iris)\n\n})\n\n\noutput$plt3 <- renderPlot({\n\n\n plot(ChickWeight)\n\n\n})\n\n\n}\n\nshinyApp(ui = ui, server = server)\n```\n\n![](man/figures/exampleapp.gif)\n\n## Commercial License\n\nIf you use the `scrollrevealR` package for commercial usage, You can buy\na Commercial License from the `scrollreveal`\n[website](https://scrollrevealjs.org/pricing/).\n\n## Code of Conduct\n\nPlease note that the scrollrevealR project is released with a\n[Contributor Code of\nConduct](https://contributor-covenant.org/version/2/0/CODE_OF_CONDUCT.html).\nBy contributing to this project, you agree to abide by its terms.","jobInfo":{"package":"scrollrevealR","version":"0.2.0","parsingStatus":"success","parserVersion":1,"parsedAt":"2020-10-14T12:29:51+0000"}}

Description

Usage

Arguments