Add Dash 2 layout syntax wrappers and html tags

.circleci/config.yml

@@ -1,15 +1,13 @@
 version: 2
 
 jobs:
-
-
  "test": &test-template
  working_directory: ~/dashr
  docker:
  - image: plotly/dashr:ci
  auth:
  username: dashautomation
- password: $DASH_PAT_DOCKERHUB
+ password: $DASH_PAT_DOCKERHUB
  environment:
  PERCY_PARALLEL_TOTAL: '-1'
  PUPPETEER_SKIP_CHROMIUM_DOWNLOAD: 'True'
@@ -33,18 +31,22 @@ jobs:
  - run:
  name: 🚧 install R dependencies
  command: |
- sudo Rscript -e 'commit_hash <- readChar("commit.txt", file.info("commit.txt")$size); message("Preparing to install plotly/dashR ", commit_hash, " ..."); install.packages("remotes"); remotes::install_github("plotly/dashR", upgrade=TRUE, ref=commit_hash, force=TRUE)'
+ sudo Rscript -e 'commit_hash <- readChar("commit.txt", file.info("commit.txt")$size); message("Preparing to install plotly/dashR ", commit_hash, " ..."); install.packages("remotes"); remotes::install_github("plotly/dashR", upgrade=TRUE, ref=commit_hash, dependencies=TRUE, force=TRUE)'
 
  - run:
  name: ⚙️ Integration tests
  command: |
+ curl --proto '=https' --tlsv1.2 -sSf -o rust-init.sh https://sh.rustup.rs
+ chmod ugo+x rust-init.sh
+ ./rust-init.sh -y
  python -m venv venv
  . venv/bin/activate
  git clone --depth 1 https://github.com/plotly/dash.git dash-main
+ export PATH=$PATH:/home/circleci/.local/bin/:/home/circleci/.cargo/bin
+ export RUSTC_BOOTSTRAP=1
  cd dash-main && pip install -e .[dev,testing] --progress-bar off && cd ..
  cd dash-main/\@plotly/dash-generator-test-component-nested && npm ci && npm run build && sudo R CMD INSTALL . && cd ../../..
  cd dash-main/\@plotly/dash-generator-test-component-standard && npm ci && npm run build && sudo R CMD INSTALL . && cd ../../..
- export PATH=$PATH:/home/circleci/.local/bin/
  pytest --nopercyfinalize --junitxml=test-reports/dashr.xml tests/integration/
  - store_artifacts:
  path: test-reports

CHANGELOG.md

@@ -2,9 +2,12 @@
 All notable changes to `dash` will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
