Package {VanillaCalendar}

Vanilla Calendar Widget

Description

Creates a Vanilla Calendar Pro calendar or date picker for use in R, R Markdown and Shiny applications.

Usage

VanillaCalendar(
  options = list(),
  width = NULL,
  height = NULL,
  elementId = NULL
)

Arguments

Value

An object of class htmlwidget.

Shiny inputs

When rendered in Shiny, the widget reports its state back to the server. For an output with id "cal":

input$cal_selected

A Date vector of the selected dates (length 0 when nothing is selected).

input$cal_selected_month

Selected month, 1-12.

input$cal_selected_year

Selected year.

input$cal_displayed

First day of the displayed month, as a Date, updated when the user clicks the arrows.

input$cal_time

Selected time as a string, e.g. "14:30", when selectionTimeMode is enabled.

input$cal_week

A list with week and year, when enableWeekNumbers is enabled and a week number is clicked.

input$cal_ready

TRUE once the calendar has initialised.

Input mode

With options = list(inputMode = TRUE) the widget renders a text input and shows the calendar as a popup, the behaviour documented under input mode upstream. Pair it with height = "auto".

Theming

selectedTheme accepts "light", "dark" or "system". In system mode the library reads the theme from the attribute named by themeAttrDetect, which defaults to "html[data-theme]". Shiny apps using bslib should set themeAttrDetect = "html[data-bs-theme]" to follow the app theme.

See Also

VanillaCalendarProxy() to update a calendar in place from Shiny.

Examples

# Basic calendar with default settings
VanillaCalendar()

# Calendar with custom options
VanillaCalendar(
  options = list(
    type = "default",
    locale = "en",
    selectionDatesMode = "multiple",
    selectedDates = Sys.Date(),
    selectedTheme = "light"
  ),
  width = "500px",
  height = "400px"
)

# Date picker attached to a text input
VanillaCalendar(
  options = list(inputMode = TRUE, selectionDatesMode = "single"),
  height = "auto"
)

Shiny bindings for VanillaCalendar

Description

Output and render functions for using VanillaCalendar within Shiny applications and interactive Rmd documents.

Usage

VanillaCalendarOutput(outputId, width = "100%", height = "400px")

renderVanillaCalendar(expr, env = parent.frame(), quoted = FALSE)

Arguments

Value

VanillaCalendarOutput() returns a Shiny output element; renderVanillaCalendar() returns a Shiny render function.

Examples

# Only run examples in interactive R sessions
if (interactive()) {
  library(shiny)
  library(VanillaCalendar)

  ui <- fluidPage(
    VanillaCalendarOutput("calendar"),
    verbatimTextOutput("dates")
  )

  server <- function(input, output) {
    output$calendar <- renderVanillaCalendar({
      VanillaCalendar(
        options = list(
          type = "default",
          locale = "en",
          selectionDatesMode = "multiple"
        )
      )
    })
    output$dates <- renderPrint(input$calendar_selected)
  }

  shinyApp(ui, server)
}

Update a calendar in place from Shiny

Description

VanillaCalendarProxy() creates a handle to a calendar that is already rendered, so that it can be changed without re-rendering it — the calendar keeps its position, focus and selection instead of flickering back to its initial state. The methods map onto the Calendar instance methods of Vanilla Calendar Pro.

vcSet() applies new options to the calendar.

vcUpdate() re-renders the calendar with its current options.

vcShow() and vcHide() show and hide a popup calendar in input mode.

vcDestroy() removes the calendar from the page.

Usage

VanillaCalendarProxy(id, session = shiny::getDefaultReactiveDomain())

vcSet(proxy, options, reset = NULL)

vcUpdate(proxy, reset = NULL)

vcShow(proxy)

vcHide(proxy)

vcDestroy(proxy)

Arguments

Value

The proxy object, invisibly, so calls can be piped.

Examples

if (interactive()) {
  library(shiny)
  library(VanillaCalendar)

  ui <- fluidPage(
    selectInput("theme", "Theme", c("light", "dark")),
    actionButton("clear", "Clear selection"),
    VanillaCalendarOutput("cal")
  )

  server <- function(input, output, session) {
    output$cal <- renderVanillaCalendar(
      VanillaCalendar(list(selectionDatesMode = "multiple"))
    )

    observeEvent(input$theme, {
      vcSet(VanillaCalendarProxy("cal"), list(selectedTheme = input$theme))
    })

    observeEvent(input$clear, {
      vcSet(VanillaCalendarProxy("cal"), list(selectedDates = list()),
            reset = list(dates = TRUE))
    })
  }

  shinyApp(ui, server)
}