diff --git a/docs/apple-touch-icon-120x120.png b/docs/apple-touch-icon-120x120.png index 0dbd341..5025c7c 100644 Binary files a/docs/apple-touch-icon-120x120.png and b/docs/apple-touch-icon-120x120.png differ diff --git a/docs/apple-touch-icon-152x152.png b/docs/apple-touch-icon-152x152.png index 8b3d7e1..27947ad 100644 Binary files a/docs/apple-touch-icon-152x152.png and b/docs/apple-touch-icon-152x152.png differ diff --git a/docs/apple-touch-icon-180x180.png b/docs/apple-touch-icon-180x180.png index 2596aa9..5e32e16 100644 Binary files a/docs/apple-touch-icon-180x180.png and b/docs/apple-touch-icon-180x180.png differ diff --git a/docs/apple-touch-icon-60x60.png b/docs/apple-touch-icon-60x60.png index 59cd926..25e785a 100644 Binary files a/docs/apple-touch-icon-60x60.png and b/docs/apple-touch-icon-60x60.png differ diff --git a/docs/apple-touch-icon-76x76.png b/docs/apple-touch-icon-76x76.png index 43f43c2..14ce132 100644 Binary files a/docs/apple-touch-icon-76x76.png and b/docs/apple-touch-icon-76x76.png differ diff --git a/docs/apple-touch-icon.png b/docs/apple-touch-icon.png index 99c1b3d..f471cb7 100644 Binary files a/docs/apple-touch-icon.png and b/docs/apple-touch-icon.png differ diff --git a/docs/favicon-16x16.png b/docs/favicon-16x16.png index 5651207..b8cf0c2 100644 Binary files a/docs/favicon-16x16.png and b/docs/favicon-16x16.png differ diff --git a/docs/favicon-32x32.png b/docs/favicon-32x32.png index dc80519..41bc20c 100644 Binary files a/docs/favicon-32x32.png and b/docs/favicon-32x32.png differ diff --git a/docs/favicon.ico b/docs/favicon.ico index ed5d687..26a3f7e 100644 Binary files a/docs/favicon.ico and b/docs/favicon.ico differ diff --git a/docs/logo.png b/docs/logo.png index f5edd9a..0aed73c 100644 Binary files a/docs/logo.png and b/docs/logo.png differ diff --git a/docs/pkgdown.yml b/docs/pkgdown.yml index 3f5971a..718d485 100644 --- a/docs/pkgdown.yml +++ b/docs/pkgdown.yml @@ -2,7 +2,7 @@ pandoc: 3.1.11 pkgdown: 2.0.9 pkgdown_sha: ~ articles: {} -last_built: 2024-09-12T13:12Z +last_built: 2024-09-16T12:09Z urls: reference: https://felixluginbuhl.com/aos/reference article: https://felixluginbuhl.com/aos/articles diff --git a/docs/reference/aos.html b/docs/reference/aos.html index 96f1483..bc44733 100644 --- a/docs/reference/aos.html +++ b/docs/reference/aos.html @@ -151,7 +151,7 @@

Examples ) } #> -#> Listening on http://127.0.0.1:5884 +#> Listening on http://127.0.0.1:5075 #> [1] "An animated text." diff --git a/docs/reference/figures/logo.png b/docs/reference/figures/logo.png index f5edd9a..0aed73c 100644 Binary files a/docs/reference/figures/logo.png and b/docs/reference/figures/logo.png differ diff --git a/docs/reference/use_aos.html b/docs/reference/use_aos.html index f027d56..babc234 100644 --- a/docs/reference/use_aos.html +++ b/docs/reference/use_aos.html @@ -166,8 +166,7 @@

