Uh oh!
There was an error while loading. Please reload this page.
Support for index page templating#168
Uh oh!
There was an error while loading. Please reload this page.
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,14 +1,14 @@ | ||
| Package: dash | ||
| Title: An Interface to the Dash Ecosystem for Authoring Reactive Web Applications | ||
| Version: 0.3.0 | ||
| Authors@R: c(person("Chris", "Parmer", role = c("aut"), email = "chris@plot.ly"), person("Ryan Patrick", "Kyle", role = c("aut", "cre"), comment = c(ORCID = "0000-0001-5829-9867"), email = "ryan@plot.ly"), person("Carson", "Sievert", role = c("aut"), comment = c(ORCID = "0000-0002-4958-2844")), person(family = "Plotly Technologies", role = "cph")) | ||
| Description: A framework for building analytical web applications, Dash offers a pleasant and productive development experience. No JavaScript required. | ||
| Depends: | ||
| R (>= 3.0.2) | ||
| Imports: | ||
| dashHtmlComponents (== 1.0.2), | ||
| dashCoreComponents (== 1.8.0), | ||
| dashTable (== 4.6.0), | ||
| R6, | ||
| fiery (> 1.0.0), | ||
| routr (> 0.2.0), | ||
| @@ -32,8 +32,8 @@ Collate: | ||
| 'print.R' | ||
| 'internal.R' | ||
| Remotes: plotly/dash-html-components@55c3884, | ||
rpkyle marked this conversation as resolved.
Uh oh!There was an error while loading. Please reload this page. | ||
| plotly/dash-core-components@fc153b4, | ||
| plotly/dash-table@79d46ca | ||
| License: MIT + file LICENSE | ||
| Encoding: UTF-8 | ||
| LazyData: true | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -5,7 +5,7 @@ | ||
| #' @usage Dash | ||
| #' | ||
| #' @section Constructor: Dash$new( | ||
| #' name = NULL, | ||
| #' server = fiery::Fire$new(), | ||
| #' assets_folder = 'assets', | ||
| #' assets_url_path = '/assets', | ||
| @@ -24,7 +24,7 @@ | ||
| #' @section Arguments: | ||
| #' \tabular{lll}{ | ||
| #' `name` \tab \tab Character. The name of the Dash application (placed in the `<title>` | ||
| #' of the HTML page). DEPRECATED; please use `index_string()` or `interpolate_index()` instead.\cr | ||
| #' `server` \tab \tab The web server used to power the application. | ||
| #' Must be a [fiery::Fire] object.\cr | ||
| #' `assets_folder` \tab \tab Character. A path, relative to the current working directory, | ||
| @@ -100,6 +100,9 @@ | ||
| #' from the Dash backend. The latter may offer improved performance relative | ||
| #' to callbacks written in R. | ||
| #' } | ||
| #' \item{`title("dash")`}{ | ||
| #' The title of the app. If no title is supplied, Dash for R will use 'dash'. | ||
| #' } | ||
| #' \item{`callback_context()`}{ | ||
| #' The `callback_context` method permits retrieving the inputs which triggered | ||
| #' the firing of a given callback, and allows introspection of the input/state | ||
| @@ -114,7 +117,63 @@ | ||
| #' present a warning and return `NULL` if the Dash app was not loaded via `source()` | ||
| #' if the `DASH_APP_PATH` environment variable is undefined. | ||
| #' } | ||
| #' \item{`index_string(string)`}{ | ||
| #' The `index_string` method allows the specification of a custom index by changing | ||
rpkyle marked this conversation as resolved.
Uh oh!There was an error while loading. Please reload this page. | ||
| #' the default `HTML` template that is generated by the Dash UI. Meta tags, CSS, Javascript, | ||
| #' are some examples of features that can be modified. | ||
| #' This method will present a warning if your HTML template is missing any necessary elements | ||
| #' and return an error if a valid index is not defined. The following interpolation keys are | ||
| #' currently supported: | ||
| #' \describe{ | ||
| #' \item{`{%metas%}`}{Optional - The registered meta tags.} | ||
| #' \item{`{%favicon%}`}{Optional - A favicon link tag if found in assets.} | ||
| #' \item{`{%css%}`}{Optional - Link tags to css resources.} | ||
| #' \item{`{%config%}`}{Required - Config generated by dash for the renderer.} | ||
| #' \item{`{%app_entry%}`}{Required - The container where dash react components are rendered.} | ||
| #' \item{`{%scripts%}`}{Required - Collected dependencies scripts tags.} | ||
| #' } | ||
| #' \describe{ | ||
| #' \item{Example of a basic HTML index string:}{ | ||
| #' \preformatted{ | ||
| #' "<!DOCTYPE html> | ||
| #' <html> | ||
| #' <head> | ||
| #' \{\%meta_tags\%\} | ||
| #' <title>\{\{%css\%\}\}</title> | ||
| #' \{\%favicon\%\} | ||
| #' \{\%css_tags\%\} | ||
| #' </head> | ||
| #' <body> | ||
| #' \{\%app_entry\%\} | ||
| #' <footer> | ||
| #' \{\%config\%\} | ||
| #' \{\%scripts\%\} | ||
| #' </footer> | ||
| #' </body> | ||
| #' </html>" | ||
| #' } | ||
| #' } | ||
| #' } | ||
| #' } | ||
| #' \item{`interpolate_index(template_index, ...)`}{ | ||
| #' With the `interpolate_index` method, we can pass a custom index with template string | ||
| #' variables that are already evaluated. We can directly pass arguments to the `template_index` | ||
| #' by assigning them to variables present in the template. This is similar to the `index_string` method | ||
| #' but offers the ability to change the default components of the Dash index as seen in the example below: | ||
| #' \preformatted{ | ||
| #' app$interpolate_index( | ||
| #' template_index, | ||
| #' metas = "<meta_charset='UTF-8'/>", | ||
| #' renderer = renderer, | ||
| #' config = config) | ||
| #' } | ||
| #' \describe{ | ||
| #' \item{template_index}{Character. A formatted string with the HTML index string. Defaults to the initial template} | ||
| #' \item{...}{Named List. The unnamed arguments can be passed as individual named lists corresponding to the components | ||
| #' of the Dash html index. These include the same arguments as those found in the `index_string()` template.} | ||
| #' } | ||
| #' } | ||
| #' \item{`run_server(host = Sys.getenv('HOST', "127.0.0.1"), | ||
| #' port = Sys.getenv('PORT', 8050), block = TRUE, showcase = FALSE, ...)`}{ | ||
| #' The `run_server` method has 13 formal arguments, several of which are optional: | ||
| #' \describe{ | ||
| @@ -174,7 +233,7 @@ Dash <- R6::R6Class( | ||
| config = list(), | ||
| # i.e., the Dash$new() method | ||
| initialize = function(name = NULL, | ||
| server = fiery::Fire$new(), | ||
| assets_folder = 'assets', | ||
| assets_url_path = '/assets', | ||
| @@ -191,13 +250,18 @@ Dash <- R6::R6Class( | ||
| suppress_callback_exceptions = FALSE) { | ||
| # argument type checking | ||
| assertthat::assert_that(inherits(server, "Fire")) | ||
| assertthat::assert_that(is.logical(serve_locally)) | ||
| assertthat::assert_that(is.logical(suppress_callback_exceptions)) | ||
| # save relevant args as private fields | ||
| if (!is.null(name)) { | ||
| warning(sprintf( | ||
| "The supplied application title, '%s', should be set using the title() method, or passed via index_string() or interpolate_index(); it has been ignored, and 'dash' will be used instead.", | ||
| name), | ||
| call. = FALSE | ||
| ) | ||
| } | ||
| private$serve_locally <- serve_locally | ||
| private$eager_loading <- eager_loading | ||
| # remove leading and trailing slash(es) if present | ||
| @@ -763,11 +827,44 @@ Dash <- R6::R6Class( | ||
| sep="/"))) | ||
| }, | ||
| # ------------------------------------------------------------------------ | ||
| # specify a custom index string | ||
| # ------------------------------------------------------------------------ | ||
| index_string = function(string) { | ||
| private$custom_index <- validate_keys(string) | ||
| }, | ||
rpkyle marked this conversation as resolved.
Uh oh!There was an error while loading. Please reload this page. | ||
| # ------------------------------------------------------------------------ | ||
| # modify the templated variables by using the `interpolate_index` method. | ||
| # ------------------------------------------------------------------------ | ||
| interpolate_index = function(template_index = private$template_index[[1]], ...) { | ||
| template = template_index | ||
| kwargs <- list(...) | ||
| for (name in names(kwargs)) { | ||
| key = paste0('\\{\\%', name, '\\%\\}') | ||
| template = sub(key, kwargs[[name]], template) | ||
| } | ||
| invisible(validate_keys(names(kwargs))) | ||
| private$template_index <- template | ||
| }, | ||
| # ------------------------------------------------------------------------ | ||
| # specify a custom title | ||
| # ------------------------------------------------------------------------ | ||
| title = function(string = "dash") { | ||
| assertthat::assert_that(is.character(string)) | ||
| private$name <- string | ||
| }, | ||
| # ------------------------------------------------------------------------ | ||
| # convenient fiery wrappers | ||
| # ------------------------------------------------------------------------ | ||
| run_server = function(host = Sys.getenv('HOST', "127.0.0.1"), | ||
| port = Sys.getenv('PORT', 8050), | ||
| block = TRUE, | ||
| showcase = FALSE, | ||
| use_viewer = FALSE, | ||
| @@ -1266,6 +1363,24 @@ Dash <- R6::R6Class( | ||
| # akin to https://github.com/plotly/dash/blob/d2ebc837/dash/dash.py#L338 | ||
| # note discussion here https://github.com/plotly/dash/blob/d2ebc837/dash/dash.py#L279-L284 | ||
| custom_index = NULL, | ||
| template_index = c( | ||
| "<!DOCTYPE html> | ||
| <html> | ||
| <head> | ||
| {%meta_tags%} | ||
| <title>{%title%}</title> | ||
| {%favicon%} | ||
| {%css_tags%} | ||
| </head> | ||
| <body> | ||
| {%app_entry%} | ||
| <footer> | ||
| {%config%} | ||
| {%scripts%} | ||
| </footer> | ||
| </body> | ||
| </html>", NA), | ||
| .index = NULL, | ||
| generateReloadHash = function() { | ||
| @@ -1434,13 +1549,32 @@ Dash <- R6::R6Class( | ||
| css_tags <- all_tags[["css_tags"]] | ||
| # retrieve script tags for serving in the index | ||
| scripts <- all_tags[["scripts_tags"]] | ||
| # insert meta tags if present | ||
| meta_tags <- all_tags[["meta_tags"]] | ||
| # define the react-entry-point | ||
| app_entry <- "<div id='react-entry-point'><div class='_dash-loading'>Loading...</div></div>" | ||
| # define the dash default config key | ||
| config <- sprintf("<script id='_dash-config' type='application/json'> %s </script>", to_JSON(self$config)) | ||
| if (is.null(private$name)) | ||
| private$name <- 'dash' | ||
| if (!is.null(private$custom_index)) { | ||
| string_index <- glue::glue(private$custom_index, .open = "{%", .close = "%}") | ||
| private$.index <- string_index | ||
| } | ||
| else if (length(private$template_index) == 1) { | ||
| private$.index <- private$template_index | ||
| } | ||
| else { | ||
| private$.index <- sprintf( | ||
| '<!DOCTYPE html> | ||
| <html> | ||
| <head> | ||
| %s | ||
| @@ -1450,23 +1584,22 @@ Dash <- R6::R6Class( | ||
| </head> | ||
| <body> | ||
| %s | ||
| <footer> | ||
| %s | ||
| %s | ||
| </footer> | ||
| </body> | ||
| </html>', | ||
| meta_tags, | ||
| private$name, | ||
| favicon, | ||
| css_tags, | ||
| app_entry, | ||
| config, | ||
| scripts | ||
| ) | ||
| } | ||
| } | ||
| ) | ||
| ) | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.