slickR: slick.js image carousel htmlwidget

In slickR: Create Interactive Carousels with the 'JavaScript' 'Slick' Library

slick.js image carousel htmlwidget

Description

use slick.js library in R

Usage

slickR(
  obj,
  slideId = "baseDiv",
  slideType = "img",
  objLinks = NULL,
  padding = 1,
  width = "95%",
  height = NULL,
  elementId = NULL,
  slickOpts = NULL,
  synchSlides = NULL,
  dotObj = NULL
)

Arguments

obj	character, vector of path or url to images
slideId	character, id of slide, Default: 'baseDiv'
slideType	character, type of object to put in slide, Default: 'img'
objLinks	character, links to attach to images in slide, Default: NULL
padding	numeric, percent of width between each image in the carousel for each slider, Default: 1
width	character, width of htmlwidget, Default: '95%'
height	character, height of htmlwidget, Default: NULL
elementId	character, id tag of htmlwidget, Default: NULL
slickOpts	\lifecycle deprecated
synchSlides	\lifecycle deprecated
dotObj	\lifecycle deprecated

Details

slick.js is an image carousel javascript library.

To find all the attributes that can be used please refer to the link.

It is possible to stack slides through the %stack% operator.

It is possible to synchronize slides through the %synch% operator.

To replace the dots with icons use the settings to define the customPaging attribute with the appropriate JS(.) function call.

The slideType accepts the type of html DOM you want to be in the slide, eg img, iframe.

The combination of slideType = 'img-lazy' and settings(lazyLoad = 'ondemand') will inform the htmlwidget that the images are to be loaded lazily. For more information see the slickjs documentation.

See Also

Other invoke: slickR-shiny

Examples

if(interactive()){

slick <- slickR(obj=nba_team_logo$uri)

slick

# add dots to the first slick and autoplay at 1 second a slide
 
slick + settings(dots = TRUE, autoplay = TRUE, autoplaySpeed = 1000)


# working with multiple slicks

sets <- split(
  sample(nba_team_logo$uri, size = 28, replace = FALSE),
  rep(c(1,2,3,4),each=7)
)

slicks <- lapply(sets,FUN = function(x,...){
  slickR(obj = x,...)
},height = 100)

# independent slicks

Reduce(`%stack%`,slicks)

# 1,2 synch stacked on 3,4 synch

 (slicks[[1]] %synch% slicks[[2]]) %stack% (slicks[[3]]%synch%slicks[[4]])

}

slickR documentation built on Dec. 28, 2022, 2:41 a.m.