| Type: | Package |
| Title: | Scroll Back to Top Icon in Shiny and R Markdown |
| Version: | 0.1.4 |
| Description: | Add a scroll back to top 'Font Awesome' icon https://fontawesome.com/ in 'rmarkdown' documents and 'shiny' apps thanks to 'jQuery GoTop' https://scottdorman.blog/jquery-gotop/. |
| License: | MIT + file LICENSE |
| Imports: | jsonlite, htmltools |
| URL: | https://felixluginbuhl.com/gotop/, https://github.com/lgnbhl/gotop/ |
| BugReports: | https://github.com/lgnbhl/gotop/issues/ |
| Encoding: | UTF-8 |
| RoxygenNote: | 7.3.1 |
| NeedsCompilation: | no |
| Packaged: | 2024-05-26 20:44:11 UTC; felix |
| Author: | Félix Luginbuhl [aut, cre] |
| Maintainer: | Félix Luginbuhl <felix.luginbuhl@protonmail.ch> |
| Repository: | CRAN |
| Date/Publication: | 2024-05-26 23:00:03 UTC |
gotop dependencies
Description
Get gotop html dependencies.
Usage
html_dependencies_gotop(use_cdn = TRUE)
Arguments
use_cdn |
boolean. TRUE to use a Content Delivery Network (CDN), true by default, or false to use locally stored files. |
Add scroll up icon
Description
Add scroll up icon
Usage
use_gotop(
src = "fas fa-chevron-up",
width = 45,
opacity = 0.5,
place = "right",
color = "",
appear = 200,
scrolltime = 800,
fadein = 500,
fadeout = 500,
marginX = 2,
marginY = 2,
container = "",
zIndex = 9,
use_cdn = TRUE
)
Arguments
src |
A string. The CSS classes used to display the gotop icon. |
width |
An integer. The width of the gotop icon. |
opacity |
decimal Sets the transparency level for the gotop icon, where 1 is not transparent at all, 0.5 is 50 percent see-through and 0 is completely transparent. |
place |
A string. The location where the gotop icon will be shown. Valid values are 'right' or 'left'. |
color |
A string. The color of the selected the gotop icon. |
appear |
An integer. The amount of pixels the page must be scrolled down before the gotop icon is displayed. |
scrolltime |
An integer. A number determining how long the animation will run when scrolling to the top of the page. |
fadein |
An integer. A number determining how long the animation will run when fading in to opaque. |
fadeout |
An integer. A number determining how long the animation will run when fading out to transparent. |
marginX |
An integer. The percentage amount indicating how far away the gotop icon is from the bottom, left, or right, depending on the value of place. |
marginY |
An integer. The percentage amount indicating how far away the gotop icon is from the top or bottom, depending on the value of place. |
container |
A string. The HTML element to which the scroll function will be attached. If no value is given, then the scroll function will be attched to the window. |
zIndex |
An integer. The z-index value. |
use_cdn |
boolean. TRUE to use a Content Delivery Network (CDN), true by default, or false to use locally stored files. |
Value
Javascript code initializing GoTop with dependencies
Examples
use_gotop()