shinyhelper (version 0.3.2)

helper: Augment a shiny.tag with a question mark helper button

Description

Add an action button to your shiny UI with a question mark help icon (by default). In combination with observe_helpers this icon will produce a modal dialog box in the app, with content and title as specified. You may pass inline content for the modal, or else specify the name of a markdown file to include.

Usage

helper(shiny_tag, icon = "question-circle", colour = NULL,
  type = "markdown", title = "", content = "", size = "m",
  buttonLabel = "Okay", easyClose = TRUE, fade = FALSE, ...)

Arguments

shiny_tag

A shiny element, such as an input or output (but any shiny tag will do).

icon

A character string of the name of the icon to display (font awesome).

colour

Any valid CSS colour for the icon.

type

Either 'markdown' to include a helpfile, or 'inline' to specify text.

title

The title to use for your modal. Leave as "" to have no title (for example, if your markdown document has a header you wish to use instead).

content

If type = "markdown", the name of your markdown file; if type = "inline", a character vector of text/HTML to include. This will be pasted together with line breaks. You need not add '.md' to the markdown filename.

size

Either 's', 'm' or 'l' - the size of the modal dialog to display.

buttonLabel

The text for the modal button - "Ok" by default.

easyClose

Whether the modal can be dismissed by pressing Escape, or clicking outside the modal. Defaults to TRUE.

fade

Whether the modal has a fade in animation. Defaults to FALSE.

...

Other arguments to pass to the div containing the icon.

Examples

# NOT RUN {
helper(shiny::actionButton("go", "click me!"),
       icon = "exclamation",
       colour = "red",
       type = "markdown",
       content = "ClickHelp")  # looks for 'helpfiles/ClickHelp.md'
       
# }