Skip to contents

Generated wrapper for the Web Awesome wa-slider component. When used as a Shiny input, input$<input_id> reflects the component's current value value. The Shiny value is returned as a numeric value. Generated from Web Awesome metadata.

Generated update helper for the Web Awesome wa-slider component.

Usage

wa_slider(
  input_id,
  ...,
  class = NULL,
  style = NULL,
  value = NULL,
  disabled = NULL,
  label = NULL,
  hint = NULL,
  name = NULL,
  autofocus = NULL,
  custom_error = NULL,
  dir = NULL,
  indicator_offset = NULL,
  lang = NULL,
  max = NULL,
  max_value = NULL,
  min = NULL,
  min_value = NULL,
  orientation = NULL,
  range = NULL,
  readonly = NULL,
  size = NULL,
  step = NULL,
  tooltip_distance = NULL,
  tooltip_placement = NULL,
  with_hint = NULL,
  with_label = NULL,
  with_markers = NULL,
  with_tooltip = NULL,
  hint_slot = NULL,
  label_slot = NULL,
  reference = NULL
)

update_wa_slider(
  session,
  input_id,
  value = NULL,
  label = NULL,
  hint = NULL,
  disabled = NULL
)

Arguments

input_id

Input id of the component to update.

...

Child content for the component's default slot.

class

Optional CSS class string.

style

Optional inline CSS style string.

value

Optional value to send to the component.

disabled

Optional logical disabled state to send to the component.

label

Optional label text to send to the component.

hint

Optional hint text to send to the component.

name

String. Default: null. The name of the slider. This will be submitted with the form as a name/value pair.

autofocus

Boolean. Default: FALSE. Tells the browser to focus the slider when the page loads or a dialog is shown.

custom_error

String. Default: null. Optional Web Awesome attribute.

dir

String. Optional Web Awesome attribute.

indicator_offset

Number. The starting value from which to draw the slider's fill, which is based on its current value.

lang

String. Optional Web Awesome attribute.

max

Number. Default: 100. The maximum value allowed.

max_value

Number. Default: 50. The maximum value of a range selection. Used only when range attribute is set.

min

Number. Default: 0. The minimum value allowed.

min_value

Number. Default: 0. The minimum value of a range selection. Used only when range attribute is set.

orientation

Enumerated string. Allowed values: horizontal, vertical. Default: horizontal. The orientation of the slider.

range

Boolean. Default: FALSE. Converts the slider to a range slider with two thumbs.

readonly

Boolean. Default: FALSE. Makes the slider a read-only field.

size

Enumerated string. Allowed values: large, medium, small. Default: medium. The slider's size.

step

Number. Default: 1. The granularity the value must adhere to when incrementing and decrementing.

tooltip_distance

Number. Default: 8. The distance of the tooltip from the slider's thumb.

tooltip_placement

Enumerated string. Allowed values: bottom, left, right, top. Default: top. The placement of the tooltip in reference to the slider's thumb.

with_hint

Boolean. Default: FALSE. Only required for SSR. Set to TRUE if you're slotting in a hint element so the server-rendered markup includes the hint before the component hydrates on the client.

with_label

Boolean. Default: FALSE. Only required for SSR. Set to TRUE if you're slotting in a label element so the server-rendered markup includes the label before the component hydrates on the client.

with_markers

Boolean. Default: FALSE. Draws markers at each step along the slider.

with_tooltip

Boolean. Default: FALSE. Draws a tooltip above the thumb when the control has focus or is dragged.

hint_slot

Text that describes how to use the input. Alternatively, you can use the hint attribute. instead.

label_slot

The slider label. Alternatively, you can use the label attribute.

reference

One or more reference labels to show visually below the slider.

session

Shiny session object.

Value

An HTML tag for the component.

Invisibly returns NULL.

Shiny Bindings

input$<input_id> reflects the component's current value value. The Shiny value is returned as a numeric value.