helper | R Documentation |
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.
helper(shiny_tag, icon = "question-circle", colour = NULL, type = "markdown", title = "", content = "", size = "m", buttonLabel = "Okay", easyClose = TRUE, fade = FALSE, ...)
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 |
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 |
fade |
Whether the modal has a fade in animation. Defaults to |
... |
Other arguments to pass to the |
helper(shiny::actionButton("go", "click me!"), icon = "exclamation", colour = "red", type = "markdown", content = "ClickHelp") # looks for 'helpfiles/ClickHelp.md'
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.