| Type: | Package |
| Title: | Progressive Web App Support for Shiny |
| Version: | 0.2.1 |
| Description: | Adds Progressive Web App support for Shiny apps, including desktop and mobile installations. |
| License: | MIT + file LICENSE |
| URL: | https://github.com/pedrocoutinhosilva/shiny.pwa |
| Encoding: | UTF-8 |
| Imports: | shiny, htmltools, readr, utils, urltools |
| Suggests: | testthat |
| RoxygenNote: | 7.1.1 |
| NeedsCompilation: | no |
| Packaged: | 2021-06-19 16:38:06 UTC; spark |
| Author: | Pedro Silva [aut, cre] |
| Maintainer: | Pedro Silva <pedrocoutinhosilva@gmail.com> |
| Repository: | CRAN |
| Date/Publication: | 2021-06-19 16:50:02 UTC |
Applies a provided template string to a list of arguments. Any arguments gives will be replaced in the template via placeholders wrapped in <<argument>>
Description
Applies a provided template string to a list of arguments. Any arguments gives will be replaced in the template via placeholders wrapped in <<argument>>
Usage
applyTemplate(template, arguments = list())
Arguments
template |
A string with placeholders that can be replaced with the given arguments. |
arguments |
Named list with values used for the template placeholders. |
Value
A string based on the template with the different arguments applied.
Generates the folder structure required for the PWA files.
Description
Generates the folder structure required for the PWA files.
Usage
createDirectories()
See Also
[createServiceWorker()], [createIcon()], [createOfflinePage()], [createManifest()]
Other fileGen:
createIcon(),
createManifest(),
createOfflinePage(),
createServiceWorker()
Creates the PWA icon file based on the given path.
Description
Creates the PWA icon file based on the given path.
Usage
createIcon(icon)
Arguments
icon |
Path to the icon used for PWA installations. |
See Also
[createDirectories()], [createServiceWorker()], [createOfflinePage()], [createManifest()]
Other fileGen:
createDirectories(),
createManifest(),
createOfflinePage(),
createServiceWorker()
Creates the manifest file.
Description
Creates the manifest file.
Usage
createManifest(title, start_url, color)
Arguments
title |
title of the page when the PWA is running in offline mode. |
start_url |
The full url where the app is hosted. |
color |
An argument that can be used in the offline template to show a custom message. |
See Also
[createDirectories()], [createServiceWorker()], [createIcon()], [createOfflinePage()]
Other fileGen:
createDirectories(),
createIcon(),
createOfflinePage(),
createServiceWorker()
Creates the offline landing page.
Description
Creates the offline landing page.
Usage
createOfflinePage(title, template, offline_message)
Arguments
title |
title of the page when the PWA is running in offline mode. |
template |
HTML template to use. If null a default template is used. |
offline_message |
An argument that can be used in the offline template to show a custom message. |
See Also
[createDirectories()], [createServiceWorker()], [createIcon()], [createManifest()]
Other fileGen:
createDirectories(),
createIcon(),
createManifest(),
createServiceWorker()
Creates the service worker file based of the package template file.
Description
Creates the service worker file based of the package template file.
Usage
createServiceWorker(output)
Arguments
output |
Relative folder where to create the service worker file. Usually corresponds to the folder used by shiny to serve static files, this folder must exist and is usually the www folder of your shiny project. |
See Also
[createDirectories()], [createIcon()], [createOfflinePage()], [createManifest()]
Other fileGen:
createDirectories(),
createIcon(),
createManifest(),
createOfflinePage()
Generates the required files for enabling the pwa.
Description
Generates the required files for enabling the pwa.
Usage
generateFiles(
title,
domain,
location,
output,
offline_template,
offline_message,
icon,
color
)
Arguments
title |
The title of your Shiny app |
domain |
the base URL where the app is hosted |
location |
subdirectory where the app is hosted. Only required if the app is not on the root domain. |
output |
Relative folder where to create the service worker file. Usually corresponds to the folder used by shiny to serve static files, this folder must exist and is usually the www folder of your shiny project. |
offline_template |
Path to the offline template you want to use. If left NULL the default template is used. |
offline_message |
When using the default offline page template, message to be displayed. |
icon |
Icon Path to be used for the app. Size should be 512x512px. If left NULL a default icon is provided. |
color |
Color of the app. Used to color the browser elements when the pwa is installed. |
Value
A UI definition that can be passed to the [shinyUI] function.
Get the full path for a default file template
Description
Get the full path for a default file template
Usage
getTemplate(file)
Arguments
file |
Name of the file including the file extension. |
Returns a set of tags required for registering the pwa.
Description
Returns a set of tags required for registering the pwa.
Usage
loadDependencies(title, icon, color, location)
Arguments
title |
Title of the app |
icon |
Relative path of the icon file used in the pwa manifest file (Defaults to pwa/icon.png). |
color |
color used for the UI on the installed pwa |
location |
subdirectory where the app is hosted. Only required if the app is not on the root domain. |
Value
A UI definition that can be passed to the [shinyUI] function.
See Also
[generateFiles()]
Adds PWA support. Takes care of all the support required for browsers to recognize the application as a Progressive Web app.
Description
Adds PWA support. Takes care of all the support required for browsers to recognize the application as a Progressive Web app.
Usage
pwa(
domain,
title = "My Shiny PWA",
output = NULL,
icon = NULL,
color = "#000000",
offline_template = NULL,
offline_message = "Looks like you are offline :/"
)
Arguments
domain |
The base URL where the app is hosted |
title |
The title of your Shiny app |
output |
Relative folder where to create the service worker file. Usually corresponds to the folder used by shiny to serve static files, this folder must exist and is usually the www folder of your shiny project. |
icon |
Icon path to be used for the app, relative to the project root. Recommended size is 512x512px. If left NULL a default icon is provided. |
color |
Color of the app. Used to color the browser elements when the pwa is installed. |
offline_template |
Path to the offline template you want to use, relative to the project root folder. If left NULL the default template is used. |
offline_message |
When using the default offline page template defines the message to be displayed. |
Value
A UI definition that can be passed to the [shinyUI] function.
Note
For additional details on progressive web apps, visit https://developer.mozilla.org/en-US/docs/Web/Progressive_web_apps
Examples
if (interactive()){
library(shiny.pwa)
ui <- fluidPage(
pwa("https://myapp.com", output = "www")
)
server <- function(input, output, session) {
}
shinyApp(ui, server)
}
Clears and validates the provided domain.
Description
Clears and validates the provided domain.
Usage
validateDomain(domain)
Arguments
domain |
A string representing the domain of the application |
Value
A validated version of the domain
See Also
[validateLocation()], [validateIcon()]
Other validators:
validateIcon(),
validateLocation()
Validates the provided icon. If the icon does not exist returns a default one.
Description
Validates the provided icon. If the icon does not exist returns a default one.
Usage
validateIcon(icon)
Arguments
icon |
Path location for an icon relative to the project root |
Value
A valid icon path
See Also
[validateDomain()], [validateLocation()]
Other validators:
validateDomain(),
validateLocation()
Clears and validates the provided location
Description
Clears and validates the provided location
Usage
validateLocation(location)
Arguments
location |
a string representing the domain subfolder where the application is deployed. |
Value
A validated version of the location
See Also
[validateDomain()], [validateIcon()]
Other validators:
validateDomain(),
validateIcon()