Learn R Programming

shinyWidgets

Extend widgets available in shiny

Overview

This package provide custom widgets and other components to enhance your shiny applications.

You can replace classical checkboxes with switch button, add colors to radio buttons and checkbox group, use buttons as radio or checkboxes. Each widget has an update method to change the value of an input from the server.

Installation

Install from CRAN with:

install.packages("shinyWidgets")

Or install the development version from GitHub with:

# install.packages("remotes")
remotes::install_github("dreamRs/shinyWidgets")

Demo

A gallery application is included in the package. Once installed, use the following command to launch it:

shinyWidgets::shinyWidgetsGallery()

A live version is available here : http://shinyapps.dreamrs.fr/shinyWidgets

Widgets

Single checkbox

  • Bootstrap switch

Turn checkboxes into toggle switches :

switchInput(inputId = "id", value = TRUE)
  • Material switch

Turn checkboxes into toggle switches :

materialSwitch(inputId = "id", label = "Primary switch", status = "danger")
  • Pretty checkbox
prettyCheckbox(
  inputId = "id", label = "Check me!", icon = icon("check")
)
  • Pretty switch
prettySwitch(
  inputId = "id",
  label = "Switch:",
  fill = TRUE, 
  status = "primary"
)
  • Pretty toggle
prettyToggle(
  inputId = "id",
  label_on = "Checked!",
  label_off = "Unchecked..."
)

Checkboxes and radio buttons

  • Bootstrap buttons

checkboxGroupButtons( # or radioGroupButtons
  inputId = "id",
  label = "Choice: ",
  choices = c("A", "B", "C")
)
  • Pretty checkbox group and radio buttons
prettyCheckboxGroup( # or prettyRadioButtons
  inputId = "id",
  label = "Choice",
  choices = c("A", "B", "c"),
  outline = TRUE,
  plain = TRUE,
  status = "primary",
  icon = icon("check")
)

Select menu

  • Bootstrap select picker

Select menu with lot of configurations options available:

pickerInput(
  inputId = "id", 
  label = "Select:", 
  choices = month.name, 
  options = pickerOptions(
    actionsBox = TRUE, 
    size = 10,
    selectedTextFormat = "count > 3"
  ), 
  multiple = TRUE
)
  • Virtual select

Select menu that can support long list of choices:

virtualSelectInput(
  inputId = "id",
  label = "Select:",
  choices = list(
    "Spring" = c("March", "April", "May"),
    "Summer" = c("June", "July", "August"),
    "Autumn" = c("September", "October", "November"),
    "Winter" = c("December", "January", "February")
  ),
  showValueAsTags = TRUE,
  search = TRUE,
  multiple = TRUE
)

Date picker

  • Air Datepicker

Date (or month or year) picker with lot of options and a timepicker integrated :

airDatepickerInput(
  inputId = "id",
  label = "Select:",
  placeholder = "Placeholder",
  multiple = 5, 
  clearButton = TRUE
)

Sliders

  • Slider with Text

Slider with strings, to pass whatever you want:

sliderTextInput(
  inputId = "id", 
  label = "Choice:", 
  grid = TRUE, 
  force_edges = TRUE,
  choices = c(
    "Strongly disagree",
    "Disagree",
    "Neither agree nor disagree", 
    "Agree", 
    "Strongly agree"
  )
)
  • noUiSlider

A range slider that can be colored, have more than two handles and positioned vertically (among other things):

noUiSliderInput(
  inputId = "id",
  label = "Select:",
  min = 0, 
  max = 600,
  value = c(100, 220, 400),
  tooltips = TRUE,
  step = 1
)

Tree

  • Tree check

Select value(s) in a hierarchical structure:

treeInput(
  inputId = "ID2",
  label = "Select cities:",
  choices = create_tree(cities),
  returnValue = "text",
  closeDepth = 1
)

Text

  • Search

A text input only triggered by hitting 'Enter' or clicking search button :

searchInput(
  inputId = "id", 
  label = "Enter your search :", 
  placeholder = "This is a placeholder", 
  btnSearch = icon("search"), 
  btnReset = icon("remove"), 
  width = "100%"
)

Other functionnalities

Sweet Alert

Show an alert message to the user to provide some feedback, via sweetalert2 library:

See examples in ?show_alert.

Request confirmation from the user :

See examples in ?ask_confirmation.

Dropdown button

Hide input in a button :

dropdownButton(
  tags$h3("List of Input"),
  selectInput(inputId = 'xcol', label = 'X Variable', choices = names(iris)),
  selectInput(inputId = 'ycol', label = 'Y Variable', choices = names(iris), selected = names(iris)[[2]]),
  sliderInput(inputId = 'clusters', label = 'Cluster count', value = 3, min = 1, max = 9),
  circle = TRUE,
  status = "danger", 
  icon = icon("gear"), width = "300px",
  tooltip = tooltipOptions(title = "Click to see inputs !")
)

See also ?dropMenu()

Development

This package use {packer} to manage JavaScript assets, see packer's documentation for more.

Install nodes modules with:

packer::npm_install()

Modify inputs bindings in srcjs/inputs/, then run:

packer::bundle()

Re-install R package and try functions.

Copy Link

Version

Install

install.packages('shinyWidgets')

Monthly Downloads

55,486

Version

0.8.7

License

GPL-3

Issues

Pull Requests

Stars

Forks

Maintainer

Last Published

September 23rd, 2024

Functions in shinyWidgets (0.8.7)

animations

Animation names
awesomeCheckbox

Awesome Checkbox Input Control
animateOptions

Animate options
autonumericInput

