Skip to contents

Add scroll up icon

Source: R/gotop.R
use_gotop.Rd

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()
#> <div id='goTop'></div>
#> <script>$(function () {
#>           $('#goTop').goTop({"container":"","appear":200,"scrolltime":800,"src":"fas fa-chevron-up","width":45,"place":"right","color":"","fadein":500,"fadeout":500,"opacity":0.5,"marginX":2,"marginY":2,"zIndex":9});
#>          });</script>