Title: A Wrapper of JavaScript Library 'flipdown.js'
Version: 0.1.0
Description: Include a countdown https://github.com/PButcher/flipdown in all R contexts with the convenience of 'htmlwidgets'.
URL: https://github.com/fanggong/flipdownWidgets
BugReports: https://github.com/fanggong/flipdownWidgets/issues
License: MIT + file LICENSE
Imports: htmlwidgets
Encoding: UTF-8
RoxygenNote: 7.1.1
NeedsCompilation: no
Packaged: 2021-06-29 10:08:44 UTC; Dell
Author: Yongchao Fang [aut, cre], Peter Butcher [ctb, cph] (author of flipdown.js)
Maintainer: Yongchao Fang <yongchao.fang@outlook.com>
Repository: CRAN
Date/Publication: 2021-06-30 10:00:02 UTC

Create an HTML countdown widget using the flipdown.js library

Description

This function creates an HTML widgets to display a countdown using the flipdown.js library.

Usage

flipdownWidgets(
  to,
  ...,
  theme = c("dark", "light"),
  headings = c("Days", "Hours", "Minutes", "Seconds"),
  width = NULL,
  height = NULL,
  elementId = NULL
)

Arguments

to

R object to be passed to the as.POSIXct function to specifying the target date.

...

all the argument to be passed to as.POSIXct.

theme

The theme of the widget. Possible value: "dark", "light".

headings

A character vector of length 4 specifying the heading related to each time part. Defaults to c("Days", "Hours", "Minutes", "Seconds").

width

Width of the countdown widget. Must be a valid CSS unit (like '100%', '400px', 'auto') or a number, which will be coerced to a string and have 'px' appended.

height

Not being used here. The height of the widget will be automatically sized according to the width of the widget.

elementId

An id for the widget (a random string by default).

Value

An HTML countdown widget

Examples

library(flipdownWidgets)
flipdownWidgets(Sys.time() + 100)

Shiny bindings for flipdownWidgets

Description

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

Usage

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

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

Arguments

outputId

output variable to read from

width, height

Must be a valid CSS unit (like '100%', '400px', 'auto') or a number, which will be coerced to a string and have 'px' appended.

expr

An expression that generates a flipdownWidgets

env

The environment in which to evaluate expr.

quoted

Is expr a quoted expression (with quote())? This is useful if you want to save an expression in a variable.

Value

flipdownWidgetsOutput returns a flipdownWidgets output element that can be included in user interface. And renderFlipdownWidgets returns a function which will generate data for render.