-## [1.0.0] - 2021-03-04
+## [1.0.0] - UNRELEASED
+### Added
+- Dash wrapper functions are included, which simplify the layout syntax for writing Dash apps. This includes the ability to pipe in the `app` object to layout and meta functions, as well as tags which simplify `html` component arguments and children. [#265](https://github.com/plotly/dashR/pull/265)
+
 ### Changed
-- Unify the core Dash packages (dash, dashCoreComponents, dashHtmlComponents, dashTable) for streamlined maintenance and accessibility. The namespaces of these packages will be combined under the `dash` namespace, and all artifacts from the ancillary dash packages will be included with Dash for R. [#243](https://github.com/plotly/dashr/pull/243)
+- Unified the core Dash packages (dash, dashCoreComponents, dashHtmlComponents, dashTable) for streamlined maintenance and accessibility. The namespaces of these packages will be combined under the `dash` namespace, and all artifacts from the ancillary dash packages will be included with Dash for R. [#243](https://github.com/plotly/dashr/pull/243)
 
 ### Fixed
 - Minor fix for favicon issue continued from [#240](https://github.com/plotly/dashr/pull/240) (for more details, see [#243](https://github.com/plotly/dashR/pull/243#issuecomment-842813526)).

DESCRIPTION

@@ -19,7 +19,8 @@ Imports:
  mime,
  crayon,
  brotli,
- glue
+ glue,
+ magrittr
 Suggests:
  testthat
 License: MIT + file LICENSE

NAMESPACE

@@ -1,15 +1,34 @@
 # Generated by roxygen2: do not edit by hand
 
 S3method(print,dash_component)
+export("%>%")
 export(ALL)
 export(ALLSMALLER)
 export(Dash)
 export(MATCH)
+export(add_meta)
+export(add_script)
+export(add_stylesheet)
+export(br)
+export(button)
 export(clientsideFunction)
 export(dashNoUpdate)
+export(dash_app)
+export(dash_tag)
+export(div)
+export(h1)
+export(h2)
+export(h3)
+export(h4)
+export(html)
 export(input)
 export(output)
+export(p)
+export(run_app)
+export(set_layout)
+export(span)
 export(state)
+export(strong)
 importFrom(R6,R6Class)
 importFrom(assertthat,assert_that)
 importFrom(base64enc,base64encode)
@@ -25,6 +44,7 @@ importFrom(htmltools,htmlDependencies)
 importFrom(htmltools,htmlDependency)
 importFrom(htmltools,renderDependencies)
 importFrom(jsonlite,toJSON)
+importFrom(magrittr,"%>%")
 importFrom(reqres,default_parsers)
 importFrom(routr,Route)
 importFrom(routr,RouteStack)

R/all_tags.R

@@ -0,0 +1,135 @@
+## Generated by `scripts/generate_tags.R`; do not edit by hand
+all_tags <- c(
+ "a",
+ "abbr",
+ "acronym",
+ "address",
+ "area",
+ "article",
+ "aside",
+ "audio",
+ "b",
+ "base",
+ "basefont",
+ "bdi",
+ "bdo",
+ "big",
+ "blink",
+ "blockquote",
+ "br",
+ "button",
+ "canvas",
+ "caption",
+ "center",
+ "cite",
+ "code",
+ "col",
+ "colgroup",
+ "command",
+ "content",
+ "data",
+ "datalist",
+ "dd",
+ "del",
+ "details",
+ "dfn",
+ "dialog",
+ "div",
+ "dl",
+ "dt",
+ "element",
+ "em",
+ "embed",
+ "fieldset",
+ "figcaption",
+ "figure",
+ "font",
+ "footer",
+ "form",
+ "frame",
+ "frameset",
+ "h1",
+ "h2",
+ "h3",
+ "h4",
+ "h5",
+ "h6",
+ "header",
+ "hgroup",
+ "hr",
+ "i",
+ "iframe",
+ "img",
+ "ins",
+ "isindex",
+ "kbd",
+ "keygen",
+ "label",
+ "legend",
+ "li",
+ "link",
+ "listing",
+ "main",
+ "map",
+ "mark",
+ "marquee",
+ "meta",
+ "meter",
+ "multicol",
+ "nav",
+ "nextid",
+ "nobr",
+ "noscript",
+ "object",
+ "ol",
+ "optgroup",
+ "option",
+ "output",
+ "p",
+ "param",
+ "picture",
+ "plaintext",
+ "pre",
+ "progress",
+ "q",
+ "rb",
+ "rp",
+ "rt",
+ "rtc",
+ "ruby",
+ "s",
+ "samp",
+ "script",
+ "section",
+ "select",
+ "shadow",
+ "slot",
+ "small",
+ "source",
+ "spacer",
+ "span",
+ "strike",
+ "strong",
+ "sub",
+ "summary",
+ "sup",
+ "table",
+ "tbody",
+ "td",
+ "template",
+ "textarea",
+ "tfoot",
+ "th",
+ "thead",
+ "time",
+ "title",
+ "tr",
+ "track",
+ "u",
+ "ul",
+ "var",
+ "video",
+ "wbr",
+ "xmp"
+)
+names(all_tags) <- all_tags

R/tags.R

@@ -0,0 +1,123 @@
+#' Create HTML tags
+#'
+#' Create an HTML tag to place in a Dash app layout. All tags are available
+#' in the `html` list, and some common tags have shortcuts as functions for
+#' convenience (e.g. `h1()` produces `<h1>` and is equivalent to `html$h1()`).
+#'
+#' @name tags
+#' @param ... Any named arguments become tag attributes, and any unnamed
+#' arguments become children. A named argument with a value of `NULL` will
+#' be removed, and a named argument with a value of `NA` will be rendered
+#' as a boolean argument. See 'Special attributes' below for more information.
+#' @param n_clicks (Numeric) An integer that represents the number of times
+#' that this element has been clicked on. For advanced users only.
+#' @param tag_name The name of the HTML tag.
+#' @param content List of attributes and children.
+#'
+#' @section Special attributes:
+#' There are a few HTML attributes that are treated in a special way:
+#' - To add a `class` attribute, use the `className` parameter
+#' - To add a `for` attribute, use the `htmlFor` parameter
+#' - The `style` attribute is not provided as a string. Instead, it's provided
+#' as a named list, where the name and value of each element correspond to the
+#' CSS property and value. Each CSS property should be written in camelCase.
+#'
+#' @examples
+#' app <- dash_app()
+#' app %>% set_layout(
+#' html$div(
+#' h1(
+#' "title",
+#' style = list(
+#' "color" = "red",
+#' "backgroundColor" = "blue"
+#' )
+#' ),
+#' "some text",
+#' button(
+#' "can't click me",
+#' disabled = NA,
+#' className = "mybtn"
+#' )
+#' )
+#' )
+#' app %>% run_app()
+#'
+NULL
+
+#' @rdname tags
+#' @format NULL
+#' @export
+html <- lapply(all_tags, function(tag_name) {
+ rlang::new_function(
+ args = alist(... = , n_clicks = NULL),
+ body = rlang::expr({
+ dash_tag(!!tag_name, list(...), n_clicks = n_clicks)
+ }),
+ env = asNamespace("dash")
+ )
+})
+
+#' @rdname tags
+#' @export
+h1 <- html$h1
+
+#' @rdname tags
+#' @export
+h2 <- html$h2
+
+#' @rdname tags
+#' @export
+h3 <- html$h3
+
+#' @rdname tags
+#' @export
+h4 <- html$h4
+
+#' @rdname tags
+#' @export
+div <- html$div
+
+#' @rdname tags
+#' @export
+span <- html$span
+
+#' @rdname tags
+#' @export
+p <- html$p
+
+#' @rdname tags
+#' @export
+strong <- html$strong
+
+#' @rdname tags
+#' @export
+br <- html$br
+
+#' @rdname tags
+#' @export
+button <- html$button
+
+#' @rdname tags
+#' @export
+dash_tag <- function(tag_name, content = list(), n_clicks = NULL) {
+ content_names <- rlang::names2(content)
+ content_named_idx <- nzchar(content_names)
+ attributes <- remove_empty(content[content_named_idx])
+ children <- unname(content[!content_named_idx])
+
+ # Support boolean attributes
+ attributes[is.na(attributes)] <- names(attributes[is.na(attributes)])
+ attributes[attributes == ""] <- names(attributes[attributes == ""])
+
+ tag_params <- attributes
+ tag_params[["children"]] <- children
+ tag_params[["n_clicks"]] <- n_clicks
+
+ dash_html_fx <- paste0("html", toupper(substring(tag_name, 1, 1)), substring(tag_name, 2))
+ if (tag_name %in% c("map", "object")) {
+ dash_html_fx <- paste0(dash_html_fx, "El")
+ }
+
+ do.call(getExportedValue("dash", dash_html_fx), tag_params)
+}

R/utils-pipe.R

@@ -0,0 +1,14 @@
+#' Pipe operator
+#'
+#' See \code{magrittr::\link[magrittr:pipe]{\%>\%}} for details.
+#'
+#' @name %>%
+#' @rdname pipe
+#' @keywords internal
+#' @export
+#' @importFrom magrittr %>%
+#' @usage lhs \%>\% rhs
+#' @param lhs A value or the magrittr placeholder.
+#' @param rhs A function call using the magrittr semantics.
+#' @return The result of calling `rhs(lhs)`.
+NULL

.circleci/config.yml

@@ -1,15 +1,13 @@
 version: 2
 
 jobs:
-
-
  "test": &test-template
  working_directory: ~/dashr
  docker:
  - image: plotly/dashr:ci
  auth:
  username: dashautomation
- password: $DASH_PAT_DOCKERHUB
+ password: $DASH_PAT_DOCKERHUB
  environment:
  PERCY_PARALLEL_TOTAL: '-1'
  PUPPETEER_SKIP_CHROMIUM_DOWNLOAD: 'True'
@@ -33,18 +31,22 @@ jobs:
  - run:
  name: 🚧 install R dependencies
  command: |
- sudo Rscript -e 'commit_hash <- readChar("commit.txt", file.info("commit.txt")$size); message("Preparing to install plotly/dashR ", commit_hash, " ..."); install.packages("remotes"); remotes::install_github("plotly/dashR", upgrade=TRUE, ref=commit_hash, force=TRUE)'
+ sudo Rscript -e 'commit_hash <- readChar("commit.txt", file.info("commit.txt")$size); message("Preparing to install plotly/dashR ", commit_hash, " ..."); install.packages("remotes"); remotes::install_github("plotly/dashR", upgrade=TRUE, ref=commit_hash, dependencies=TRUE, force=TRUE)'
 
  - run:
  name: ⚙️ Integration tests
  command: |
+ curl --proto '=https' --tlsv1.2 -sSf -o rust-init.sh https://sh.rustup.rs
+ chmod ugo+x rust-init.sh
+ ./rust-init.sh -y
  python -m venv venv
  . venv/bin/activate
  git clone --depth 1 https://github.com/plotly/dash.git dash-main
+ export PATH=$PATH:/home/circleci/.local/bin/:/home/circleci/.cargo/bin
+ export RUSTC_BOOTSTRAP=1
  cd dash-main && pip install -e .[dev,testing] --progress-bar off && cd ..
  cd dash-main/\@plotly/dash-generator-test-component-nested && npm ci && npm run build && sudo R CMD INSTALL . && cd ../../..
  cd dash-main/\@plotly/dash-generator-test-component-standard && npm ci && npm run build && sudo R CMD INSTALL . && cd ../../..
- export PATH=$PATH:/home/circleci/.local/bin/
  pytest --nopercyfinalize --junitxml=test-reports/dashr.xml tests/integration/
  - store_artifacts:
  path: test-reports

CHANGELOG.md

@@ -2,9 +2,12 @@
 All notable changes to `dash` will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
-## [1.0.0] - 2021-03-04
+## [1.0.0] - UNRELEASED
+### Added
+- Dash wrapper functions are included, which simplify the layout syntax for writing Dash apps. This includes the ability to pipe in the `app` object to layout and meta functions, as well as tags which simplify `html` component arguments and children. [#265](https://github.com/plotly/dashR/pull/265)
+
 ### Changed
-- Unify the core Dash packages (dash, dashCoreComponents, dashHtmlComponents, dashTable) for streamlined maintenance and accessibility. The namespaces of these packages will be combined under the `dash` namespace, and all artifacts from the ancillary dash packages will be included with Dash for R. [#243](https://github.com/plotly/dashr/pull/243)
+- Unified the core Dash packages (dash, dashCoreComponents, dashHtmlComponents, dashTable) for streamlined maintenance and accessibility. The namespaces of these packages will be combined under the `dash` namespace, and all artifacts from the ancillary dash packages will be included with Dash for R. [#243](https://github.com/plotly/dashr/pull/243)
 
 ### Fixed
 - Minor fix for favicon issue continued from [#240](https://github.com/plotly/dashr/pull/240) (for more details, see [#243](https://github.com/plotly/dashR/pull/243#issuecomment-842813526)).

DESCRIPTION

@@ -19,7 +19,8 @@ Imports:
  mime,
  crayon,
  brotli,
- glue
+ glue,
+ magrittr
 Suggests:
  testthat
 License: MIT + file LICENSE

NAMESPACE

@@ -1,15 +1,34 @@
 # Generated by roxygen2: do not edit by hand
 
 S3method(print,dash_component)
+export("%>%")
 export(ALL)
 export(ALLSMALLER)
 export(Dash)
 export(MATCH)
+export(add_meta)
+export(add_script)
+export(add_stylesheet)
+export(br)
+export(button)
 export(clientsideFunction)
 export(dashNoUpdate)
+export(dash_app)
+export(dash_tag)
+export(div)
+export(h1)
+export(h2)
+export(h3)
+export(h4)
+export(html)
 export(input)
 export(output)
+export(p)
+export(run_app)
+export(set_layout)
+export(span)
 export(state)
+export(strong)
 importFrom(R6,R6Class)
 importFrom(assertthat,assert_that)
 importFrom(base64enc,base64encode)
@@ -25,6 +44,7 @@ importFrom(htmltools,htmlDependencies)
 importFrom(htmltools,htmlDependency)
 importFrom(htmltools,renderDependencies)
 importFrom(jsonlite,toJSON)
+importFrom(magrittr,"%>%")
 importFrom(reqres,default_parsers)
 importFrom(routr,Route)
 importFrom(routr,RouteStack)

R/all_tags.R

@@ -0,0 +1,135 @@
+## Generated by `scripts/generate_tags.R`; do not edit by hand
+all_tags <- c(
+ "a",
+ "abbr",
+ "acronym",
+ "address",
+ "area",
+ "article",
+ "aside",
+ "audio",
+ "b",
+ "base",
+ "basefont",
+ "bdi",
+ "bdo",
+ "big",
+ "blink",
+ "blockquote",
+ "br",
+ "button",
+ "canvas",
+ "caption",
+ "center",
+ "cite",
+ "code",
+ "col",
+ "colgroup",
+ "command",
+ "content",
+ "data",
+ "datalist",
+ "dd",
+ "del",
+ "details",
+ "dfn",
+ "dialog",
+ "div",
+ "dl",
+ "dt",
+ "element",
+ "em",
+ "embed",
+ "fieldset",
+ "figcaption",
+ "figure",
+ "font",
+ "footer",
+ "form",
+ "frame",
+ "frameset",
+ "h1",
+ "h2",
+ "h3",
+ "h4",
+ "h5",
+ "h6",
+ "header",
+ "hgroup",
+ "hr",
+ "i",
+ "iframe",
+ "img",
+ "ins",
+ "isindex",
+ "kbd",
+ "keygen",
+ "label",
+ "legend",
+ "li",
+ "link",
+ "listing",
+ "main",
+ "map",
+ "mark",
+ "marquee",
+ "meta",
+ "meter",
+ "multicol",
+ "nav",
+ "nextid",
+ "nobr",
+ "noscript",
+ "object",
+ "ol",
+ "optgroup",
+ "option",
+ "output",
+ "p",
+ "param",
+ "picture",
+ "plaintext",
+ "pre",
+ "progress",
+ "q",
+ "rb",
+ "rp",
+ "rt",
+ "rtc",
+ "ruby",
+ "s",
+ "samp",
+ "script",
+ "section",
+ "select",
+ "shadow",
+ "slot",
+ "small",
+ "source",
+ "spacer",
+ "span",
+ "strike",
+ "strong",
+ "sub",
+ "summary",
+ "sup",
+ "table",
+ "tbody",
+ "td",
+ "template",
+ "textarea",
+ "tfoot",
+ "th",
+ "thead",
+ "time",
+ "title",
+ "tr",
+ "track",
+ "u",
+ "ul",
+ "var",
+ "video",
+ "wbr",
+ "xmp"
+)
+names(all_tags) <- all_tags

R/tags.R

@@ -0,0 +1,123 @@
+#' Create HTML tags
+#'
+#' Create an HTML tag to place in a Dash app layout. All tags are available
+#' in the `html` list, and some common tags have shortcuts as functions for
+#' convenience (e.g. `h1()` produces `<h1>` and is equivalent to `html$h1()`).
+#'
+#' @name tags
+#' @param ... Any named arguments become tag attributes, and any unnamed
+#' arguments become children. A named argument with a value of `NULL` will
+#' be removed, and a named argument with a value of `NA` will be rendered
+#' as a boolean argument. See 'Special attributes' below for more information.
+#' @param n_clicks (Numeric) An integer that represents the number of times
+#' that this element has been clicked on. For advanced users only.
+#' @param tag_name The name of the HTML tag.
+#' @param content List of attributes and children.
+#'
+#' @section Special attributes:
+#' There are a few HTML attributes that are treated in a special way:
+#' - To add a `class` attribute, use the `className` parameter
+#' - To add a `for` attribute, use the `htmlFor` parameter
+#' - The `style` attribute is not provided as a string. Instead, it's provided
+#' as a named list, where the name and value of each element correspond to the
+#' CSS property and value. Each CSS property should be written in camelCase.
+#'
+#' @examples
+#' app <- dash_app()
+#' app %>% set_layout(
+#' html$div(
+#' h1(
+#' "title",
+#' style = list(
+#' "color" = "red",
+#' "backgroundColor" = "blue"
+#' )
+#' ),
+#' "some text",
+#' button(
+#' "can't click me",
+#' disabled = NA,
+#' className = "mybtn"
+#' )
+#' )
+#' )
+#' app %>% run_app()
+#'
+NULL
+
+#' @rdname tags
+#' @format NULL
+#' @export
+html <- lapply(all_tags, function(tag_name) {
+ rlang::new_function(
+ args = alist(... = , n_clicks = NULL),
+ body = rlang::expr({
+ dash_tag(!!tag_name, list(...), n_clicks = n_clicks)
+ }),
+ env = asNamespace("dash")
+ )
+})
+
+#' @rdname tags
+#' @export
+h1 <- html$h1
+
+#' @rdname tags
+#' @export
+h2 <- html$h2
+
+#' @rdname tags
+#' @export
+h3 <- html$h3
+
+#' @rdname tags
+#' @export
+h4 <- html$h4
+
+#' @rdname tags
+#' @export
+div <- html$div
+
+#' @rdname tags
+#' @export
+span <- html$span
+
+#' @rdname tags
+#' @export
+p <- html$p
+
+#' @rdname tags
+#' @export
+strong <- html$strong
+
+#' @rdname tags
+#' @export
+br <- html$br
+
+#' @rdname tags
+#' @export
+button <- html$button
+
+#' @rdname tags
+#' @export
+dash_tag <- function(tag_name, content = list(), n_clicks = NULL) {
+ content_names <- rlang::names2(content)
+ content_named_idx <- nzchar(content_names)
+ attributes <- remove_empty(content[content_named_idx])
+ children <- unname(content[!content_named_idx])
+
+ # Support boolean attributes
+ attributes[is.na(attributes)] <- names(attributes[is.na(attributes)])
+ attributes[attributes == ""] <- names(attributes[attributes == ""])
+
+ tag_params <- attributes
+ tag_params[["children"]] <- children
+ tag_params[["n_clicks"]] <- n_clicks
+
+ dash_html_fx <- paste0("html", toupper(substring(tag_name, 1, 1)), substring(tag_name, 2))
+ if (tag_name %in% c("map", "object")) {
+ dash_html_fx <- paste0(dash_html_fx, "El")
+ }
+
+ do.call(getExportedValue("dash", dash_html_fx), tag_params)
+}

R/utils-pipe.R

@@ -0,0 +1,14 @@
+#' Pipe operator
+#'
+#' See \code{magrittr::\link[magrittr:pipe]{\%>\%}} for details.
+#'
+#' @name %>%
+#' @rdname pipe
+#' @keywords internal
+#' @export
+#' @importFrom magrittr %>%
+#' @usage lhs \%>\% rhs
+#' @param lhs A value or the magrittr placeholder.
+#' @param rhs A function call using the magrittr semantics.
+#' @return The result of calling `rhs(lhs)`.
+NULL

.circleci/config.yml

@@ -1,15 +1,13 @@
 version: 2
 
 jobs:
-
-
  "test": &test-template
  working_directory: ~/dashr
  docker:
  - image: plotly/dashr:ci
  auth:
  username: dashautomation
- password: $DASH_PAT_DOCKERHUB
+ password: $DASH_PAT_DOCKERHUB
  environment:
  PERCY_PARALLEL_TOTAL: '-1'
  PUPPETEER_SKIP_CHROMIUM_DOWNLOAD: 'True'
@@ -33,18 +31,22 @@ jobs:
  - run:
  name: 🚧 install R dependencies
  command: |
- sudo Rscript -e 'commit_hash <- readChar("commit.txt", file.info("commit.txt")$size); message("Preparing to install plotly/dashR ", commit_hash, " ..."); install.packages("remotes"); remotes::install_github("plotly/dashR", upgrade=TRUE, ref=commit_hash, force=TRUE)'
+ sudo Rscript -e 'commit_hash <- readChar("commit.txt", file.info("commit.txt")$size); message("Preparing to install plotly/dashR ", commit_hash, " ..."); install.packages("remotes"); remotes::install_github("plotly/dashR", upgrade=TRUE, ref=commit_hash, dependencies=TRUE, force=TRUE)'
 
  - run:
  name: ⚙️ Integration tests
  command: |
+ curl --proto '=https' --tlsv1.2 -sSf -o rust-init.sh https://sh.rustup.rs
+ chmod ugo+x rust-init.sh
+ ./rust-init.sh -y
  python -m venv venv
  . venv/bin/activate
  git clone --depth 1 https://github.com/plotly/dash.git dash-main
+ export PATH=$PATH:/home/circleci/.local/bin/:/home/circleci/.cargo/bin
+ export RUSTC_BOOTSTRAP=1
  cd dash-main && pip install -e .[dev,testing] --progress-bar off && cd ..
  cd dash-main/\@plotly/dash-generator-test-component-nested && npm ci && npm run build && sudo R CMD INSTALL . && cd ../../..
  cd dash-main/\@plotly/dash-generator-test-component-standard && npm ci && npm run build && sudo R CMD INSTALL . && cd ../../..
- export PATH=$PATH:/home/circleci/.local/bin/
  pytest --nopercyfinalize --junitxml=test-reports/dashr.xml tests/integration/
  - store_artifacts:
  path: test-reports

CHANGELOG.md

@@ -2,9 +2,12 @@
 All notable changes to `dash` will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
-## [1.0.0] - 2021-03-04
+## [1.0.0] - UNRELEASED
+### Added
+- Dash wrapper functions are included, which simplify the layout syntax for writing Dash apps. This includes the ability to pipe in the `app` object to layout and meta functions, as well as tags which simplify `html` component arguments and children. [#265](https://github.com/plotly/dashR/pull/265)
+
 ### Changed
-- Unify the core Dash packages (dash, dashCoreComponents, dashHtmlComponents, dashTable) for streamlined maintenance and accessibility. The namespaces of these packages will be combined under the `dash` namespace, and all artifacts from the ancillary dash packages will be included with Dash for R. [#243](https://github.com/plotly/dashr/pull/243)
+- Unified the core Dash packages (dash, dashCoreComponents, dashHtmlComponents, dashTable) for streamlined maintenance and accessibility. The namespaces of these packages will be combined under the `dash` namespace, and all artifacts from the ancillary dash packages will be included with Dash for R. [#243](https://github.com/plotly/dashr/pull/243)
 
 ### Fixed
 - Minor fix for favicon issue continued from [#240](https://github.com/plotly/dashr/pull/240) (for more details, see [#243](https://github.com/plotly/dashR/pull/243#issuecomment-842813526)).

DESCRIPTION

@@ -19,7 +19,8 @@ Imports:
  mime,
  crayon,
  brotli,
- glue
+ glue,
+ magrittr
 Suggests:
  testthat
 License: MIT + file LICENSE

NAMESPACE

@@ -1,15 +1,34 @@
 # Generated by roxygen2: do not edit by hand
 
 S3method(print,dash_component)
+export("%>%")
 export(ALL)
 export(ALLSMALLER)
 export(Dash)
 export(MATCH)
+export(add_meta)
+export(add_script)
+export(add_stylesheet)
+export(br)
+export(button)
 export(clientsideFunction)
 export(dashNoUpdate)
+export(dash_app)
+export(dash_tag)
+export(div)
+export(h1)
+export(h2)
+export(h3)
+export(h4)
+export(html)
 export(input)
 export(output)
+export(p)
+export(run_app)
+export(set_layout)
+export(span)
 export(state)
+export(strong)
 importFrom(R6,R6Class)
 importFrom(assertthat,assert_that)
 importFrom(base64enc,base64encode)
@@ -25,6 +44,7 @@ importFrom(htmltools,htmlDependencies)
 importFrom(htmltools,htmlDependency)
 importFrom(htmltools,renderDependencies)
 importFrom(jsonlite,toJSON)
+importFrom(magrittr,"%>%")
 importFrom(reqres,default_parsers)
 importFrom(routr,Route)
 importFrom(routr,RouteStack)

R/all_tags.R

@@ -0,0 +1,135 @@
+## Generated by `scripts/generate_tags.R`; do not edit by hand
+all_tags <- c(
+ "a",
+ "abbr",
+ "acronym",
+ "address",
+ "area",
+ "article",
+ "aside",
+ "audio",
+ "b",
+ "base",
+ "basefont",
+ "bdi",
+ "bdo",
+ "big",
+ "blink",
+ "blockquote",
+ "br",
+ "button",
+ "canvas",
+ "caption",
+ "center",
+ "cite",
+ "code",
+ "col",
+ "colgroup",
+ "command",
+ "content",
+ "data",
+ "datalist",
+ "dd",
+ "del",
+ "details",
+ "dfn",
+ "dialog",
+ "div",
+ "dl",
+ "dt",
+ "element",
+ "em",
+ "embed",
+ "fieldset",
+ "figcaption",
+ "figure",
+ "font",
+ "footer",
+ "form",
+ "frame",
+ "frameset",
+ "h1",
+ "h2",
+ "h3",
+ "h4",
+ "h5",
+ "h6",
+ "header",
+ "hgroup",
+ "hr",
+ "i",
+ "iframe",
+ "img",
+ "ins",
+ "isindex",
+ "kbd",
+ "keygen",
+ "label",
+ "legend",
+ "li",
+ "link",
+ "listing",
+ "main",
+ "map",
+ "mark",
+ "marquee",
+ "meta",
+ "meter",
+ "multicol",
+ "nav",
+ "nextid",
+ "nobr",
+ "noscript",
+ "object",
+ "ol",
+ "optgroup",
+ "option",
+ "output",
+ "p",
+ "param",
+ "picture",
+ "plaintext",
+ "pre",
+ "progress",
+ "q",
+ "rb",
+ "rp",
+ "rt",
+ "rtc",
+ "ruby",
+ "s",
+ "samp",
+ "script",
+ "section",
+ "select",
+ "shadow",
+ "slot",
+ "small",
+ "source",
+ "spacer",
+ "span",
+ "strike",
+ "strong",
+ "sub",
+ "summary",
+ "sup",
+ "table",
+ "tbody",
+ "td",
+ "template",
+ "textarea",
+ "tfoot",
+ "th",
+ "thead",
+ "time",
+ "title",
+ "tr",
+ "track",
+ "u",
+ "ul",
+ "var",
+ "video",
+ "wbr",
+ "xmp"
+)
+names(all_tags) <- all_tags

R/tags.R

@@ -0,0 +1,123 @@
+#' Create HTML tags
+#'
+#' Create an HTML tag to place in a Dash app layout. All tags are available
+#' in the `html` list, and some common tags have shortcuts as functions for
+#' convenience (e.g. `h1()` produces `<h1>` and is equivalent to `html$h1()`).
+#'
+#' @name tags
+#' @param ... Any named arguments become tag attributes, and any unnamed
+#' arguments become children. A named argument with a value of `NULL` will
+#' be removed, and a named argument with a value of `NA` will be rendered
+#' as a boolean argument. See 'Special attributes' below for more information.
+#' @param n_clicks (Numeric) An integer that represents the number of times
+#' that this element has been clicked on. For advanced users only.
+#' @param tag_name The name of the HTML tag.
+#' @param content List of attributes and children.
+#'
+#' @section Special attributes:
+#' There are a few HTML attributes that are treated in a special way:
+#' - To add a `class` attribute, use the `className` parameter
+#' - To add a `for` attribute, use the `htmlFor` parameter
+#' - The `style` attribute is not provided as a string. Instead, it's provided
+#' as a named list, where the name and value of each element correspond to the
+#' CSS property and value. Each CSS property should be written in camelCase.
+#'
+#' @examples
+#' app <- dash_app()
+#' app %>% set_layout(
+#' html$div(
+#' h1(
+#' "title",
+#' style = list(
+#' "color" = "red",
+#' "backgroundColor" = "blue"
+#' )
+#' ),
+#' "some text",
+#' button(
+#' "can't click me",
+#' disabled = NA,
+#' className = "mybtn"
+#' )
+#' )
+#' )
+#' app %>% run_app()
+#'
+NULL
+
+#' @rdname tags
+#' @format NULL
+#' @export
+html <- lapply(all_tags, function(tag_name) {
+ rlang::new_function(
+ args = alist(... = , n_clicks = NULL),
+ body = rlang::expr({
+ dash_tag(!!tag_name, list(...), n_clicks = n_clicks)
+ }),
+ env = asNamespace("dash")
+ )
+})
+
+#' @rdname tags
+#' @export
+h1 <- html$h1
+
+#' @rdname tags
+#' @export
+h2 <- html$h2
+
+#' @rdname tags
+#' @export
+h3 <- html$h3
+
+#' @rdname tags
+#' @export
+h4 <- html$h4
+
+#' @rdname tags
+#' @export
+div <- html$div
+
+#' @rdname tags
+#' @export
+span <- html$span
+
+#' @rdname tags
+#' @export
+p <- html$p
+
+#' @rdname tags
+#' @export
+strong <- html$strong
+
+#' @rdname tags
+#' @export
+br <- html$br
+
+#' @rdname tags
+#' @export
+button <- html$button
+
+#' @rdname tags
+#' @export
+dash_tag <- function(tag_name, content = list(), n_clicks = NULL) {
+ content_names <- rlang::names2(content)
+ content_named_idx <- nzchar(content_names)
+ attributes <- remove_empty(content[content_named_idx])
+ children <- unname(content[!content_named_idx])
+
+ # Support boolean attributes
+ attributes[is.na(attributes)] <- names(attributes[is.na(attributes)])
+ attributes[attributes == ""] <- names(attributes[attributes == ""])
+
+ tag_params <- attributes
+ tag_params[["children"]] <- children
+ tag_params[["n_clicks"]] <- n_clicks
+
+ dash_html_fx <- paste0("html", toupper(substring(tag_name, 1, 1)), substring(tag_name, 2))
+ if (tag_name %in% c("map", "object")) {
+ dash_html_fx <- paste0(dash_html_fx, "El")
+ }
+
+ do.call(getExportedValue("dash", dash_html_fx), tag_params)
+}

R/utils-pipe.R

@@ -0,0 +1,14 @@
+#' Pipe operator
+#'
+#' See \code{magrittr::\link[magrittr:pipe]{\%>\%}} for details.
+#'
+#' @name %>%
+#' @rdname pipe
+#' @keywords internal
+#' @export
+#' @importFrom magrittr %>%
+#' @usage lhs \%>\% rhs
+#' @param lhs A value or the magrittr placeholder.
+#' @param rhs A function call using the magrittr semantics.
+#' @return The result of calling `rhs(lhs)`.
+NULL

.circleci/config.yml

@@ -1,15 +1,13 @@
 version: 2
 
 jobs:
-
-
  "test": &test-template
  working_directory: ~/dashr
  docker:
  - image: plotly/dashr:ci
  auth:
  username: dashautomation
- password: $DASH_PAT_DOCKERHUB
+ password: $DASH_PAT_DOCKERHUB
  environment:
  PERCY_PARALLEL_TOTAL: '-1'
  PUPPETEER_SKIP_CHROMIUM_DOWNLOAD: 'True'
@@ -33,18 +31,22 @@ jobs:
  - run:
  name: 🚧 install R dependencies
  command: |
- sudo Rscript -e 'commit_hash <- readChar("commit.txt", file.info("commit.txt")$size); message("Preparing to install plotly/dashR ", commit_hash, " ..."); install.packages("remotes"); remotes::install_github("plotly/dashR", upgrade=TRUE, ref=commit_hash, force=TRUE)'
+ sudo Rscript -e 'commit_hash <- readChar("commit.txt", file.info("commit.txt")$size); message("Preparing to install plotly/dashR ", commit_hash, " ..."); install.packages("remotes"); remotes::install_github("plotly/dashR", upgrade=TRUE, ref=commit_hash, dependencies=TRUE, force=TRUE)'
 
  - run:
  name: ⚙️ Integration tests
  command: |
+ curl --proto '=https' --tlsv1.2 -sSf -o rust-init.sh https://sh.rustup.rs
+ chmod ugo+x rust-init.sh
+ ./rust-init.sh -y
  python -m venv venv
  . venv/bin/activate
  git clone --depth 1 https://github.com/plotly/dash.git dash-main
+ export PATH=$PATH:/home/circleci/.local/bin/:/home/circleci/.cargo/bin
+ export RUSTC_BOOTSTRAP=1
  cd dash-main && pip install -e .[dev,testing] --progress-bar off && cd ..
  cd dash-main/\@plotly/dash-generator-test-component-nested && npm ci && npm run build && sudo R CMD INSTALL . && cd ../../..
  cd dash-main/\@plotly/dash-generator-test-component-standard && npm ci && npm run build && sudo R CMD INSTALL . && cd ../../..
- export PATH=$PATH:/home/circleci/.local/bin/
  pytest --nopercyfinalize --junitxml=test-reports/dashr.xml tests/integration/
  - store_artifacts:
  path: test-reports

CHANGELOG.md

@@ -2,9 +2,12 @@
 All notable changes to `dash` will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
-## [1.0.0] - 2021-03-04
+## [1.0.0] - UNRELEASED
+### Added
+- Dash wrapper functions are included, which simplify the layout syntax for writing Dash apps. This includes the ability to pipe in the `app` object to layout and meta functions, as well as tags which simplify `html` component arguments and children. [#265](https://github.com/plotly/dashR/pull/265)
+
 ### Changed
-- Unify the core Dash packages (dash, dashCoreComponents, dashHtmlComponents, dashTable) for streamlined maintenance and accessibility. The namespaces of these packages will be combined under the `dash` namespace, and all artifacts from the ancillary dash packages will be included with Dash for R. [#243](https://github.com/plotly/dashr/pull/243)
+- Unified the core Dash packages (dash, dashCoreComponents, dashHtmlComponents, dashTable) for streamlined maintenance and accessibility. The namespaces of these packages will be combined under the `dash` namespace, and all artifacts from the ancillary dash packages will be included with Dash for R. [#243](https://github.com/plotly/dashr/pull/243)
 
 ### Fixed
 - Minor fix for favicon issue continued from [#240](https://github.com/plotly/dashr/pull/240) (for more details, see [#243](https://github.com/plotly/dashR/pull/243#issuecomment-842813526)).

DESCRIPTION

@@ -19,7 +19,8 @@ Imports:
  mime,
  crayon,
  brotli,
- glue
+ glue,
+ magrittr
 Suggests:
  testthat
 License: MIT + file LICENSE

NAMESPACE

@@ -1,15 +1,34 @@
 # Generated by roxygen2: do not edit by hand
 
 S3method(print,dash_component)
+export("%>%")
 export(ALL)
 export(ALLSMALLER)
 export(Dash)
 export(MATCH)
+export(add_meta)
+export(add_script)
+export(add_stylesheet)
+export(br)
+export(button)
 export(clientsideFunction)
 export(dashNoUpdate)
+export(dash_app)
+export(dash_tag)
+export(div)
+export(h1)
+export(h2)
+export(h3)
+export(h4)
+export(html)
 export(input)
 export(output)
+export(p)
+export(run_app)
+export(set_layout)
+export(span)
 export(state)
+export(strong)
 importFrom(R6,R6Class)
 importFrom(assertthat,assert_that)
 importFrom(base64enc,base64encode)
@@ -25,6 +44,7 @@ importFrom(htmltools,htmlDependencies)
 importFrom(htmltools,htmlDependency)
 importFrom(htmltools,renderDependencies)
 importFrom(jsonlite,toJSON)
+importFrom(magrittr,"%>%")
 importFrom(reqres,default_parsers)
 importFrom(routr,Route)
 importFrom(routr,RouteStack)

R/all_tags.R

@@ -0,0 +1,135 @@
+## Generated by `scripts/generate_tags.R`; do not edit by hand
+all_tags <- c(
+ "a",
+ "abbr",
+ "acronym",
+ "address",
+ "area",
+ "article",
+ "aside",
+ "audio",
+ "b",
+ "base",
+ "basefont",
+ "bdi",
+ "bdo",
+ "big",
+ "blink",
+ "blockquote",
+ "br",
+ "button",
+ "canvas",
+ "caption",
+ "center",
+ "cite",
+ "code",
+ "col",
+ "colgroup",
+ "command",
+ "content",
+ "data",
+ "datalist",
+ "dd",
+ "del",
+ "details",
+ "dfn",
+ "dialog",
+ "div",
+ "dl",
+ "dt",
+ "element",
+ "em",
+ "embed",
+ "fieldset",
+ "figcaption",
+ "figure",
+ "font",
+ "footer",
+ "form",
+ "frame",
+ "frameset",
+ "h1",
+ "h2",
+ "h3",
+ "h4",
+ "h5",
+ "h6",
+ "header",
+ "hgroup",
+ "hr",
+ "i",
+ "iframe",
+ "img",
+ "ins",
+ "isindex",
+ "kbd",
+ "keygen",
+ "label",
+ "legend",
+ "li",
+ "link",
+ "listing",
+ "main",
+ "map",
+ "mark",
+ "marquee",
+ "meta",
+ "meter",
+ "multicol",
+ "nav",
+ "nextid",
+ "nobr",
+ "noscript",
+ "object",
+ "ol",
+ "optgroup",
+ "option",
+ "output",
+ "p",
+ "param",
+ "picture",
+ "plaintext",
+ "pre",
+ "progress",
+ "q",
+ "rb",
+ "rp",
+ "rt",
+ "rtc",
+ "ruby",
+ "s",
+ "samp",
+ "script",
+ "section",
+ "select",
+ "shadow",
+ "slot",
+ "small",
+ "source",
+ "spacer",
+ "span",
+ "strike",
+ "strong",
+ "sub",
+ "summary",
+ "sup",
+ "table",
+ "tbody",
+ "td",
+ "template",
+ "textarea",
+ "tfoot",
+ "th",
+ "thead",
+ "time",
+ "title",
+ "tr",
+ "track",
+ "u",
+ "ul",
+ "var",
+ "video",
+ "wbr",
+ "xmp"
+)
+names(all_tags) <- all_tags

R/tags.R

@@ -0,0 +1,123 @@
+#' Create HTML tags
+#'
+#' Create an HTML tag to place in a Dash app layout. All tags are available
+#' in the `html` list, and some common tags have shortcuts as functions for
+#' convenience (e.g. `h1()` produces `<h1>` and is equivalent to `html$h1()`).
+#'
+#' @name tags
+#' @param ... Any named arguments become tag attributes, and any unnamed
+#' arguments become children. A named argument with a value of `NULL` will
+#' be removed, and a named argument with a value of `NA` will be rendered
+#' as a boolean argument. See 'Special attributes' below for more information.
+#' @param n_clicks (Numeric) An integer that represents the number of times
+#' that this element has been clicked on. For advanced users only.
+#' @param tag_name The name of the HTML tag.
+#' @param content List of attributes and children.
+#'
+#' @section Special attributes:
+#' There are a few HTML attributes that are treated in a special way:
+#' - To add a `class` attribute, use the `className` parameter
+#' - To add a `for` attribute, use the `htmlFor` parameter
+#' - The `style` attribute is not provided as a string. Instead, it's provided
+#' as a named list, where the name and value of each element correspond to the
+#' CSS property and value. Each CSS property should be written in camelCase.
+#'
+#' @examples
+#' app <- dash_app()
+#' app %>% set_layout(
+#' html$div(
+#' h1(
+#' "title",
+#' style = list(
+#' "color" = "red",
+#' "backgroundColor" = "blue"
+#' )
+#' ),
+#' "some text",
+#' button(
+#' "can't click me",
+#' disabled = NA,
+#' className = "mybtn"
+#' )
+#' )
+#' )
+#' app %>% run_app()
+#'
+NULL
+
+#' @rdname tags
+#' @format NULL
+#' @export
+html <- lapply(all_tags, function(tag_name) {
+ rlang::new_function(
+ args = alist(... = , n_clicks = NULL),
+ body = rlang::expr({
+ dash_tag(!!tag_name, list(...), n_clicks = n_clicks)
+ }),
+ env = asNamespace("dash")
+ )
+})
+
+#' @rdname tags
+#' @export
+h1 <- html$h1
+
+#' @rdname tags
+#' @export
+h2 <- html$h2
+
+#' @rdname tags
+#' @export
+h3 <- html$h3
+
+#' @rdname tags
+#' @export
+h4 <- html$h4
+
+#' @rdname tags
+#' @export
+div <- html$div
+
+#' @rdname tags
+#' @export
+span <- html$span
+
+#' @rdname tags
+#' @export
+p <- html$p
+
+#' @rdname tags
+#' @export
+strong <- html$strong
+
+#' @rdname tags
+#' @export
+br <- html$br
+
+#' @rdname tags
+#' @export
+button <- html$button
+
+#' @rdname tags
+#' @export
+dash_tag <- function(tag_name, content = list(), n_clicks = NULL) {
+ content_names <- rlang::names2(content)
+ content_named_idx <- nzchar(content_names)
+ attributes <- remove_empty(content[content_named_idx])
+ children <- unname(content[!content_named_idx])
+
+ # Support boolean attributes
+ attributes[is.na(attributes)] <- names(attributes[is.na(attributes)])
+ attributes[attributes == ""] <- names(attributes[attributes == ""])
+
+ tag_params <- attributes
+ tag_params[["children"]] <- children
+ tag_params[["n_clicks"]] <- n_clicks
+
+ dash_html_fx <- paste0("html", toupper(substring(tag_name, 1, 1)), substring(tag_name, 2))
+ if (tag_name %in% c("map", "object")) {
+ dash_html_fx <- paste0(dash_html_fx, "El")
+ }
+
+ do.call(getExportedValue("dash", dash_html_fx), tag_params)
+}

R/utils-pipe.R

@@ -0,0 +1,14 @@
+#' Pipe operator
+#'
+#' See \code{magrittr::\link[magrittr:pipe]{\%>\%}} for details.
+#'
+#' @name %>%
+#' @rdname pipe
+#' @keywords internal
+#' @export
+#' @importFrom magrittr %>%
+#' @usage lhs \%>\% rhs
+#' @param lhs A value or the magrittr placeholder.
+#' @param rhs A function call using the magrittr semantics.
+#' @return The result of calling `rhs(lhs)`.
+NULL

.circleci/config.yml

@@ -1,15 +1,13 @@
 version: 2
 
 jobs:
-
-
  "test": &test-template
  working_directory: ~/dashr
  docker:
  - image: plotly/dashr:ci
  auth:
  username: dashautomation
- password: $DASH_PAT_DOCKERHUB
+ password: $DASH_PAT_DOCKERHUB
  environment:
  PERCY_PARALLEL_TOTAL: '-1'
  PUPPETEER_SKIP_CHROMIUM_DOWNLOAD: 'True'
@@ -33,18 +31,22 @@ jobs:
  - run:
  name: 🚧 install R dependencies
  command: |
- sudo Rscript -e 'commit_hash <- readChar("commit.txt", file.info("commit.txt")$size); message("Preparing to install plotly/dashR ", commit_hash, " ..."); install.packages("remotes"); remotes::install_github("plotly/dashR", upgrade=TRUE, ref=commit_hash, force=TRUE)'
+ sudo Rscript -e 'commit_hash <- readChar("commit.txt", file.info("commit.txt")$size); message("Preparing to install plotly/dashR ", commit_hash, " ..."); install.packages("remotes"); remotes::install_github("plotly/dashR", upgrade=TRUE, ref=commit_hash, dependencies=TRUE, force=TRUE)'
 
  - run:
  name: ⚙️ Integration tests
  command: |
+ curl --proto '=https' --tlsv1.2 -sSf -o rust-init.sh https://sh.rustup.rs
+ chmod ugo+x rust-init.sh
+ ./rust-init.sh -y
  python -m venv venv
  . venv/bin/activate
  git clone --depth 1 https://github.com/plotly/dash.git dash-main
+ export PATH=$PATH:/home/circleci/.local/bin/:/home/circleci/.cargo/bin
+ export RUSTC_BOOTSTRAP=1
  cd dash-main && pip install -e .[dev,testing] --progress-bar off && cd ..
  cd dash-main/\@plotly/dash-generator-test-component-nested && npm ci && npm run build && sudo R CMD INSTALL . && cd ../../..
  cd dash-main/\@plotly/dash-generator-test-component-standard && npm ci && npm run build && sudo R CMD INSTALL . && cd ../../..
- export PATH=$PATH:/home/circleci/.local/bin/
  pytest --nopercyfinalize --junitxml=test-reports/dashr.xml tests/integration/
  - store_artifacts:
  path: test-reports

CHANGELOG.md

@@ -2,9 +2,12 @@
 All notable changes to `dash` will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
-## [1.0.0] - 2021-03-04
+## [1.0.0] - UNRELEASED
+### Added
+- Dash wrapper functions are included, which simplify the layout syntax for writing Dash apps. This includes the ability to pipe in the `app` object to layout and meta functions, as well as tags which simplify `html` component arguments and children. [#265](https://github.com/plotly/dashR/pull/265)
+
 ### Changed
-- Unify the core Dash packages (dash, dashCoreComponents, dashHtmlComponents, dashTable) for streamlined maintenance and accessibility. The namespaces of these packages will be combined under the `dash` namespace, and all artifacts from the ancillary dash packages will be included with Dash for R. [#243](https://github.com/plotly/dashr/pull/243)
+- Unified the core Dash packages (dash, dashCoreComponents, dashHtmlComponents, dashTable) for streamlined maintenance and accessibility. The namespaces of these packages will be combined under the `dash` namespace, and all artifacts from the ancillary dash packages will be included with Dash for R. [#243](https://github.com/plotly/dashr/pull/243)
 
 ### Fixed
 - Minor fix for favicon issue continued from [#240](https://github.com/plotly/dashr/pull/240) (for more details, see [#243](https://github.com/plotly/dashR/pull/243#issuecomment-842813526)).

DESCRIPTION

@@ -19,7 +19,8 @@ Imports:
  mime,
  crayon,
  brotli,
- glue
+ glue,
+ magrittr
 Suggests:
  testthat
 License: MIT + file LICENSE

NAMESPACE

@@ -1,15 +1,34 @@
 # Generated by roxygen2: do not edit by hand
 
 S3method(print,dash_component)
+export("%>%")
 export(ALL)
 export(ALLSMALLER)
 export(Dash)
 export(MATCH)
+export(add_meta)
+export(add_script)
+export(add_stylesheet)
+export(br)
+export(button)
 export(clientsideFunction)
 export(dashNoUpdate)
+export(dash_app)
+export(dash_tag)
+export(div)
+export(h1)
+export(h2)
+export(h3)
+export(h4)
+export(html)
 export(input)
 export(output)
+export(p)
+export(run_app)
+export(set_layout)
+export(span)
 export(state)
+export(strong)
 importFrom(R6,R6Class)
 importFrom(assertthat,assert_that)
 importFrom(base64enc,base64encode)
@@ -25,6 +44,7 @@ importFrom(htmltools,htmlDependencies)
 importFrom(htmltools,htmlDependency)
 importFrom(htmltools,renderDependencies)
 importFrom(jsonlite,toJSON)
+importFrom(magrittr,"%>%")
 importFrom(reqres,default_parsers)
 importFrom(routr,Route)
 importFrom(routr,RouteStack)

R/all_tags.R

@@ -0,0 +1,135 @@
+## Generated by `scripts/generate_tags.R`; do not edit by hand
+all_tags <- c(
+ "a",
+ "abbr",
+ "acronym",
+ "address",
+ "area",
+ "article",
+ "aside",
+ "audio",
+ "b",
+ "base",
+ "basefont",
+ "bdi",
+ "bdo",
+ "big",
+ "blink",
+ "blockquote",
+ "br",
+ "button",
+ "canvas",
+ "caption",
+ "center",
+ "cite",
+ "code",
+ "col",
+ "colgroup",
+ "command",
+ "content",
+ "data",
+ "datalist",
+ "dd",
+ "del",
+ "details",
+ "dfn",
+ "dialog",
+ "div",
+ "dl",
+ "dt",
+ "element",
+ "em",
+ "embed",
+ "fieldset",
+ "figcaption",
+ "figure",
+ "font",
+ "footer",
+ "form",
+ "frame",
+ "frameset",
+ "h1",
+ "h2",
+ "h3",
+ "h4",
+ "h5",
+ "h6",
+ "header",
+ "hgroup",
+ "hr",
+ "i",
+ "iframe",
+ "img",
+ "ins",
+ "isindex",
+ "kbd",
+ "keygen",
+ "label",
+ "legend",
+ "li",
+ "link",
+ "listing",
+ "main",
+ "map",
+ "mark",
+ "marquee",
+ "meta",
+ "meter",
+ "multicol",
+ "nav",
+ "nextid",
+ "nobr",
+ "noscript",
+ "object",
+ "ol",
+ "optgroup",
+ "option",
+ "output",
+ "p",
+ "param",
+ "picture",
+ "plaintext",
+ "pre",
+ "progress",
+ "q",
+ "rb",
+ "rp",
+ "rt",
+ "rtc",
+ "ruby",
+ "s",
+ "samp",
+ "script",
+ "section",
+ "select",
+ "shadow",
+ "slot",
+ "small",
+ "source",
+ "spacer",
+ "span",
+ "strike",
+ "strong",
+ "sub",
+ "summary",
+ "sup",
+ "table",
+ "tbody",
+ "td",
+ "template",
+ "textarea",
+ "tfoot",
+ "th",
+ "thead",
+ "time",
+ "title",
+ "tr",
+ "track",
+ "u",
+ "ul",
+ "var",
+ "video",
+ "wbr",
+ "xmp"
+)
+names(all_tags) <- all_tags

R/tags.R

@@ -0,0 +1,123 @@
+#' Create HTML tags
+#'
+#' Create an HTML tag to place in a Dash app layout. All tags are available
+#' in the `html` list, and some common tags have shortcuts as functions for
+#' convenience (e.g. `h1()` produces `<h1>` and is equivalent to `html$h1()`).
+#'
+#' @name tags
+#' @param ... Any named arguments become tag attributes, and any unnamed
+#' arguments become children. A named argument with a value of `NULL` will
+#' be removed, and a named argument with a value of `NA` will be rendered
+#' as a boolean argument. See 'Special attributes' below for more information.
+#' @param n_clicks (Numeric) An integer that represents the number of times
+#' that this element has been clicked on. For advanced users only.
+#' @param tag_name The name of the HTML tag.
+#' @param content List of attributes and children.
+#'
+#' @section Special attributes:
+#' There are a few HTML attributes that are treated in a special way:
+#' - To add a `class` attribute, use the `className` parameter
+#' - To add a `for` attribute, use the `htmlFor` parameter
+#' - The `style` attribute is not provided as a string. Instead, it's provided
+#' as a named list, where the name and value of each element correspond to the
+#' CSS property and value. Each CSS property should be written in camelCase.
+#'
+#' @examples
+#' app <- dash_app()
+#' app %>% set_layout(
+#' html$div(
+#' h1(
+#' "title",
+#' style = list(
+#' "color" = "red",
+#' "backgroundColor" = "blue"
+#' )
+#' ),
+#' "some text",
+#' button(
+#' "can't click me",
+#' disabled = NA,
+#' className = "mybtn"
+#' )
+#' )
+#' )
+#' app %>% run_app()
+#'
+NULL
+
+#' @rdname tags
+#' @format NULL
+#' @export
+html <- lapply(all_tags, function(tag_name) {
+ rlang::new_function(
+ args = alist(... = , n_clicks = NULL),
+ body = rlang::expr({
+ dash_tag(!!tag_name, list(...), n_clicks = n_clicks)
+ }),
+ env = asNamespace("dash")
+ )
+})
+
+#' @rdname tags
+#' @export
+h1 <- html$h1
+
+#' @rdname tags
+#' @export
+h2 <- html$h2
+
+#' @rdname tags
+#' @export
+h3 <- html$h3
+
+#' @rdname tags
+#' @export
+h4 <- html$h4
+
+#' @rdname tags
+#' @export
+div <- html$div
+
+#' @rdname tags
+#' @export
+span <- html$span
+
+#' @rdname tags
+#' @export
+p <- html$p
+
+#' @rdname tags
+#' @export
+strong <- html$strong
+
+#' @rdname tags
+#' @export
+br <- html$br
+
+#' @rdname tags
+#' @export
+button <- html$button
+
+#' @rdname tags
+#' @export
+dash_tag <- function(tag_name, content = list(), n_clicks = NULL) {
+ content_names <- rlang::names2(content)
+ content_named_idx <- nzchar(content_names)
+ attributes <- remove_empty(content[content_named_idx])
+ children <- unname(content[!content_named_idx])
+
+ # Support boolean attributes
+ attributes[is.na(attributes)] <- names(attributes[is.na(attributes)])
+ attributes[attributes == ""] <- names(attributes[attributes == ""])
+
+ tag_params <- attributes
+ tag_params[["children"]] <- children
+ tag_params[["n_clicks"]] <- n_clicks
+
+ dash_html_fx <- paste0("html", toupper(substring(tag_name, 1, 1)), substring(tag_name, 2))
+ if (tag_name %in% c("map", "object")) {
+ dash_html_fx <- paste0(dash_html_fx, "El")
+ }
+
+ do.call(getExportedValue("dash", dash_html_fx), tag_params)
+}

R/utils-pipe.R

@@ -0,0 +1,14 @@
+#' Pipe operator
+#'
+#' See \code{magrittr::\link[magrittr:pipe]{\%>\%}} for details.
+#'
+#' @name %>%
+#' @rdname pipe
+#' @keywords internal
+#' @export
+#' @importFrom magrittr %>%
+#' @usage lhs \%>\% rhs
+#' @param lhs A value or the magrittr placeholder.
+#' @param rhs A function call using the magrittr semantics.
+#' @return The result of calling `rhs(lhs)`.
+NULL

.circleci/config.yml

@@ -1,15 +1,13 @@
 version: 2
 
 jobs:
-
-
  "test": &test-template
  working_directory: ~/dashr
  docker:
  - image: plotly/dashr:ci
  auth:
  username: dashautomation
- password: $DASH_PAT_DOCKERHUB
+ password: $DASH_PAT_DOCKERHUB
  environment:
  PERCY_PARALLEL_TOTAL: '-1'
  PUPPETEER_SKIP_CHROMIUM_DOWNLOAD: 'True'
@@ -33,18 +31,22 @@ jobs:
  - run:
  name: 🚧 install R dependencies
  command: |
- sudo Rscript -e 'commit_hash <- readChar("commit.txt", file.info("commit.txt")$size); message("Preparing to install plotly/dashR ", commit_hash, " ..."); install.packages("remotes"); remotes::install_github("plotly/dashR", upgrade=TRUE, ref=commit_hash, force=TRUE)'
+ sudo Rscript -e 'commit_hash <- readChar("commit.txt", file.info("commit.txt")$size); message("Preparing to install plotly/dashR ", commit_hash, " ..."); install.packages("remotes"); remotes::install_github("plotly/dashR", upgrade=TRUE, ref=commit_hash, dependencies=TRUE, force=TRUE)'
 
  - run:
  name: ⚙️ Integration tests
  command: |
+ curl --proto '=https' --tlsv1.2 -sSf -o rust-init.sh https://sh.rustup.rs
+ chmod ugo+x rust-init.sh
+ ./rust-init.sh -y
  python -m venv venv
  . venv/bin/activate
  git clone --depth 1 https://github.com/plotly/dash.git dash-main
+ export PATH=$PATH:/home/circleci/.local/bin/:/home/circleci/.cargo/bin
+ export RUSTC_BOOTSTRAP=1
  cd dash-main && pip install -e .[dev,testing] --progress-bar off && cd ..
  cd dash-main/\@plotly/dash-generator-test-component-nested && npm ci && npm run build && sudo R CMD INSTALL . && cd ../../..
  cd dash-main/\@plotly/dash-generator-test-component-standard && npm ci && npm run build && sudo R CMD INSTALL . && cd ../../..
- export PATH=$PATH:/home/circleci/.local/bin/
  pytest --nopercyfinalize --junitxml=test-reports/dashr.xml tests/integration/
  - store_artifacts:
  path: test-reports

CHANGELOG.md

@@ -2,9 +2,12 @@
 All notable changes to `dash` will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
-## [1.0.0] - 2021-03-04
+## [1.0.0] - UNRELEASED
+### Added
+- Dash wrapper functions are included, which simplify the layout syntax for writing Dash apps. This includes the ability to pipe in the `app` object to layout and meta functions, as well as tags which simplify `html` component arguments and children. [#265](https://github.com/plotly/dashR/pull/265)
+
 ### Changed
-- Unify the core Dash packages (dash, dashCoreComponents, dashHtmlComponents, dashTable) for streamlined maintenance and accessibility. The namespaces of these packages will be combined under the `dash` namespace, and all artifacts from the ancillary dash packages will be included with Dash for R. [#243](https://github.com/plotly/dashr/pull/243)
+- Unified the core Dash packages (dash, dashCoreComponents, dashHtmlComponents, dashTable) for streamlined maintenance and accessibility. The namespaces of these packages will be combined under the `dash` namespace, and all artifacts from the ancillary dash packages will be included with Dash for R. [#243](https://github.com/plotly/dashr/pull/243)
 
 ### Fixed
 - Minor fix for favicon issue continued from [#240](https://github.com/plotly/dashr/pull/240) (for more details, see [#243](https://github.com/plotly/dashR/pull/243#issuecomment-842813526)).

DESCRIPTION

@@ -19,7 +19,8 @@ Imports:
  mime,
  crayon,
  brotli,
- glue
+ glue,
+ magrittr
 Suggests:
  testthat
 License: MIT + file LICENSE

NAMESPACE

@@ -1,15 +1,34 @@
 # Generated by roxygen2: do not edit by hand
 
 S3method(print,dash_component)
+export("%>%")
 export(ALL)
 export(ALLSMALLER)
 export(Dash)
 export(MATCH)
+export(add_meta)
+export(add_script)
+export(add_stylesheet)
+export(br)
+export(button)
 export(clientsideFunction)
 export(dashNoUpdate)
+export(dash_app)
+export(dash_tag)
+export(div)
+export(h1)
+export(h2)
+export(h3)
+export(h4)
+export(html)
 export(input)
 export(output)
+export(p)
+export(run_app)
+export(set_layout)
+export(span)
 export(state)
+export(strong)
 importFrom(R6,R6Class)
 importFrom(assertthat,assert_that)
 importFrom(base64enc,base64encode)
@@ -25,6 +44,7 @@ importFrom(htmltools,htmlDependencies)
 importFrom(htmltools,htmlDependency)
 importFrom(htmltools,renderDependencies)
 importFrom(jsonlite,toJSON)
+importFrom(magrittr,"%>%")
 importFrom(reqres,default_parsers)
 importFrom(routr,Route)
 importFrom(routr,RouteStack)

R/all_tags.R

@@ -0,0 +1,135 @@
+## Generated by `scripts/generate_tags.R`; do not edit by hand
+all_tags <- c(
+ "a",
+ "abbr",
+ "acronym",
+ "address",
+ "area",
+ "article",
+ "aside",
+ "audio",
+ "b",
+ "base",
+ "basefont",
+ "bdi",
+ "bdo",
+ "big",
+ "blink",
+ "blockquote",
+ "br",
+ "button",
+ "canvas",
+ "caption",
+ "center",
+ "cite",
+ "code",
+ "col",
+ "colgroup",
+ "command",
+ "content",
+ "data",
+ "datalist",
+ "dd",
+ "del",
+ "details",
+ "dfn",
+ "dialog",
+ "div",
+ "dl",
+ "dt",
+ "element",
+ "em",
+ "embed",
+ "fieldset",
+ "figcaption",
+ "figure",
+ "font",
+ "footer",
+ "form",
+ "frame",
+ "frameset",
+ "h1",
+ "h2",
+ "h3",
+ "h4",
+ "h5",
+ "h6",
+ "header",
+ "hgroup",
+ "hr",
+ "i",
+ "iframe",
+ "img",
+ "ins",
+ "isindex",
+ "kbd",
+ "keygen",
+ "label",
+ "legend",
+ "li",
+ "link",
+ "listing",
+ "main",
+ "map",
+ "mark",
+ "marquee",
+ "meta",
+ "meter",
+ "multicol",
+ "nav",
+ "nextid",
+ "nobr",
+ "noscript",
+ "object",
+ "ol",
+ "optgroup",
+ "option",
+ "output",
+ "p",
+ "param",
+ "picture",
+ "plaintext",
+ "pre",
+ "progress",
+ "q",
+ "rb",
+ "rp",
+ "rt",
+ "rtc",
+ "ruby",
+ "s",
+ "samp",
+ "script",
+ "section",
+ "select",
+ "shadow",
+ "slot",
+ "small",
+ "source",
+ "spacer",
+ "span",
+ "strike",
+ "strong",
+ "sub",
+ "summary",
+ "sup",
+ "table",
+ "tbody",
+ "td",
+ "template",
+ "textarea",
+ "tfoot",
+ "th",
+ "thead",
+ "time",
+ "title",
+ "tr",
+ "track",
+ "u",
+ "ul",
+ "var",
+ "video",
+ "wbr",
+ "xmp"
+)
+names(all_tags) <- all_tags

R/tags.R

@@ -0,0 +1,123 @@
+#' Create HTML tags
+#'
+#' Create an HTML tag to place in a Dash app layout. All tags are available
+#' in the `html` list, and some common tags have shortcuts as functions for
+#' convenience (e.g. `h1()` produces `<h1>` and is equivalent to `html$h1()`).
+#'
+#' @name tags
+#' @param ... Any named arguments become tag attributes, and any unnamed
+#' arguments become children. A named argument with a value of `NULL` will
+#' be removed, and a named argument with a value of `NA` will be rendered
+#' as a boolean argument. See 'Special attributes' below for more information.
+#' @param n_clicks (Numeric) An integer that represents the number of times
+#' that this element has been clicked on. For advanced users only.
+#' @param tag_name The name of the HTML tag.
+#' @param content List of attributes and children.
+#'
+#' @section Special attributes:
+#' There are a few HTML attributes that are treated in a special way:
+#' - To add a `class` attribute, use the `className` parameter
+#' - To add a `for` attribute, use the `htmlFor` parameter
+#' - The `style` attribute is not provided as a string. Instead, it's provided
+#' as a named list, where the name and value of each element correspond to the
+#' CSS property and value. Each CSS property should be written in camelCase.
+#'
+#' @examples
+#' app <- dash_app()
+#' app %>% set_layout(
+#' html$div(
+#' h1(
+#' "title",
+#' style = list(
+#' "color" = "red",
+#' "backgroundColor" = "blue"
+#' )
+#' ),
+#' "some text",
+#' button(
+#' "can't click me",
+#' disabled = NA,
+#' className = "mybtn"
+#' )
+#' )
+#' )
+#' app %>% run_app()
+#'
+NULL
+
+#' @rdname tags
+#' @format NULL
+#' @export
+html <- lapply(all_tags, function(tag_name) {
+ rlang::new_function(
+ args = alist(... = , n_clicks = NULL),
+ body = rlang::expr({
+ dash_tag(!!tag_name, list(...), n_clicks = n_clicks)
+ }),
+ env = asNamespace("dash")
+ )
+})
+
+#' @rdname tags
+#' @export
+h1 <- html$h1
+
+#' @rdname tags
+#' @export
+h2 <- html$h2
+
+#' @rdname tags
+#' @export
+h3 <- html$h3
+
+#' @rdname tags
+#' @export
+h4 <- html$h4
+
+#' @rdname tags
+#' @export
+div <- html$div
+
+#' @rdname tags
+#' @export
+span <- html$span
+
+#' @rdname tags
+#' @export
+p <- html$p
+
+#' @rdname tags
+#' @export
+strong <- html$strong
+
+#' @rdname tags
+#' @export
+br <- html$br
+
+#' @rdname tags
+#' @export
+button <- html$button
+
+#' @rdname tags
+#' @export
+dash_tag <- function(tag_name, content = list(), n_clicks = NULL) {
+ content_names <- rlang::names2(content)
+ content_named_idx <- nzchar(content_names)
+ attributes <- remove_empty(content[content_named_idx])
+ children <- unname(content[!content_named_idx])
+
+ # Support boolean attributes
+ attributes[is.na(attributes)] <- names(attributes[is.na(attributes)])
+ attributes[attributes == ""] <- names(attributes[attributes == ""])
+
+ tag_params <- attributes
+ tag_params[["children"]] <- children
+ tag_params[["n_clicks"]] <- n_clicks
+
+ dash_html_fx <- paste0("html", toupper(substring(tag_name, 1, 1)), substring(tag_name, 2))
+ if (tag_name %in% c("map", "object")) {
+ dash_html_fx <- paste0(dash_html_fx, "El")
+ }
+
+ do.call(getExportedValue("dash", dash_html_fx), tag_params)
+}

R/utils-pipe.R

@@ -0,0 +1,14 @@
+#' Pipe operator
+#'
+#' See \code{magrittr::\link[magrittr:pipe]{\%>\%}} for details.
+#'
+#' @name %>%
+#' @rdname pipe
+#' @keywords internal
+#' @export
+#' @importFrom magrittr %>%
+#' @usage lhs \%>\% rhs
+#' @param lhs A value or the magrittr placeholder.
+#' @param rhs A function call using the magrittr semantics.
+#' @return The result of calling `rhs(lhs)`.
+NULL

.circleci/config.yml

@@ -1,15 +1,13 @@
 version: 2
 
 jobs:
-
-
  "test": &test-template
  working_directory: ~/dashr
  docker:
  - image: plotly/dashr:ci
  auth:
  username: dashautomation
- password: $DASH_PAT_DOCKERHUB
+ password: $DASH_PAT_DOCKERHUB
  environment:
  PERCY_PARALLEL_TOTAL: '-1'
  PUPPETEER_SKIP_CHROMIUM_DOWNLOAD: 'True'
@@ -33,18 +31,22 @@ jobs:
  - run:
  name: 🚧 install R dependencies
  command: |
- sudo Rscript -e 'commit_hash <- readChar("commit.txt", file.info("commit.txt")$size); message("Preparing to install plotly/dashR ", commit_hash, " ..."); install.packages("remotes"); remotes::install_github("plotly/dashR", upgrade=TRUE, ref=commit_hash, force=TRUE)'
+ sudo Rscript -e 'commit_hash <- readChar("commit.txt", file.info("commit.txt")$size); message("Preparing to install plotly/dashR ", commit_hash, " ..."); install.packages("remotes"); remotes::install_github("plotly/dashR", upgrade=TRUE, ref=commit_hash, dependencies=TRUE, force=TRUE)'
 
  - run:
  name: ⚙️ Integration tests
  command: |
+ curl --proto '=https' --tlsv1.2 -sSf -o rust-init.sh https://sh.rustup.rs
+ chmod ugo+x rust-init.sh
+ ./rust-init.sh -y
  python -m venv venv
  . venv/bin/activate
  git clone --depth 1 https://github.com/plotly/dash.git dash-main
+ export PATH=$PATH:/home/circleci/.local/bin/:/home/circleci/.cargo/bin
+ export RUSTC_BOOTSTRAP=1
  cd dash-main && pip install -e .[dev,testing] --progress-bar off && cd ..
  cd dash-main/\@plotly/dash-generator-test-component-nested && npm ci && npm run build && sudo R CMD INSTALL . && cd ../../..
  cd dash-main/\@plotly/dash-generator-test-component-standard && npm ci && npm run build && sudo R CMD INSTALL . && cd ../../..
- export PATH=$PATH:/home/circleci/.local/bin/
  pytest --nopercyfinalize --junitxml=test-reports/dashr.xml tests/integration/
  - store_artifacts:
  path: test-reports

CHANGELOG.md

@@ -2,9 +2,12 @@
 All notable changes to `dash` will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
-## [1.0.0] - 2021-03-04
+## [1.0.0] - UNRELEASED
+### Added
+- Dash wrapper functions are included, which simplify the layout syntax for writing Dash apps. This includes the ability to pipe in the `app` object to layout and meta functions, as well as tags which simplify `html` component arguments and children. [#265](https://github.com/plotly/dashR/pull/265)
+
 ### Changed
-- Unify the core Dash packages (dash, dashCoreComponents, dashHtmlComponents, dashTable) for streamlined maintenance and accessibility. The namespaces of these packages will be combined under the `dash` namespace, and all artifacts from the ancillary dash packages will be included with Dash for R. [#243](https://github.com/plotly/dashr/pull/243)
+- Unified the core Dash packages (dash, dashCoreComponents, dashHtmlComponents, dashTable) for streamlined maintenance and accessibility. The namespaces of these packages will be combined under the `dash` namespace, and all artifacts from the ancillary dash packages will be included with Dash for R. [#243](https://github.com/plotly/dashr/pull/243)
 
 ### Fixed
 - Minor fix for favicon issue continued from [#240](https://github.com/plotly/dashr/pull/240) (for more details, see [#243](https://github.com/plotly/dashR/pull/243#issuecomment-842813526)).

DESCRIPTION

@@ -19,7 +19,8 @@ Imports:
  mime,
  crayon,
  brotli,
- glue
+ glue,
+ magrittr
 Suggests:
  testthat
 License: MIT + file LICENSE

NAMESPACE

@@ -1,15 +1,34 @@
 # Generated by roxygen2: do not edit by hand
 
 S3method(print,dash_component)
+export("%>%")
 export(ALL)
 export(ALLSMALLER)
 export(Dash)
 export(MATCH)
+export(add_meta)
+export(add_script)
+export(add_stylesheet)
+export(br)
+export(button)
 export(clientsideFunction)
 export(dashNoUpdate)
+export(dash_app)
+export(dash_tag)
+export(div)
+export(h1)
+export(h2)
+export(h3)
+export(h4)
+export(html)
 export(input)
 export(output)
+export(p)
+export(run_app)
+export(set_layout)
+export(span)
 export(state)
+export(strong)
 importFrom(R6,R6Class)
 importFrom(assertthat,assert_that)
 importFrom(base64enc,base64encode)
@@ -25,6 +44,7 @@ importFrom(htmltools,htmlDependencies)
 importFrom(htmltools,htmlDependency)
 importFrom(htmltools,renderDependencies)
 importFrom(jsonlite,toJSON)
+importFrom(magrittr,"%>%")
 importFrom(reqres,default_parsers)
 importFrom(routr,Route)
 importFrom(routr,RouteStack)

R/all_tags.R

@@ -0,0 +1,135 @@
+## Generated by `scripts/generate_tags.R`; do not edit by hand
+all_tags <- c(
+ "a",
+ "abbr",
+ "acronym",
+ "address",
+ "area",
+ "article",
+ "aside",
+ "audio",
+ "b",
+ "base",
+ "basefont",
+ "bdi",
+ "bdo",
+ "big",
+ "blink",
+ "blockquote",
+ "br",
+ "button",
+ "canvas",
+ "caption",
+ "center",
+ "cite",
+ "code",
+ "col",
+ "colgroup",
+ "command",
+ "content",
+ "data",
+ "datalist",
+ "dd",
+ "del",
+ "details",
+ "dfn",
+ "dialog",
+ "div",
+ "dl",
+ "dt",
+ "element",
+ "em",
+ "embed",
+ "fieldset",
+ "figcaption",
+ "figure",
+ "font",
+ "footer",
+ "form",
+ "frame",
+ "frameset",
+ "h1",
+ "h2",
+ "h3",
+ "h4",
+ "h5",
+ "h6",
+ "header",
+ "hgroup",
+ "hr",
+ "i",
+ "iframe",
+ "img",
+ "ins",
+ "isindex",
+ "kbd",
+ "keygen",
+ "label",
+ "legend",
+ "li",
+ "link",
+ "listing",
+ "main",
+ "map",
+ "mark",
+ "marquee",
+ "meta",
+ "meter",
+ "multicol",
+ "nav",
+ "nextid",
+ "nobr",
+ "noscript",
+ "object",
+ "ol",
+ "optgroup",
+ "option",
+ "output",
+ "p",
+ "param",
+ "picture",
+ "plaintext",
+ "pre",
+ "progress",
+ "q",
+ "rb",
+ "rp",
+ "rt",
+ "rtc",
+ "ruby",
+ "s",
+ "samp",
+ "script",
+ "section",
+ "select",
+ "shadow",
+ "slot",
+ "small",
+ "source",
+ "spacer",
+ "span",
+ "strike",
+ "strong",
+ "sub",
+ "summary",
+ "sup",
+ "table",
+ "tbody",
+ "td",
+ "template",
+ "textarea",
+ "tfoot",
+ "th",
+ "thead",
+ "time",
+ "title",
+ "tr",
+ "track",
+ "u",
+ "ul",
+ "var",
+ "video",
+ "wbr",
+ "xmp"
+)
+names(all_tags) <- all_tags

R/tags.R

@@ -0,0 +1,123 @@
+#' Create HTML tags
+#'
+#' Create an HTML tag to place in a Dash app layout. All tags are available
+#' in the `html` list, and some common tags have shortcuts as functions for
+#' convenience (e.g. `h1()` produces `<h1>` and is equivalent to `html$h1()`).
+#'
+#' @name tags
+#' @param ... Any named arguments become tag attributes, and any unnamed
+#' arguments become children. A named argument with a value of `NULL` will
+#' be removed, and a named argument with a value of `NA` will be rendered
+#' as a boolean argument. See 'Special attributes' below for more information.
+#' @param n_clicks (Numeric) An integer that represents the number of times
+#' that this element has been clicked on. For advanced users only.
+#' @param tag_name The name of the HTML tag.
+#' @param content List of attributes and children.
+#'
+#' @section Special attributes:
+#' There are a few HTML attributes that are treated in a special way:
+#' - To add a `class` attribute, use the `className` parameter
+#' - To add a `for` attribute, use the `htmlFor` parameter
+#' - The `style` attribute is not provided as a string. Instead, it's provided
+#' as a named list, where the name and value of each element correspond to the
+#' CSS property and value. Each CSS property should be written in camelCase.
+#'
+#' @examples
+#' app <- dash_app()
+#' app %>% set_layout(
+#' html$div(
+#' h1(
+#' "title",
+#' style = list(
+#' "color" = "red",
+#' "backgroundColor" = "blue"
+#' )
+#' ),
+#' "some text",
+#' button(
+#' "can't click me",
+#' disabled = NA,
+#' className = "mybtn"
+#' )
+#' )
+#' )
+#' app %>% run_app()
+#'
+NULL
+
+#' @rdname tags
+#' @format NULL
+#' @export
+html <- lapply(all_tags, function(tag_name) {
+ rlang::new_function(
+ args = alist(... = , n_clicks = NULL),
+ body = rlang::expr({
+ dash_tag(!!tag_name, list(...), n_clicks = n_clicks)
+ }),
+ env = asNamespace("dash")
+ )
+})
+
+#' @rdname tags
+#' @export
+h1 <- html$h1
+
+#' @rdname tags
+#' @export
+h2 <- html$h2
+
+#' @rdname tags
+#' @export
+h3 <- html$h3
+
+#' @rdname tags
+#' @export
+h4 <- html$h4
+
+#' @rdname tags
+#' @export
+div <- html$div
+
+#' @rdname tags
+#' @export
+span <- html$span
+
+#' @rdname tags
+#' @export
+p <- html$p
+
+#' @rdname tags
+#' @export
+strong <- html$strong
+
+#' @rdname tags
+#' @export
+br <- html$br
+
+#' @rdname tags
+#' @export
+button <- html$button
+
+#' @rdname tags
+#' @export
+dash_tag <- function(tag_name, content = list(), n_clicks = NULL) {
+ content_names <- rlang::names2(content)
+ content_named_idx <- nzchar(content_names)
+ attributes <- remove_empty(content[content_named_idx])
+ children <- unname(content[!content_named_idx])
+
+ # Support boolean attributes
+ attributes[is.na(attributes)] <- names(attributes[is.na(attributes)])
+ attributes[attributes == ""] <- names(attributes[attributes == ""])
+
+ tag_params <- attributes
+ tag_params[["children"]] <- children
+ tag_params[["n_clicks"]] <- n_clicks
+
+ dash_html_fx <- paste0("html", toupper(substring(tag_name, 1, 1)), substring(tag_name, 2))
+ if (tag_name %in% c("map", "object")) {
+ dash_html_fx <- paste0(dash_html_fx, "El")
+ }
+
+ do.call(getExportedValue("dash", dash_html_fx), tag_params)
+}

R/utils-pipe.R

@@ -0,0 +1,14 @@
+#' Pipe operator
+#'
+#' See \code{magrittr::\link[magrittr:pipe]{\%>\%}} for details.
+#'
+#' @name %>%
+#' @rdname pipe
+#' @keywords internal
+#' @export
+#' @importFrom magrittr %>%
+#' @usage lhs \%>\% rhs
+#' @param lhs A value or the magrittr placeholder.
+#' @param rhs A function call using the magrittr semantics.
+#' @return The result of calling `rhs(lhs)`.
+NULL

.circleci/config.yml

@@ -1,15 +1,13 @@
 version: 2
 
 jobs:
-
-
  "test": &test-template
  working_directory: ~/dashr
  docker:
  - image: plotly/dashr:ci
  auth:
  username: dashautomation
- password: $DASH_PAT_DOCKERHUB
+ password: $DASH_PAT_DOCKERHUB
  environment:
  PERCY_PARALLEL_TOTAL: '-1'
  PUPPETEER_SKIP_CHROMIUM_DOWNLOAD: 'True'
@@ -33,18 +31,22 @@ jobs:
  - run:
  name: 🚧 install R dependencies
  command: |
- sudo Rscript -e 'commit_hash <- readChar("commit.txt", file.info("commit.txt")$size); message("Preparing to install plotly/dashR ", commit_hash, " ..."); install.packages("remotes"); remotes::install_github("plotly/dashR", upgrade=TRUE, ref=commit_hash, force=TRUE)'
+ sudo Rscript -e 'commit_hash <- readChar("commit.txt", file.info("commit.txt")$size); message("Preparing to install plotly/dashR ", commit_hash, " ..."); install.packages("remotes"); remotes::install_github("plotly/dashR", upgrade=TRUE, ref=commit_hash, dependencies=TRUE, force=TRUE)'
 
  - run:
  name: ⚙️ Integration tests
  command: |
+ curl --proto '=https' --tlsv1.2 -sSf -o rust-init.sh https://sh.rustup.rs
+ chmod ugo+x rust-init.sh
+ ./rust-init.sh -y
  python -m venv venv
  . venv/bin/activate
  git clone --depth 1 https://github.com/plotly/dash.git dash-main
+ export PATH=$PATH:/home/circleci/.local/bin/:/home/circleci/.cargo/bin
+ export RUSTC_BOOTSTRAP=1
  cd dash-main && pip install -e .[dev,testing] --progress-bar off && cd ..
  cd dash-main/\@plotly/dash-generator-test-component-nested && npm ci && npm run build && sudo R CMD INSTALL . && cd ../../..
  cd dash-main/\@plotly/dash-generator-test-component-standard && npm ci && npm run build && sudo R CMD INSTALL . && cd ../../..
- export PATH=$PATH:/home/circleci/.local/bin/
  pytest --nopercyfinalize --junitxml=test-reports/dashr.xml tests/integration/
  - store_artifacts:
  path: test-reports

CHANGELOG.md

@@ -2,9 +2,12 @@
 All notable changes to `dash` will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
-## [1.0.0] - 2021-03-04
+## [1.0.0] - UNRELEASED
+### Added
+- Dash wrapper functions are included, which simplify the layout syntax for writing Dash apps. This includes the ability to pipe in the `app` object to layout and meta functions, as well as tags which simplify `html` component arguments and children. [#265](https://github.com/plotly/dashR/pull/265)
+
 ### Changed
-- Unify the core Dash packages (dash, dashCoreComponents, dashHtmlComponents, dashTable) for streamlined maintenance and accessibility. The namespaces of these packages will be combined under the `dash` namespace, and all artifacts from the ancillary dash packages will be included with Dash for R. [#243](https://github.com/plotly/dashr/pull/243)
+- Unified the core Dash packages (dash, dashCoreComponents, dashHtmlComponents, dashTable) for streamlined maintenance and accessibility. The namespaces of these packages will be combined under the `dash` namespace, and all artifacts from the ancillary dash packages will be included with Dash for R. [#243](https://github.com/plotly/dashr/pull/243)
 
 ### Fixed
 - Minor fix for favicon issue continued from [#240](https://github.com/plotly/dashr/pull/240) (for more details, see [#243](https://github.com/plotly/dashR/pull/243#issuecomment-842813526)).

DESCRIPTION

@@ -19,7 +19,8 @@ Imports:
  mime,
  crayon,
  brotli,
- glue
+ glue,
+ magrittr
 Suggests:
  testthat
 License: MIT + file LICENSE

NAMESPACE

@@ -1,15 +1,34 @@
 # Generated by roxygen2: do not edit by hand
 
 S3method(print,dash_component)
+export("%>%")
 export(ALL)
 export(ALLSMALLER)
 export(Dash)
 export(MATCH)
+export(add_meta)
+export(add_script)
+export(add_stylesheet)
+export(br)
+export(button)
 export(clientsideFunction)
 export(dashNoUpdate)
+export(dash_app)
+export(dash_tag)
+export(div)
+export(h1)
+export(h2)
+export(h3)
+export(h4)
+export(html)
 export(input)
 export(output)
+export(p)
+export(run_app)
+export(set_layout)
+export(span)
 export(state)
+export(strong)
 importFrom(R6,R6Class)
 importFrom(assertthat,assert_that)
 importFrom(base64enc,base64encode)
@@ -25,6 +44,7 @@ importFrom(htmltools,htmlDependencies)
 importFrom(htmltools,htmlDependency)
 importFrom(htmltools,renderDependencies)
 importFrom(jsonlite,toJSON)
+importFrom(magrittr,"%>%")
 importFrom(reqres,default_parsers)
 importFrom(routr,Route)
 importFrom(routr,RouteStack)

R/all_tags.R

@@ -0,0 +1,135 @@
+## Generated by `scripts/generate_tags.R`; do not edit by hand
+all_tags <- c(
+ "a",
+ "abbr",
+ "acronym",
+ "address",
+ "area",
+ "article",
+ "aside",
+ "audio",
+ "b",
+ "base",
+ "basefont",
+ "bdi",
+ "bdo",
+ "big",
+ "blink",
+ "blockquote",
+ "br",
+ "button",
+ "canvas",
+ "caption",
+ "center",
+ "cite",
+ "code",
+ "col",
+ "colgroup",
+ "command",
+ "content",
+ "data",
+ "datalist",
+ "dd",
+ "del",
+ "details",
+ "dfn",
+ "dialog",
+ "div",
+ "dl",
+ "dt",
+ "element",
+ "em",
+ "embed",
+ "fieldset",
+ "figcaption",
+ "figure",
+ "font",
+ "footer",
+ "form",
+ "frame",
+ "frameset",
+ "h1",
+ "h2",
+ "h3",
+ "h4",
+ "h5",
+ "h6",
+ "header",
+ "hgroup",
+ "hr",
+ "i",
+ "iframe",
+ "img",
+ "ins",
+ "isindex",
+ "kbd",
+ "keygen",
+ "label",
+ "legend",
+ "li",
+ "link",
+ "listing",
+ "main",
+ "map",
+ "mark",
+ "marquee",
+ "meta",
+ "meter",
+ "multicol",
+ "nav",
+ "nextid",
+ "nobr",
+ "noscript",
+ "object",
+ "ol",
+ "optgroup",
+ "option",
+ "output",
+ "p",
+ "param",
+ "picture",
+ "plaintext",
+ "pre",
+ "progress",
+ "q",
+ "rb",
+ "rp",
+ "rt",
+ "rtc",
+ "ruby",
+ "s",
+ "samp",
+ "script",
+ "section",
+ "select",
+ "shadow",
+ "slot",
+ "small",
+ "source",
+ "spacer",
+ "span",
+ "strike",
+ "strong",
+ "sub",
+ "summary",
+ "sup",
+ "table",
+ "tbody",
+ "td",
+ "template",
+ "textarea",
+ "tfoot",
+ "th",
+ "thead",
+ "time",
+ "title",
+ "tr",
+ "track",
+ "u",
+ "ul",
+ "var",
+ "video",
+ "wbr",
+ "xmp"
+)
+names(all_tags) <- all_tags

R/tags.R

@@ -0,0 +1,123 @@
+#' Create HTML tags
+#'
+#' Create an HTML tag to place in a Dash app layout. All tags are available
+#' in the `html` list, and some common tags have shortcuts as functions for
+#' convenience (e.g. `h1()` produces `<h1>` and is equivalent to `html$h1()`).
+#'
+#' @name tags
+#' @param ... Any named arguments become tag attributes, and any unnamed
+#' arguments become children. A named argument with a value of `NULL` will
+#' be removed, and a named argument with a value of `NA` will be rendered
+#' as a boolean argument. See 'Special attributes' below for more information.
+#' @param n_clicks (Numeric) An integer that represents the number of times
+#' that this element has been clicked on. For advanced users only.
+#' @param tag_name The name of the HTML tag.
+#' @param content List of attributes and children.
+#'
+#' @section Special attributes:
+#' There are a few HTML attributes that are treated in a special way:
+#' - To add a `class` attribute, use the `className` parameter
+#' - To add a `for` attribute, use the `htmlFor` parameter
+#' - The `style` attribute is not provided as a string. Instead, it's provided
+#' as a named list, where the name and value of each element correspond to the
+#' CSS property and value. Each CSS property should be written in camelCase.
+#'
+#' @examples
+#' app <- dash_app()
+#' app %>% set_layout(
+#' html$div(
+#' h1(
+#' "title",
+#' style = list(
+#' "color" = "red",
+#' "backgroundColor" = "blue"
+#' )
+#' ),
+#' "some text",
+#' button(
+#' "can't click me",
+#' disabled = NA,
+#' className = "mybtn"
+#' )
+#' )
+#' )
+#' app %>% run_app()
+#'
+NULL
+
+#' @rdname tags
+#' @format NULL
+#' @export
+html <- lapply(all_tags, function(tag_name) {
+ rlang::new_function(
+ args = alist(... = , n_clicks = NULL),
+ body = rlang::expr({
+ dash_tag(!!tag_name, list(...), n_clicks = n_clicks)
+ }),
+ env = asNamespace("dash")
+ )
+})
+
+#' @rdname tags
+#' @export
+h1 <- html$h1
+
+#' @rdname tags
+#' @export
+h2 <- html$h2
+
+#' @rdname tags
+#' @export
+h3 <- html$h3
+
+#' @rdname tags
+#' @export
+h4 <- html$h4
+
+#' @rdname tags
+#' @export
+div <- html$div
+
+#' @rdname tags
+#' @export
+span <- html$span
+
+#' @rdname tags
+#' @export
+p <- html$p
+
+#' @rdname tags
+#' @export
+strong <- html$strong
+
+#' @rdname tags
+#' @export
+br <- html$br
+
+#' @rdname tags
+#' @export
+button <- html$button
+
+#' @rdname tags
+#' @export
+dash_tag <- function(tag_name, content = list(), n_clicks = NULL) {
+ content_names <- rlang::names2(content)
+ content_named_idx <- nzchar(content_names)
+ attributes <- remove_empty(content[content_named_idx])
+ children <- unname(content[!content_named_idx])
+
+ # Support boolean attributes
+ attributes[is.na(attributes)] <- names(attributes[is.na(attributes)])
+ attributes[attributes == ""] <- names(attributes[attributes == ""])
+
+ tag_params <- attributes
+ tag_params[["children"]] <- children
+ tag_params[["n_clicks"]] <- n_clicks
+
+ dash_html_fx <- paste0("html", toupper(substring(tag_name, 1, 1)), substring(tag_name, 2))
+ if (tag_name %in% c("map", "object")) {
+ dash_html_fx <- paste0(dash_html_fx, "El")
+ }
+
+ do.call(getExportedValue("dash", dash_html_fx), tag_params)
+}

R/utils-pipe.R

@@ -0,0 +1,14 @@
+#' Pipe operator
+#'
+#' See \code{magrittr::\link[magrittr:pipe]{\%>\%}} for details.
+#'
+#' @name %>%
+#' @rdname pipe
+#' @keywords internal
+#' @export
+#' @importFrom magrittr %>%
+#' @usage lhs \%>\% rhs
+#' @param lhs A value or the magrittr placeholder.
+#' @param rhs A function call using the magrittr semantics.
+#' @return The result of calling `rhs(lhs)`.
+NULL