downloadFileButton: downloadFileButton UI

In neuhausi/periscope: Enterprise Streamlined 'Shiny' Application Framework

downloadFileButton UI

Description

Creates a custom high-functionality button for file downloads with two states - single download type or multiple-download types. The button image and pop-up menu (if needed) are set accordingly. A tooltip can also be set for the button.

Usage

downloadFileButton(id, downloadtypes = c("csv"), hovertext = NULL)

Arguments

id	character id for the object
downloadtypes	vector of values for data download types
hovertext	tooltip hover text

Button Features

• Consistent styling of the button, including a hover tooltip

• Single or multiple types of downloads

• Ability to download different data for each type of download

Example

downloadFileUI("mybuttonID1", c("csv", "tsv"), "Click Here") downloadFileUI("mybuttonID2", "csv", "Click to download")

Shiny Usage

Call this function at the place in ui.R where the button should be placed.

It is paired with a call to downloadFile(id, ...) in server.R

See Also

downloadFile

downloadFile_ValidateTypes

downloadFile_AvailableTypes

Examples

# Inside ui_body.R or ui_sidebar.R

#single download type
downloadFileButton("object_id1", 
                   downloadtypes = c("csv"), 
                   hovertext = "Button 1 Tooltip")

#multiple download types
downloadFileButton("object_id2", 
                   downloadtypes = c("csv", "tsv"), 
                   hovertext = "Button 2 Tooltip")

neuhausi/periscope documentation built on Nov. 9, 2023, 11:07 a.m.