{"Package":"aos","Title":"Animate on Scroll Library for 'shiny'","Version":"0.1.0","Authors@R":"\nc(person(given = \"Flix\",\nfamily = \"Luginbuhl\",\nrole = c(\"aut\", \"cre\"),\nemail = \"felix.luginbuhl@protonmail.ch\")\n)","Description":"Trigger animation effects on scroll on any HTML element\nof 'shiny' and 'rmarkdown', such as any text or plot, thanks to\nthe 'AOS' Animate On Scroll jQuery library.","License":"MIT + file LICENSE","Encoding":"UTF-8","LazyData":"true","RoxygenNote":"7.1.0","Imports":"jsonlite, htmltools","Suggests":"shiny","URL":"https://felixluginbuhl.com/aos, https://github.com/lgnbhl/aos","BugReports":"https://github.com/lgnbhl/aos/issues","NeedsCompilation":"no","Packaged":"2020-04-25 16:09:08 UTC; Felix","Author":"Flix Luginbuhl [aut, cre]","Maintainer":"Flix Luginbuhl ","Repository":"CRAN","Date/Publication":"2020-04-29 14:30:05 UTC","repoType":"cran","tarballUrl":"ftp://cran.r-project.org/pub/R/src/contrib/aos_0.1.0.tar.gz","jsonAuthors":[{"name":"Flix Luginbuhl","email":"felix.luginbuhl@protonmail.ch","maintainer":true}],"readme":"\n\n\n[![CRAN\nstatus](https://www.r-pkg.org/badges/version/aos)](https://CRAN.R-project.org/package=aos)\n[![pipeline\nstatus](https://gitlab.com/lgnbhl/aos/badges/master/pipeline.svg)](https://gitlab.com/lgnbhl/aos/pipelines)\n\n# aos

\n\n> Animate on Scroll Library for Shiny\n\nThe package `aos` allows to animate on scroll elements in R Shiny thanks\nto [AOS - Animate On Scroll](http://michalsnik.github.io/aos/).\n\n## Installation\n\nInstall the released version from CRAN.\n\n``` r\ninstall.packages(\"aos\")\n```\n\nTo get a bug fix, or use a feature from the development version, you can\ninstall it from GitHub.\n\n``` r\n# install.packages(\"remotes\")\nremotes::install_github(\"lgnbhl/aos\")\n```\n\n## Shiny\n\nIn order to use the {aos} package, you must first call `use_aos()` in\nthe apps’ UI.\n\nThen simply apply `aos()` to any Shiny element with an animation and\nother arguments such as `duration`, `delay` or `easing`.\n\n``` r\nlibrary(shiny)\nlibrary(ggplot2)\nlibrary(aos)\n\nshinyApp(\n ui = fluidPage(\n align = \"center\",\n use_aos(disable = \"mobile\"), # add use_aos() in the UI\n aos(\n element = h1(\"Shiny with AOS - Animation On Scroll\"), \n animation = \"fade-up\", \n duration = \"3000\"),\n br(), br(), br(), br(),\n aos(\n element = plotOutput(\"plot\"), \n animation = \"flip-left\", \n delay = \"200\",\n duration = \"2000\",\n easing = \"ease-out-cubic\")\n ),\n server <- function(input, output, session) {\n output$plot <- renderPlot({\n ggplot(mpg, aes(displ, hwy, colour = class)) + \n geom_point()\n })\n }\n)\n```\n\nThe function `aos()` doesn’t work (yet) with\n[htmlwidgets](https://www.htmlwidgets.org/).\n\n### Customize your animations\n\nThe `use_aos()` allows to parameter global settings as well as overrid\ndefault `aos()` arguments.\n\nFor example, you can change the offset to trigger animations later\n(200px instead of the default 120px), the duration of the animations\n(600ms instead of 400ms), the easing (“ease-in-sine” instead of “ease”),\nthe delay (300ms instead of 0ms) or disable the animation for mobile\nphones (global setting).\n\n``` r\naos::use_aos(\n offset = \"200\", \n duration = \"600\", \n easing = \"ease-in-sine\", \n delay = \"300\", \n disable = \"mobile\"\n )\n```\n\nCheck out the [aos\ndocumentation](https://github.com/michalsnik/aos/tree/v2#-animations) to\nlearn about all the attributes available for `use_aos()` and `aos()`.\n\nThe arguments `duration` and `delay` accept only values from “50” to\n“3000”, with step 50ms.\n\nThe attribute `anchor_placement` allows to set different placement\noption, for example `top-center`, i.e. the animation will be triggered\nwhen `top` of element will reach `center` of the window.\n\n## R Markdown\n\nTo animate a element of a R Markdown document, you must first call\n`use_aos()` inside a R code chunk with `{r, echo = FALSE}` so the code\nwill not be shown in the final document.\n\n``` r\n`\u000b``{r, echo = FALSE}\naos::use_aos()\n`\u000b``\n```\n\nThen you can animate any content of your R Markdown document using the\n`:::` markers of the `rmarkdown` package followed by\n`{data-aos=\"ANIMATION_EFFECT\" data-aos-ARGUMENT=\"ARGUMENT_OPTION\"}`. The\nanimation effects are listed in the documentation\n[here](https://github.com/michalsnik/aos/tree/v2#-animations).\n\nBelow an example with the “fade-up” animation with other arguments.\n\n``` md\n::: {data-aos=\"fade-up\" data-aos-duration=\"2000\" data-aos-offset=\"0\"}\nThis element will be animated.\n:::\n```","jobInfo":{"package":"aos","version":"0.1.0","parsingStatus":"success","parserVersion":1,"parsedAt":"2020-04-29T17:29:53+0000"}}

Description

Usage

Arguments

Value

Examples