Examples ) } #> -#> Listening on http://127.0.0.1:5884 -#> [1] "An animated text." +#> Listening on http://127.0.0.1:5075 diff --git a/docs/search.json b/docs/search.json index f072f53..5a5c15c 100644 --- a/docs/search.json +++ b/docs/search.json @@ -1 +1 @@ -[{"path":"https://felixluginbuhl.com/aos/authors.html","id":null,"dir":"","previous_headings":"","what":"Authors","title":"Authors and Citation","text":"Félix Luginbuhl. Author, maintainer.","code":""},{"path":"https://felixluginbuhl.com/aos/authors.html","id":"citation","dir":"","previous_headings":"","what":"Citation","title":"Authors and Citation","text":"Luginbuhl F (2024). aos: Animate Scroll Library 'shiny'. R package version 0.1.1, https://github.com/lgnbhl/aos, https://felixluginbuhl.com/aos.","code":"@Manual{, title = {aos: Animate on Scroll Library for 'shiny'}, author = {Félix Luginbuhl}, year = {2024}, note = {R package version 0.1.1, https://github.com/lgnbhl/aos}, url = {https://felixluginbuhl.com/aos}, }"},{"path":"https://felixluginbuhl.com/aos/index.html","id":"aos-","dir":"","previous_headings":"","what":"Animate on Scroll Library for shiny","title":"Animate on Scroll Library for shiny","text":"Animate Scroll Library Shiny aos allows animate scroll elements R Shiny thanks AOS - Animate Scroll.","code":""},{"path":"https://felixluginbuhl.com/aos/index.html","id":"installation","dir":"","previous_headings":"","what":"Installation","title":"Animate on Scroll Library for shiny","text":"Install released version CRAN. get bug fix, use feature development version, can install GitHub.","code":"install.packages(\"aos\") # install.packages(\"remotes\") remotes::install_github(\"lgnbhl/aos\")"},{"path":"https://felixluginbuhl.com/aos/index.html","id":"shiny","dir":"","previous_headings":"","what":"Shiny","title":"Animate on Scroll Library for shiny","text":"order use aos package, must first call use_aos() apps’ UI. simply apply aos() Shiny element animation arguments duration, delay easing. function aos() doesn’t work (yet) htmlwidgets.","code":"library(shiny) library(tidyverse) library(ggrepel) library(aos) shinyApp( ui = fluidPage( align = \"center\", use_aos(disable = \"mobile\"), # add use_aos() in the UI aos( element = h1(\"AOS - Animation On Scroll\"), animation = \"fade-zoom-in\", duration = \"1000\"), aos(textOutput(\"text\"), animation = \"fade-up\"), aos( element = shiny::actionButton( inputId = \"button\", label = \"See live demo\", onclick = \"window.open('http://michalsnik.github.io/aos/', '_blank')\"), animation = \"fade-up\", duration = \"3000\") ), server <- function(input, output, session) { output$text <- renderText({ print(\"An animated text.\") }) } )"},{"path":"https://felixluginbuhl.com/aos/index.html","id":"customize-your-animations","dir":"","previous_headings":"Shiny","what":"Customize your animations","title":"Animate on Scroll Library for shiny","text":"use_aos() allows parameter global settings well overrid default aos() arguments. example, can change offset trigger animations later (200px instead default 120px), duration animations (600ms instead 400ms), easing (“ease--sine” instead “ease”), delay (300ms instead 0ms) disable animation mobile phones (global setting). Check aos documentation learn attributes available use_aos() aos(). arguments duration delay accept values “50” “3000”, step 50ms. attribute anchor_placement allows set different placement option, example top-center, .e. animation triggered top element reach center window.","code":"aos::use_aos( offset = \"200\", duration = \"600\", easing = \"ease-in-sine\", delay = \"300\", disable = \"mobile\" )"},{"path":"https://felixluginbuhl.com/aos/index.html","id":"r-markdown","dir":"","previous_headings":"","what":"R Markdown","title":"Animate on Scroll Library for shiny","text":"animate element R Markdown document, must first call use_aos() inside R code chunk {r, echo = FALSE} code shown final document.","code":"```{r, echo = FALSE} aos::use_aos() Then you can animate any content of your R Markdown document using the `:::` markers of the `rmarkdown` package followed by `{data-aos=\"ANIMATION_EFFECT\" data-aos-ARGUMENT=\"ARGUMENT_OPTION\"}`. The animation effects are listed in the documentation [here](https://github.com/michalsnik/aos/tree/v2#-animations). Below an example with the “fade-up” animation with other arguments. ``` md ::: {data-aos=\"fade-up\" data-aos-duration=\"2000\" data-aos-offset=\"0\"} This element will be animated. :::"},{"path":"https://felixluginbuhl.com/aos/reference/aos.html","id":null,"dir":"Reference","previous_headings":"","what":"Animate element on scroll — aos","title":"Animate element on scroll — aos","text":"Animate scroll Shiny R Markdown element.","code":""},{"path":"https://felixluginbuhl.com/aos/reference/aos.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Animate element on scroll — aos","text":"","code":"aos( element, animation, offset = \"120\", duration = \"400\", easing = \"ease\", delay = \"0\", anchor = \"\", anchor_placement = \"top-bottom\", once = FALSE, ... )"},{"path":"https://felixluginbuhl.com/aos/reference/aos.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Animate element on scroll — aos","text":"element shiny rmarkdown element. animation animation AOS offset string. Change offset trigger animations sooner later, px duration string. Duration animation ms easing string. Choose timing function ease elements different ways delay string. Delay animation ms anchor string. Anchor placement anchor_placement string. Anchor placement - one position element screen trigger animation boolean. ... Additional class element","code":""},{"path":"https://felixluginbuhl.com/aos/reference/aos.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Animate element on scroll — aos","text":"Javascript code animating element.","code":""},{"path":"https://felixluginbuhl.com/aos/reference/aos.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Animate element on scroll — aos","text":"","code":"if (interactive()) { library(shiny) shinyApp( ui = fluidPage( use_aos(), # add use_aos() in the UI aos(h1(\"Shiny with AOS - Animate On Scroll\"), animation = \"fade-zoom-in\"), aos(textOutput(\"text\"), animation = \"fade-up\") ), server <- function(input, output, session){ output$text <- renderText({ print(\"An animated text.\") }) } ) } #> #> Listening on http://127.0.0.1:5884 #> [1] \"An animated text.\""},{"path":"https://felixluginbuhl.com/aos/reference/oas-dependencies.html","id":null,"dir":"Reference","previous_headings":"","what":"aos dependencies — html_dependencies_aos","title":"aos dependencies — html_dependencies_aos","text":"Get aos html dependencies.","code":""},{"path":"https://felixluginbuhl.com/aos/reference/oas-dependencies.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"aos dependencies — html_dependencies_aos","text":"","code":"html_dependencies_aos(use_cdn = TRUE)"},{"path":"https://felixluginbuhl.com/aos/reference/oas-dependencies.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"aos dependencies — html_dependencies_aos","text":"use_cdn boolean. TRUE use Content Delivery Network (CDN), true default, false use locally stored files.","code":""},{"path":"https://felixluginbuhl.com/aos/reference/use_aos.html","id":null,"dir":"Reference","previous_headings":"","what":"Use aos — use_aos","title":"Use aos — use_aos","text":"Use aos","code":""},{"path":"https://felixluginbuhl.com/aos/reference/use_aos.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Use aos — use_aos","text":"","code":"use_aos( disable = FALSE, startEvent = \"DOMContentLoaded\", initClassName = \"aos-init\", animatedClassName = \"aos-animate\", useClassNames = FALSE, disableMutationObserver = FALSE, debounceDelay = \"50\", throttleDelay = \"99\", offset = \"120\", duration = \"400\", easing = \"ease\", delay = \"0\", use_cdn = TRUE )"},{"path":"https://felixluginbuhl.com/aos/reference/use_aos.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Use aos — use_aos","text":"disable string. Condition AOS disabled, example 'mobile' startEvent string. Name event dispatched document, AOS initialize initClassName string. Class applied initialization animatedClassName string. Class applied animation useClassNames boolean. true, add content data-aos classes scroll disableMutationObserver boolean. Disables automatic mutations detections (advanced) debounceDelay string. delay debounce used resizing window (advanced) throttleDelay string. delay throttle used scrolling page (advanced) offset string. Change offset trigger animations sooner later, px duration string. Duration animation ms. easing string. Timing function animate elements nicely delay string. Delay animation (ms) use_cdn boolean. TRUE use Content Delivery Network (CDN), true default, false use locally stored files.","code":""},{"path":"https://felixluginbuhl.com/aos/reference/use_aos.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Use aos — use_aos","text":"Javascript code initializing aos dependencies.","code":""},{"path":"https://felixluginbuhl.com/aos/reference/use_aos.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Use aos — use_aos","text":"","code":"if (interactive()) { library(shiny) shinyApp( ui = fluidPage( use_aos(), # add use_aos() in the UI aos(h1(\"Shiny with AOS - Animate On Scroll\"), animation = \"fade-zoom-in\"), aos(textOutput(\"text\"), animation = \"fade-up\") ), server <- function(input, output, session){ output$text <- renderText({ print(\"An animated text.\") }) } ) } #> #> Listening on http://127.0.0.1:5884 #> [1] \"An animated text.\""},{"path":"https://felixluginbuhl.com/aos/reference/use_aos_refresh.html","id":null,"dir":"Reference","previous_headings":"","what":"Refresh aos — use_aos_refresh","title":"Refresh aos — use_aos_refresh","text":"Recalculate offsets positions elements (called window resize).","code":""},{"path":"https://felixluginbuhl.com/aos/reference/use_aos_refresh.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Refresh aos — use_aos_refresh","text":"","code":"use_aos_refresh()"},{"path":"https://felixluginbuhl.com/aos/reference/use_aos_refresh.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Refresh aos — use_aos_refresh","text":"Javascript code","code":""},{"path":"https://felixluginbuhl.com/aos/reference/use_aos_refresh.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Refresh aos — use_aos_refresh","text":"default AOS watching DOM changes new elements loaded asynchronously something removed DOM calls refreshHard automatically. browsers support MutationObserver like IE might need call AOS.refreshHard() .","code":""},{"path":"https://felixluginbuhl.com/aos/reference/use_aos_refresh.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Refresh aos — use_aos_refresh","text":"","code":"use_aos_refresh() #> Warning: one argument not used by format '$(document).ready(function(){ #> AOS.refresh(); #> });' #>