Autonumeric Input Widget
airDatepicker

Air Date Picker Input
WinBox

WinBox
actionBttn

Awesome action button
chooseSliderSkin

Theme selector for sliderInput
bootstrap-utils

Bootstrap panel / alert
colorSelectorInput

Color Selector Input
circleButton

Circle Action button
awesomeRadio

Awesome Radio Buttons Input Control
checkboxGroupButtons

Buttons Group checkbox Input Control
closeSweetAlert

Close Sweet Alert
create_tree

Create choice structure for treeInput()
awesomeCheckboxGroup

Awesome Checkbox Group Input Control
colorPickr

Color Pickr
demoNumericRange

An example showing how numericRangeInput works
dropMenu

Drop Menu
drop-menu-interaction

Interact with Drop Menu
dropdown

Dropdown
dropMenuOptions

Drop menu options
demoVirtualSelect

Demo for virtualSelectInput()
execute_safely

Execute an expression safely in server
deprecated

Deprecated function
downloadBttn

Create a download actionBttn
dropdownButton

Dropdown Button
demoAirDatepicker

Some examples on how to use airDatepickerInput
demoNoUiSlider

Some examples on how to use noUiSliderInput
materialSwitch

Material Design Switch Input Control
multiInput

Create a multiselect input control
html-dependencies

HTML dependencies
updateCurrencyInput

Update a Formatted Numeric Input Widget
currencyInput

Format Numeric Inputs
html_dependency_winbox

Winbox JavaScript Dependencies
pickerOptions

Options for pickerInput
pickerInput

Select Picker Input Control
noUiSliderInput

Numeric range slider
numericInputIcon

Create a numeric input control with icon(s)
prettyCheckboxGroup

Pretty Checkbox Group Input Control
prettyCheckbox

Pretty Checkbox Input
inputSweetAlert

Launch an input text dialog
searchInput

Search Input
selectizeGroup-module

Selectize Group
knobInput

Knob Input
prettyToggle

Pretty Toggle Input
progress-bar

Progress Bars
pickerGroup-module

Picker Group
setBackgroundColor

Custom background color for your shinyapp
numericRangeInput

Numeric Range Input
setBackgroundImage

Custom background image for your shinyapp
sliderTextInput

Slider Text Input Widget
show_toast

Show a toast notification
sweetalert

Display a Sweet Alert to the user
switchInput

Bootstrap Switch Input Control
updateAirDateInput

Change the value of airDatepickerInput() on the client
updateAutonumericInput

Update an Autonumeric Input Object
updateAwesomeCheckbox

Change the value of an awesome checkbox input on the client
time-input

Time input
prepare_choices

Prepare choices for virtualSelectInput()
toggleDropdownButton

Toggle a dropdown menu
prepare_slim_choices

Prepare choices for slimSelectInput()
prettyRadioButtons

Pretty radio Buttons Input Control
prettySwitch

Pretty Switch Input
updateColorPickr

Update color pickr server-side
updateAwesomeCheckboxGroup

Change the value of a awesomeCheckboxGroup input on the client
updateMaterialSwitch

Change the value of a materialSwitch input on the client
radioGroupButtons

Buttons Group Radio Input Control
progressSweetAlert

Progress bar in a sweet alert
slimSelectInput

Slim Select Input
spectrumInput

Palette Color Picker with Spectrum Library
sweetalert-confirmation

Launch a confirmation dialog
stati-card

Minimal statistic cards
textInputAddon

Text with Add-on Input Control
textInputIcon

Create a text input control with icon(s)
updateKnobInput

Change the value of a knob input on the client
updateNumericRangeInput

Change the value of a numeric range input
updateAwesomeRadio

Change the value of a radio input on the client
updateCheckboxGroupButtons

Change the value of a checkboxes group buttons input on the client
updateMultiInput

Change the value of a multi input on the client
updatePrettySwitch

Change the value of a pretty switch on the client
updateNoUiSliderInput

Change the value of a no ui slider input on the client
updatePrettyRadioButtons

Change the value pretty radio buttons on the client
updateNumericInputIcon

Change the value of a numeric input icon on the client
updatePrettyCheckbox

Change the value of a pretty checkbox on the client
updateSearchInput

Change the value of a search input on the client
updateSliderTextInput

Change the value of a slider text input on the client
updatePrettyToggle

Change the value of a pretty toggle on the client
updatePickerInput

Change the value of a select picker input on the client
shinyWidgets

shinyWidgets: Custom inputs widgets for Shiny.
updateVirtualSelect

Update virtual select from server
useSweetAlert

Load Sweet Alert dependencies
updateRadioGroupButtons

Change the value of a radio group buttons input on the client
updateTextInputIcon

Change the value of a text input icon on the client
updateSwitchInput

Change the value of a switch input on the client
shinyWidgetsGallery

Launch the shinyWidget Gallery
updatePrettyCheckboxGroup

Change the value of a pretty checkbox on the client
updateVerticalTabsetPanel

Update selected vertical tab
updateTreeInput

Update Tree Input
wNumbFormat

Format numbers in noUiSliderInput
wbControls

WinBox controls
tooltipOptions

Tooltip options
wbOptions

WinBox Options
treeInput

Tree Input Widget
updateSlimSelect

Update slim select from server
vertical-tab

Vertical tab panel
virtualSelectInput

Virtual Select Input
updateSpectrumInput

Change the value of a spectrum input on the client
actionGroupButtons

Actions Buttons Group Inputs
addSpinner

Display a spinner above an output when this one recalculate
appendVerticalTab

Mutate Vertical Tabset Panel