Skip to contents

Generated wrapper for the Web Awesome wa-carousel component. When used as a Shiny input, input$<input_id> reflects the component's current semantic activeSlide state. The Shiny value is returned as a numeric value. This index is 0-based. Generated from Web Awesome metadata.

Usage

wa_carousel(
  input_id,
  ...,
  class = NULL,
  style = NULL,
  autoplay = NULL,
  autoplay_interval = NULL,
  current_slide = NULL,
  dir = NULL,
  lang = NULL,
  loop = NULL,
  mouse_dragging = NULL,
  navigation = NULL,
  orientation = NULL,
  pagination = NULL,
  slides = NULL,
  slides_per_move = NULL,
  slides_per_page = NULL,
  next_icon = NULL,
  previous_icon = NULL
)

Arguments

input_id

Shiny input id for the component. This is also used as the rendered DOM id attribute.

...

Child content for the component's default slot.

class

Optional CSS class string.

style

Optional inline CSS style string.

autoplay

Boolean. Default: FALSE. When set, the slides will scroll automatically when the user is not interacting with them.

autoplay_interval

Number. Default: 3000. Specifies the amount of time, in milliseconds, between each automatic scroll.

current_slide

Number. Default: 0. Optional Web Awesome attribute.

dir

String. Optional Web Awesome attribute.

lang

String. Optional Web Awesome attribute.

loop

Boolean. Default: FALSE. When set, allows the user to navigate the carousel in the same direction indefinitely.

mouse_dragging

Boolean. Default: FALSE. When set, it is possible to scroll through the slides by dragging them with the mouse.

navigation

Boolean. Default: FALSE. When set, show the carousel's navigation.

orientation

Enumerated string. Allowed values: horizontal, vertical. Default: horizontal. Specifies the orientation in which the carousel will lay out.

pagination

Boolean. Default: FALSE. When set, show the carousel's pagination indicators.

slides

Number. Default: 0. Optional Web Awesome attribute.

slides_per_move

Number. Default: 1. Specifies the number of slides the carousel will advance when scrolling, useful when specifying a slides-per-page greater than one. It can't be higher than slides-per-page.

slides_per_page

Number. Default: 1. Specifies how many slides should be shown at a given time.

next_icon

Optional next icon to use instead of the default. Works best with <wa-icon>.

previous_icon

Optional previous icon to use instead of the default. Works best with <wa-icon>.

Value

An HTML tag for the component.

Shiny Bindings

input$<input_id> reflects the component's current semantic activeSlide state. The Shiny value is returned as a numeric value. This index is 0-based.