Skip to content

Add show_undo_redo parameter to Dash for R#194

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rpkyle merged 4 commits into from
Apr 27, 2020
Merged

Add show_undo_redo parameter to Dash for R #194

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f976757
:rotating_light: initial test
Apr 27, 2020
7d6bc60
update :books:
Apr 27, 2020
1952be7
:necktie: add CRLF
Apr 27, 2020
8fce87c
:necktie: :hocho: EOL whitespace
Apr 27, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion NAMESPACE
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -27,4 +27,4 @@ importFrom(routr,RouteStack)
importFrom(routr,ressource_route)
importFrom(stats,setNames)
importFrom(tools,file_ext)
importFrom(utils,getFromNamespace)
importFrom(utils,getFromNamespace)
27 changes: 16 additions & 11 deletions R/dash.R
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -18,7 +18,8 @@
#' requests_pathname_prefix = NULL,
#' external_scripts = NULL,
#' external_stylesheets = NULL,
#' suppress_callback_exceptions = FALSE
#' suppress_callback_exceptions = FALSE,
#' show_undo_redo = FALSE
#' )
#'
#' @section Arguments:
Expand DownExpand Up@@ -53,7 +54,9 @@
#' `external_stylesheets` \tab \tab List. An optional list of valid URLs from which
#' to serve CSS for rendered pages.\cr
#' `suppress_callback_exceptions` \tab \tab Logical. Whether to relay warnings about
#' possible layout mis-specifications when registering a callback.
#' possible layout mis-specifications when registering a callback.\cr
#' `show_undo_redo` \tab \tab Logical. Set to `TRUE` to enable undo and redo buttons for
#' stepping through the history of the app state.
#' }
#'
#' @section Fields:
Expand DownExpand Up@@ -130,6 +133,7 @@
#' \describe{
#' \item{path}{Character. A path string prefixed with a leading `/` which directs at a path or asset directory.}
#' \item{requests_pathname_prefix}{Character. The pathname prefix for the app on a deployed application. Defaults to the environment variable set by the server, or `""` if run locally.}
#' }
#' }
#' \item{`strip_relative_path(path, requests_pathname_prefix)`}{
#' The `strip_relative_path` method simplifies the handling of URLs and pathnames for apps
Expand All@@ -140,7 +144,8 @@
#' \describe{
#' \item{path}{Character. A path string prefixed with a leading `/` and `requests_pathname_prefix` which directs at a path or asset directory.}
#' \item{requests_pathname_prefix}{Character. The pathname prefix for the app on a deployed application. Defaults to the environment variable set by the server, or `""` if run locally.}
#' }
#' }
#' }
#' \item{`index_string(string)`}{
#' The `index_string` method allows the specification of a custom index by changing
#' the default `HTML` template that is generated by the Dash UI. Meta tags, CSS, Javascript,
Expand DownExpand Up@@ -271,7 +276,8 @@ Dash <- R6::R6Class(
external_scripts = NULL,
external_stylesheets = NULL,
compress = TRUE,
suppress_callback_exceptions = FALSE) {
suppress_callback_exceptions = FALSE,
show_undo_redo = FALSE) {

# argument type checking
assertthat::assert_that(inherits(server, "Fire"))
Expand DownExpand Up@@ -305,6 +311,7 @@ Dash <- R6::R6Class(
self$config$requests_pathname_prefix <- resolvePrefix(requests_pathname_prefix, "DASH_REQUESTS_PATHNAME_PREFIX", url_base_pathname)
self$config$external_scripts <- external_scripts
self$config$external_stylesheets <- external_stylesheets
self$config$show_undo_redo <- show_undo_redo

@alexcjohnsonalexcjohnsonApr 27, 2020

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah ok - you're calling to_JSON(self$config) for the _dash-config section of the index, so putting this into self$config is enough to get it included in the index. That probably means there's too much stuff being shoved in there. Doesn't have to be addressed now, feel free to make a new issue for it, but on the Py side we explicitly set what makes its way to the front end here


# ------------------------------------------------------------
# Initialize a route stack and register a static resource route
Expand DownExpand Up@@ -352,8 +359,6 @@ Dash <- R6::R6Class(
response$status <- 200L
response$type <- 'json'



TRUE
})

Expand DownExpand Up@@ -560,27 +565,27 @@ Dash <- R6::R6Class(
# if debug mode is not active
dep_path <- system.file(dep_pkg$rpkg_path,
package = dep_pkg$rpkg_name)

response$type <- get_mimetype(filename)

if (grepl("text|javascript", response$type)) {
response$body <- readLines(dep_path,
warn = FALSE,
encoding = "UTF-8")

if (private$compress && length(response$body) > 0) {
response <- tryCompress(request, response)
}
} else {
file_handle <- file(dep_path, "rb")
file_size <- file.size(dep_path)

response$body <- readBin(dep_path,
raw(),
file_size)
close(file_handle)
}
}

if (!private$debug && has_fingerprint) {
response$status <- 200L
response$set_header('Cache-Control',
Expand Down
4 changes: 2 additions & 2 deletions R/utils.R
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -506,7 +506,7 @@ get_package_mapping <- function(script_name, url_package, dependencies) {
dep_path <- file.path(x$src$file, x$stylesheet)
else if (!is.null(x$other))
dep_path <- file.path(x$src$file, x$other)

# remove n>1 slashes and replace with / if present;
# htmltools seems to permit // in pathnames, but
# this complicates string matching unless they're
Expand DownExpand Up@@ -542,7 +542,7 @@ get_mimetype <- function(filename) {
else if (filename_ext %in% c('js.map', 'map'))
return('application/json')
else
return(mime::guess_type(filename,
return(mime::guess_type(filename,
empty = "application/octet-stream"))
}

Expand Down
13 changes: 8 additions & 5 deletions man/Dash.Rd
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/clientsideFunction.Rd
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

62 changes: 62 additions & 0 deletions tests/integration/test_render.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
def click_undo(self):
undo_selector = "._dash-undo-redo span:first-child div:last-child"
undo = self.wait_for_element_by_css_selector(undo_selector)
self.wait_for_text_to_equal(undo_selector, "undo")
undo.click()


def click_redo(self):
redo_selector = "._dash-undo-redo span:last-child div:last-child"
self.wait_for_text_to_equal(redo_selector, "redo")
redo = self.wait_for_element_by_css_selector(redo_selector)
redo.click()


app = '''
library(dash)
library(dashHtmlComponents)
library(dashCoreComponents)
app <- Dash$new(show_undo_redo=TRUE)

app$layout(htmlDiv(list(dccInput(id="a"), htmlDiv(id="b"))))

app$callback(
output("b", "children"),
list(input("a", "value")),
function(a) {
return(a)
}
)

app$run_server()
'''


def test_rstr001r_undo_redo(dashr):
dashr.start_server(app)
dashr.wait_for_element_by_css_selector(
"#a"
)
input1 = dashr.find_element("#a")
input1.send_keys("xyz")
dashr.wait_for_text_to_equal(
"#b", "xyz", timeout=1
)
click_undo(dashr)
dashr.wait_for_text_to_equal(
"#b", "xy", timeout=1
)
click_undo(dashr)
dashr.wait_for_text_to_equal(
"#b", "x", timeout=1
)
click_redo(dashr)
dashr.wait_for_text_to_equal(
"#b", "xy", timeout=1
)
dashr.percy_snapshot(name="undo-redo")
click_undo(dashr)
click_undo(dashr)
dashr.wait_for_text_to_equal(
"#b", "", timeout=1
)
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Add show_undo_redo parameter to Dash for R by rpkyle · Pull Request #194 · plotly/dashR · GitHub
Skip to content
Add show_undo_redo parameter to Dash for R#194

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

rpkyle
merged 4 commits into

from

Apr 27, 2020
 Merged


Add show_undo_redo parameter to Dash for R
#194
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
f976757

:rotating_light: initial test

Apr 27, 2020
7d6bc60

update :books:

Apr 27, 2020
1952be7

:necktie: add CRLF

Apr 27, 2020
8fce87c

:necktie: :hocho: EOL whitespace

Apr 27, 2020

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 1 addition & 1 deletion
NAMESPACE

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,4 +27,4 @@ importFrom(routr,RouteStack)
importFrom(routr,ressource_route)
importFrom(stats,setNames)
importFrom(tools,file_ext)
importFrom(utils,getFromNamespace)
importFrom(utils,getFromNamespace)

27 changes: 16 additions & 11 deletions
R/dash.R

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,7 +18,8 @@
#' requests_pathname_prefix = NULL,
#' external_scripts = NULL,
#' external_stylesheets = NULL,
#' suppress_callback_exceptions = FALSE
#' suppress_callback_exceptions = FALSE,
#' show_undo_redo = FALSE
#' )
#'
#' @section Arguments:
Expand DownExpand Up@@ -53,7 +54,9 @@
#' `external_stylesheets` \tab \tab List. An optional list of valid URLs from which
#' to serve CSS for rendered pages.\cr
#' `suppress_callback_exceptions` \tab \tab Logical. Whether to relay warnings about
#' possible layout mis-specifications when registering a callback.
#' possible layout mis-specifications when registering a callback.\cr
#' `show_undo_redo` \tab \tab Logical. Set to `TRUE` to enable undo and redo buttons for
#' stepping through the history of the app state.
#' }
#'
#' @section Fields:
Expand DownExpand Up@@ -130,6 +133,7 @@
#' \describe{
#' \item{path}{Character. A path string prefixed with a leading `/` which directs at a path or asset directory.}
#' \item{requests_pathname_prefix}{Character. The pathname prefix for the app on a deployed application. Defaults to the environment variable set by the server, or `""` if run locally.}
#' }
#' }
#' \item{`strip_relative_path(path, requests_pathname_prefix)`}{
#' The `strip_relative_path` method simplifies the handling of URLs and pathnames for apps
Expand All@@ -140,7 +144,8 @@
#' \describe{
#' \item{path}{Character. A path string prefixed with a leading `/` and `requests_pathname_prefix` which directs at a path or asset directory.}
#' \item{requests_pathname_prefix}{Character. The pathname prefix for the app on a deployed application. Defaults to the environment variable set by the server, or `""` if run locally.}
#' }
#' }
#' }
#' \item{`index_string(string)`}{
#' The `index_string` method allows the specification of a custom index by changing
#' the default `HTML` template that is generated by the Dash UI. Meta tags, CSS, Javascript,
Expand DownExpand Up@@ -271,7 +276,8 @@ Dash <- R6::R6Class(
 external_scripts = NULL,
 external_stylesheets = NULL,
 compress = TRUE,
 suppress_callback_exceptions = FALSE) {
 suppress_callback_exceptions = FALSE,
 show_undo_redo = FALSE) {

 # argument type checking
 assertthat::assert_that(inherits(server, "Fire"))
Expand DownExpand Up@@ -305,6 +311,7 @@ Dash <- R6::R6Class(
 self$config$requests_pathname_prefix <- resolvePrefix(requests_pathname_prefix, "DASH_REQUESTS_PATHNAME_PREFIX", url_base_pathname)
 self$config$external_scripts <- external_scripts
 self$config$external_stylesheets <- external_stylesheets
 self$config$show_undo_redo <- show_undo_redo
@alexcjohnsonalexcjohnsonApr 27, 2020

Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah ok - you're calling to_JSON(self$config) for the _dash-config section of the index, so putting this into self$config is enough to get it included in the index. That probably means there's too much stuff being shoved in there. Doesn't have to be addressed now, feel free to make a new issue for it, but on the Py side we explicitly set what makes its way to the front end here

 # ------------------------------------------------------------
 # Initialize a route stack and register a static resource route
Expand DownExpand Up@@ -352,8 +359,6 @@ Dash <- R6::R6Class(
 response$status <- 200L
 response$type <- 'json'



 TRUE
 })

Expand DownExpand Up@@ -560,27 +565,27 @@ Dash <- R6::R6Class(
 # if debug mode is not active
 dep_path <- system.file(dep_pkg$rpkg_path,
 package = dep_pkg$rpkg_name)

 response$type <- get_mimetype(filename)

 if (grepl("text|javascript", response$type)) {
 response$body <- readLines(dep_path,
 warn = FALSE,
 encoding = "UTF-8")

 if (private$compress && length(response$body) > 0) {
 response <- tryCompress(request, response)
 }
 } else {
 file_handle <- file(dep_path, "rb")
 file_size <- file.size(dep_path)

 response$body <- readBin(dep_path,
 raw(),
 file_size)
 close(file_handle)
 }
 }

 if (!private$debug && has_fingerprint) {
 response$status <- 200L
 response$set_header('Cache-Control',
Expand Down

4 changes: 2 additions & 2 deletions
R/utils.R

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -506,7 +506,7 @@ get_package_mapping <- function(script_name, url_package, dependencies) {
 dep_path <- file.path(x$src$file, x$stylesheet)
 else if (!is.null(x$other))
 dep_path <- file.path(x$src$file, x$other)

 # remove n>1 slashes and replace with / if present;
 # htmltools seems to permit // in pathnames, but
 # this complicates string matching unless they're
Expand DownExpand Up@@ -542,7 +542,7 @@ get_mimetype <- function(filename) {
 else if (filename_ext %in% c('js.map', 'map'))
 return('application/json')
 else
 return(mime::guess_type(filename,
 return(mime::guess_type(filename,
 empty = "application/octet-stream"))
}

Expand Down

13 changes: 8 additions & 5 deletions
man/Dash.Rd

View file


Open in desktop


Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.


2 changes: 1 addition & 1 deletion
man/clientsideFunction.Rd

View file


Open in desktop


Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.


62 changes: 62 additions & 0 deletions
tests/integration/test_render.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
def click_undo(self):
 undo_selector = "._dash-undo-redo span:first-child div:last-child"
 undo = self.wait_for_element_by_css_selector(undo_selector)
 self.wait_for_text_to_equal(undo_selector, "undo")
 undo.click()


def click_redo(self):
 redo_selector = "._dash-undo-redo span:last-child div:last-child"
 self.wait_for_text_to_equal(redo_selector, "redo")
 redo = self.wait_for_element_by_css_selector(redo_selector)
 redo.click()


app = ''' 
library(dash)
library(dashHtmlComponents)
library(dashCoreComponents)
app <- Dash$new(show_undo_redo=TRUE)

app$layout(htmlDiv(list(dccInput(id="a"), htmlDiv(id="b"))))

app$callback(
 output("b", "children"),
 list(input("a", "value")),
 function(a) {
 return(a)
 }
)

app$run_server()
'''


def test_rstr001r_undo_redo(dashr):
 dashr.start_server(app)
 dashr.wait_for_element_by_css_selector(
 "#a"
 ) 
 input1 = dashr.find_element("#a")
 input1.send_keys("xyz")
 dashr.wait_for_text_to_equal(
 "#b", "xyz", timeout=1
 )
 click_undo(dashr)
 dashr.wait_for_text_to_equal(
 "#b", "xy", timeout=1
 )
 click_undo(dashr)
 dashr.wait_for_text_to_equal(
 "#b", "x", timeout=1
 )
 click_redo(dashr)
 dashr.wait_for_text_to_equal(
 "#b", "xy", timeout=1
 )
 dashr.percy_snapshot(name="undo-redo")
 click_undo(dashr)
 click_undo(dashr)
 dashr.wait_for_text_to_equal(
 "#b", "", timeout=1
 )

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Add show_undo_redo parameter to Dash for R by rpkyle · Pull Request #194 · plotly/dashR · GitHub
Skip to content
Add show_undo_redo parameter to Dash for R#194

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

rpkyle
merged 4 commits into

from

Apr 27, 2020
 Merged


Add show_undo_redo parameter to Dash for R
#194
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
f976757

:rotating_light: initial test

Apr 27, 2020
7d6bc60

update :books:

Apr 27, 2020
1952be7

:necktie: add CRLF

Apr 27, 2020
8fce87c

:necktie: :hocho: EOL whitespace

Apr 27, 2020

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 1 addition & 1 deletion
NAMESPACE

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,4 +27,4 @@ importFrom(routr,RouteStack)
importFrom(routr,ressource_route)
importFrom(stats,setNames)
importFrom(tools,file_ext)
importFrom(utils,getFromNamespace)
importFrom(utils,getFromNamespace)

27 changes: 16 additions & 11 deletions
R/dash.R

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,7 +18,8 @@
#' requests_pathname_prefix = NULL,
#' external_scripts = NULL,
#' external_stylesheets = NULL,
#' suppress_callback_exceptions = FALSE
#' suppress_callback_exceptions = FALSE,
#' show_undo_redo = FALSE
#' )
#'
#' @section Arguments:
Expand DownExpand Up@@ -53,7 +54,9 @@
#' `external_stylesheets` \tab \tab List. An optional list of valid URLs from which
#' to serve CSS for rendered pages.\cr
#' `suppress_callback_exceptions` \tab \tab Logical. Whether to relay warnings about
#' possible layout mis-specifications when registering a callback.
#' possible layout mis-specifications when registering a callback.\cr
#' `show_undo_redo` \tab \tab Logical. Set to `TRUE` to enable undo and redo buttons for
#' stepping through the history of the app state.
#' }
#'
#' @section Fields:
Expand DownExpand Up@@ -130,6 +133,7 @@
#' \describe{
#' \item{path}{Character. A path string prefixed with a leading `/` which directs at a path or asset directory.}
#' \item{requests_pathname_prefix}{Character. The pathname prefix for the app on a deployed application. Defaults to the environment variable set by the server, or `""` if run locally.}
#' }
#' }
#' \item{`strip_relative_path(path, requests_pathname_prefix)`}{
#' The `strip_relative_path` method simplifies the handling of URLs and pathnames for apps
Expand All@@ -140,7 +144,8 @@
#' \describe{
#' \item{path}{Character. A path string prefixed with a leading `/` and `requests_pathname_prefix` which directs at a path or asset directory.}
#' \item{requests_pathname_prefix}{Character. The pathname prefix for the app on a deployed application. Defaults to the environment variable set by the server, or `""` if run locally.}
#' }
#' }
#' }
#' \item{`index_string(string)`}{
#' The `index_string` method allows the specification of a custom index by changing
#' the default `HTML` template that is generated by the Dash UI. Meta tags, CSS, Javascript,
Expand DownExpand Up@@ -271,7 +276,8 @@ Dash <- R6::R6Class(
 external_scripts = NULL,
 external_stylesheets = NULL,
 compress = TRUE,
 suppress_callback_exceptions = FALSE) {
 suppress_callback_exceptions = FALSE,
 show_undo_redo = FALSE) {

 # argument type checking
 assertthat::assert_that(inherits(server, "Fire"))
Expand DownExpand Up@@ -305,6 +311,7 @@ Dash <- R6::R6Class(
 self$config$requests_pathname_prefix <- resolvePrefix(requests_pathname_prefix, "DASH_REQUESTS_PATHNAME_PREFIX", url_base_pathname)
 self$config$external_scripts <- external_scripts
 self$config$external_stylesheets <- external_stylesheets
 self$config$show_undo_redo <- show_undo_redo
@alexcjohnsonalexcjohnsonApr 27, 2020

Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah ok - you're calling to_JSON(self$config) for the _dash-config section of the index, so putting this into self$config is enough to get it included in the index. That probably means there's too much stuff being shoved in there. Doesn't have to be addressed now, feel free to make a new issue for it, but on the Py side we explicitly set what makes its way to the front end here

 # ------------------------------------------------------------
 # Initialize a route stack and register a static resource route
Expand DownExpand Up@@ -352,8 +359,6 @@ Dash <- R6::R6Class(
 response$status <- 200L
 response$type <- 'json'



 TRUE
 })

Expand DownExpand Up@@ -560,27 +565,27 @@ Dash <- R6::R6Class(
 # if debug mode is not active
 dep_path <- system.file(dep_pkg$rpkg_path,
 package = dep_pkg$rpkg_name)

 response$type <- get_mimetype(filename)

 if (grepl("text|javascript", response$type)) {
 response$body <- readLines(dep_path,
 warn = FALSE,
 encoding = "UTF-8")

 if (private$compress && length(response$body) > 0) {
 response <- tryCompress(request, response)
 }
 } else {
 file_handle <- file(dep_path, "rb")
 file_size <- file.size(dep_path)

 response$body <- readBin(dep_path,
 raw(),
 file_size)
 close(file_handle)
 }
 }

 if (!private$debug && has_fingerprint) {
 response$status <- 200L
 response$set_header('Cache-Control',
Expand Down

4 changes: 2 additions & 2 deletions
R/utils.R

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -506,7 +506,7 @@ get_package_mapping <- function(script_name, url_package, dependencies) {
 dep_path <- file.path(x$src$file, x$stylesheet)
 else if (!is.null(x$other))
 dep_path <- file.path(x$src$file, x$other)

 # remove n>1 slashes and replace with / if present;
 # htmltools seems to permit // in pathnames, but
 # this complicates string matching unless they're
Expand DownExpand Up@@ -542,7 +542,7 @@ get_mimetype <- function(filename) {
 else if (filename_ext %in% c('js.map', 'map'))
 return('application/json')
 else
 return(mime::guess_type(filename,
 return(mime::guess_type(filename,
 empty = "application/octet-stream"))
}

Expand Down

13 changes: 8 additions & 5 deletions
man/Dash.Rd

View file


Open in desktop


Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.


2 changes: 1 addition & 1 deletion
man/clientsideFunction.Rd

View file


Open in desktop


Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.


62 changes: 62 additions & 0 deletions
tests/integration/test_render.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
def click_undo(self):
 undo_selector = "._dash-undo-redo span:first-child div:last-child"
 undo = self.wait_for_element_by_css_selector(undo_selector)
 self.wait_for_text_to_equal(undo_selector, "undo")
 undo.click()


def click_redo(self):
 redo_selector = "._dash-undo-redo span:last-child div:last-child"
 self.wait_for_text_to_equal(redo_selector, "redo")
 redo = self.wait_for_element_by_css_selector(redo_selector)
 redo.click()


app = ''' 
library(dash)
library(dashHtmlComponents)
library(dashCoreComponents)
app <- Dash$new(show_undo_redo=TRUE)

app$layout(htmlDiv(list(dccInput(id="a"), htmlDiv(id="b"))))

app$callback(
 output("b", "children"),
 list(input("a", "value")),
 function(a) {
 return(a)
 }
)

app$run_server()
'''


def test_rstr001r_undo_redo(dashr):
 dashr.start_server(app)
 dashr.wait_for_element_by_css_selector(
 "#a"
 ) 
 input1 = dashr.find_element("#a")
 input1.send_keys("xyz")
 dashr.wait_for_text_to_equal(
 "#b", "xyz", timeout=1
 )
 click_undo(dashr)
 dashr.wait_for_text_to_equal(
 "#b", "xy", timeout=1
 )
 click_undo(dashr)
 dashr.wait_for_text_to_equal(
 "#b", "x", timeout=1
 )
 click_redo(dashr)
 dashr.wait_for_text_to_equal(
 "#b", "xy", timeout=1
 )
 dashr.percy_snapshot(name="undo-redo")
 click_undo(dashr)
 click_undo(dashr)
 dashr.wait_for_text_to_equal(
 "#b", "", timeout=1
 )

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Add show_undo_redo parameter to Dash for R by rpkyle · Pull Request #194 · plotly/dashR · GitHub
Skip to content
Add show_undo_redo parameter to Dash for R#194

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

rpkyle
merged 4 commits into

from

Apr 27, 2020
 Merged


Add show_undo_redo parameter to Dash for R
#194
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
f976757

:rotating_light: initial test

Apr 27, 2020
7d6bc60

update :books:

Apr 27, 2020
1952be7

:necktie: add CRLF

Apr 27, 2020
8fce87c

:necktie: :hocho: EOL whitespace

Apr 27, 2020

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 1 addition & 1 deletion
NAMESPACE

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,4 +27,4 @@ importFrom(routr,RouteStack)
importFrom(routr,ressource_route)
importFrom(stats,setNames)
importFrom(tools,file_ext)
importFrom(utils,getFromNamespace)
importFrom(utils,getFromNamespace)

27 changes: 16 additions & 11 deletions
R/dash.R

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,7 +18,8 @@
#' requests_pathname_prefix = NULL,
#' external_scripts = NULL,
#' external_stylesheets = NULL,
#' suppress_callback_exceptions = FALSE
#' suppress_callback_exceptions = FALSE,
#' show_undo_redo = FALSE
#' )
#'
#' @section Arguments:
Expand DownExpand Up@@ -53,7 +54,9 @@
#' `external_stylesheets` \tab \tab List. An optional list of valid URLs from which
#' to serve CSS for rendered pages.\cr
#' `suppress_callback_exceptions` \tab \tab Logical. Whether to relay warnings about
#' possible layout mis-specifications when registering a callback.
#' possible layout mis-specifications when registering a callback.\cr
#' `show_undo_redo` \tab \tab Logical. Set to `TRUE` to enable undo and redo buttons for
#' stepping through the history of the app state.
#' }
#'
#' @section Fields:
Expand DownExpand Up@@ -130,6 +133,7 @@
#' \describe{
#' \item{path}{Character. A path string prefixed with a leading `/` which directs at a path or asset directory.}
#' \item{requests_pathname_prefix}{Character. The pathname prefix for the app on a deployed application. Defaults to the environment variable set by the server, or `""` if run locally.}
#' }
#' }
#' \item{`strip_relative_path(path, requests_pathname_prefix)`}{
#' The `strip_relative_path` method simplifies the handling of URLs and pathnames for apps
Expand All@@ -140,7 +144,8 @@
#' \describe{
#' \item{path}{Character. A path string prefixed with a leading `/` and `requests_pathname_prefix` which directs at a path or asset directory.}
#' \item{requests_pathname_prefix}{Character. The pathname prefix for the app on a deployed application. Defaults to the environment variable set by the server, or `""` if run locally.}
#' }
#' }
#' }
#' \item{`index_string(string)`}{
#' The `index_string` method allows the specification of a custom index by changing
#' the default `HTML` template that is generated by the Dash UI. Meta tags, CSS, Javascript,
Expand DownExpand Up@@ -271,7 +276,8 @@ Dash <- R6::R6Class(
 external_scripts = NULL,
 external_stylesheets = NULL,
 compress = TRUE,
 suppress_callback_exceptions = FALSE) {
 suppress_callback_exceptions = FALSE,
 show_undo_redo = FALSE) {

 # argument type checking
 assertthat::assert_that(inherits(server, "Fire"))
Expand DownExpand Up@@ -305,6 +311,7 @@ Dash <- R6::R6Class(
 self$config$requests_pathname_prefix <- resolvePrefix(requests_pathname_prefix, "DASH_REQUESTS_PATHNAME_PREFIX", url_base_pathname)
 self$config$external_scripts <- external_scripts
 self$config$external_stylesheets <- external_stylesheets
 self$config$show_undo_redo <- show_undo_redo
@alexcjohnsonalexcjohnsonApr 27, 2020

Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah ok - you're calling to_JSON(self$config) for the _dash-config section of the index, so putting this into self$config is enough to get it included in the index. That probably means there's too much stuff being shoved in there. Doesn't have to be addressed now, feel free to make a new issue for it, but on the Py side we explicitly set what makes its way to the front end here

 # ------------------------------------------------------------
 # Initialize a route stack and register a static resource route
Expand DownExpand Up@@ -352,8 +359,6 @@ Dash <- R6::R6Class(
 response$status <- 200L
 response$type <- 'json'



 TRUE
 })

Expand DownExpand Up@@ -560,27 +565,27 @@ Dash <- R6::R6Class(
 # if debug mode is not active
 dep_path <- system.file(dep_pkg$rpkg_path,
 package = dep_pkg$rpkg_name)

 response$type <- get_mimetype(filename)

 if (grepl("text|javascript", response$type)) {
 response$body <- readLines(dep_path,
 warn = FALSE,
 encoding = "UTF-8")

 if (private$compress && length(response$body) > 0) {
 response <- tryCompress(request, response)
 }
 } else {
 file_handle <- file(dep_path, "rb")
 file_size <- file.size(dep_path)

 response$body <- readBin(dep_path,
 raw(),
 file_size)
 close(file_handle)
 }
 }

 if (!private$debug && has_fingerprint) {
 response$status <- 200L
 response$set_header('Cache-Control',
Expand Down

4 changes: 2 additions & 2 deletions
R/utils.R

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -506,7 +506,7 @@ get_package_mapping <- function(script_name, url_package, dependencies) {
 dep_path <- file.path(x$src$file, x$stylesheet)
 else if (!is.null(x$other))
 dep_path <- file.path(x$src$file, x$other)

 # remove n>1 slashes and replace with / if present;
 # htmltools seems to permit // in pathnames, but
 # this complicates string matching unless they're
Expand DownExpand Up@@ -542,7 +542,7 @@ get_mimetype <- function(filename) {
 else if (filename_ext %in% c('js.map', 'map'))
 return('application/json')
 else
 return(mime::guess_type(filename,
 return(mime::guess_type(filename,
 empty = "application/octet-stream"))
}

Expand Down

13 changes: 8 additions & 5 deletions
man/Dash.Rd

View file


Open in desktop


Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.


2 changes: 1 addition & 1 deletion
man/clientsideFunction.Rd

View file


Open in desktop


Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.


62 changes: 62 additions & 0 deletions
tests/integration/test_render.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
def click_undo(self):
 undo_selector = "._dash-undo-redo span:first-child div:last-child"
 undo = self.wait_for_element_by_css_selector(undo_selector)
 self.wait_for_text_to_equal(undo_selector, "undo")
 undo.click()


def click_redo(self):
 redo_selector = "._dash-undo-redo span:last-child div:last-child"
 self.wait_for_text_to_equal(redo_selector, "redo")
 redo = self.wait_for_element_by_css_selector(redo_selector)
 redo.click()


app = ''' 
library(dash)
library(dashHtmlComponents)
library(dashCoreComponents)
app <- Dash$new(show_undo_redo=TRUE)

app$layout(htmlDiv(list(dccInput(id="a"), htmlDiv(id="b"))))

app$callback(
 output("b", "children"),
 list(input("a", "value")),
 function(a) {
 return(a)
 }
)

app$run_server()
'''


def test_rstr001r_undo_redo(dashr):
 dashr.start_server(app)
 dashr.wait_for_element_by_css_selector(
 "#a"
 ) 
 input1 = dashr.find_element("#a")
 input1.send_keys("xyz")
 dashr.wait_for_text_to_equal(
 "#b", "xyz", timeout=1
 )
 click_undo(dashr)
 dashr.wait_for_text_to_equal(
 "#b", "xy", timeout=1
 )
 click_undo(dashr)
 dashr.wait_for_text_to_equal(
 "#b", "x", timeout=1
 )
 click_redo(dashr)
 dashr.wait_for_text_to_equal(
 "#b", "xy", timeout=1
 )
 dashr.percy_snapshot(name="undo-redo")
 click_undo(dashr)
 click_undo(dashr)
 dashr.wait_for_text_to_equal(
 "#b", "", timeout=1
 )

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '
Add show_undo_redo parameter to Dash for R by rpkyle · Pull Request #194 · plotly/dashR · GitHub
Skip to content
Add show_undo_redo parameter to Dash for R#194

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

rpkyle
merged 4 commits into

from

Apr 27, 2020
 Merged


Add show_undo_redo parameter to Dash for R
#194
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
f976757

:rotating_light: initial test

Apr 27, 2020
7d6bc60

update :books:

Apr 27, 2020
1952be7

:necktie: add CRLF

Apr 27, 2020
8fce87c

:necktie: :hocho: EOL whitespace

Apr 27, 2020

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 1 addition & 1 deletion
NAMESPACE

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,4 +27,4 @@ importFrom(routr,RouteStack)
importFrom(routr,ressource_route)
importFrom(stats,setNames)
importFrom(tools,file_ext)
importFrom(utils,getFromNamespace)
importFrom(utils,getFromNamespace)

27 changes: 16 additions & 11 deletions
R/dash.R

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,7 +18,8 @@
#' requests_pathname_prefix = NULL,
#' external_scripts = NULL,
#' external_stylesheets = NULL,
#' suppress_callback_exceptions = FALSE
#' suppress_callback_exceptions = FALSE,
#' show_undo_redo = FALSE
#' )
#'
#' @section Arguments:
Expand DownExpand Up@@ -53,7 +54,9 @@
#' `external_stylesheets` \tab \tab List. An optional list of valid URLs from which
#' to serve CSS for rendered pages.\cr
#' `suppress_callback_exceptions` \tab \tab Logical. Whether to relay warnings about
#' possible layout mis-specifications when registering a callback.
#' possible layout mis-specifications when registering a callback.\cr
#' `show_undo_redo` \tab \tab Logical. Set to `TRUE` to enable undo and redo buttons for
#' stepping through the history of the app state.
#' }
#'
#' @section Fields:
Expand DownExpand Up@@ -130,6 +133,7 @@
#' \describe{
#' \item{path}{Character. A path string prefixed with a leading `/` which directs at a path or asset directory.}
#' \item{requests_pathname_prefix}{Character. The pathname prefix for the app on a deployed application. Defaults to the environment variable set by the server, or `""` if run locally.}
#' }
#' }
#' \item{`strip_relative_path(path, requests_pathname_prefix)`}{
#' The `strip_relative_path` method simplifies the handling of URLs and pathnames for apps
Expand All@@ -140,7 +144,8 @@
#' \describe{
#' \item{path}{Character. A path string prefixed with a leading `/` and `requests_pathname_prefix` which directs at a path or asset directory.}
#' \item{requests_pathname_prefix}{Character. The pathname prefix for the app on a deployed application. Defaults to the environment variable set by the server, or `""` if run locally.}
#' }
#' }
#' }
#' \item{`index_string(string)`}{
#' The `index_string` method allows the specification of a custom index by changing
#' the default `HTML` template that is generated by the Dash UI. Meta tags, CSS, Javascript,
Expand DownExpand Up@@ -271,7 +276,8 @@ Dash <- R6::R6Class(
 external_scripts = NULL,
 external_stylesheets = NULL,
 compress = TRUE,
 suppress_callback_exceptions = FALSE) {
 suppress_callback_exceptions = FALSE,
 show_undo_redo = FALSE) {

 # argument type checking
 assertthat::assert_that(inherits(server, "Fire"))
Expand DownExpand Up@@ -305,6 +311,7 @@ Dash <- R6::R6Class(
 self$config$requests_pathname_prefix <- resolvePrefix(requests_pathname_prefix, "DASH_REQUESTS_PATHNAME_PREFIX", url_base_pathname)
 self$config$external_scripts <- external_scripts
 self$config$external_stylesheets <- external_stylesheets
 self$config$show_undo_redo <- show_undo_redo
@alexcjohnsonalexcjohnsonApr 27, 2020

Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah ok - you're calling to_JSON(self$config) for the _dash-config section of the index, so putting this into self$config is enough to get it included in the index. That probably means there's too much stuff being shoved in there. Doesn't have to be addressed now, feel free to make a new issue for it, but on the Py side we explicitly set what makes its way to the front end here

 # ------------------------------------------------------------
 # Initialize a route stack and register a static resource route
Expand DownExpand Up@@ -352,8 +359,6 @@ Dash <- R6::R6Class(
 response$status <- 200L
 response$type <- 'json'



 TRUE
 })

Expand DownExpand Up@@ -560,27 +565,27 @@ Dash <- R6::R6Class(
 # if debug mode is not active
 dep_path <- system.file(dep_pkg$rpkg_path,
 package = dep_pkg$rpkg_name)

 response$type <- get_mimetype(filename)

 if (grepl("text|javascript", response$type)) {
 response$body <- readLines(dep_path,
 warn = FALSE,
 encoding = "UTF-8")

 if (private$compress && length(response$body) > 0) {
 response <- tryCompress(request, response)
 }
 } else {
 file_handle <- file(dep_path, "rb")
 file_size <- file.size(dep_path)

 response$body <- readBin(dep_path,
 raw(),
 file_size)
 close(file_handle)
 }
 }

 if (!private$debug && has_fingerprint) {
 response$status <- 200L
 response$set_header('Cache-Control',
Expand Down

4 changes: 2 additions & 2 deletions
R/utils.R

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -506,7 +506,7 @@ get_package_mapping <- function(script_name, url_package, dependencies) {
 dep_path <- file.path(x$src$file, x$stylesheet)
 else if (!is.null(x$other))
 dep_path <- file.path(x$src$file, x$other)

 # remove n>1 slashes and replace with / if present;
 # htmltools seems to permit // in pathnames, but
 # this complicates string matching unless they're
Expand DownExpand Up@@ -542,7 +542,7 @@ get_mimetype <- function(filename) {
 else if (filename_ext %in% c('js.map', 'map'))
 return('application/json')
 else
 return(mime::guess_type(filename,
 return(mime::guess_type(filename,
 empty = "application/octet-stream"))
}

Expand Down

13 changes: 8 additions & 5 deletions
man/Dash.Rd

View file


Open in desktop


Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.


2 changes: 1 addition & 1 deletion
man/clientsideFunction.Rd

View file


Open in desktop


Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.


62 changes: 62 additions & 0 deletions
tests/integration/test_render.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
def click_undo(self):
 undo_selector = "._dash-undo-redo span:first-child div:last-child"
 undo = self.wait_for_element_by_css_selector(undo_selector)
 self.wait_for_text_to_equal(undo_selector, "undo")
 undo.click()


def click_redo(self):
 redo_selector = "._dash-undo-redo span:last-child div:last-child"
 self.wait_for_text_to_equal(redo_selector, "redo")
 redo = self.wait_for_element_by_css_selector(redo_selector)
 redo.click()


app = ''' 
library(dash)
library(dashHtmlComponents)
library(dashCoreComponents)
app <- Dash$new(show_undo_redo=TRUE)

app$layout(htmlDiv(list(dccInput(id="a"), htmlDiv(id="b"))))

app$callback(
 output("b", "children"),
 list(input("a", "value")),
 function(a) {
 return(a)
 }
)

app$run_server()
'''


def test_rstr001r_undo_redo(dashr):
 dashr.start_server(app)
 dashr.wait_for_element_by_css_selector(
 "#a"
 ) 
 input1 = dashr.find_element("#a")
 input1.send_keys("xyz")
 dashr.wait_for_text_to_equal(
 "#b", "xyz", timeout=1
 )
 click_undo(dashr)
 dashr.wait_for_text_to_equal(
 "#b", "xy", timeout=1
 )
 click_undo(dashr)
 dashr.wait_for_text_to_equal(
 "#b", "x", timeout=1
 )
 click_redo(dashr)
 dashr.wait_for_text_to_equal(
 "#b", "xy", timeout=1
 )
 dashr.percy_snapshot(name="undo-redo")
 click_undo(dashr)
 click_undo(dashr)
 dashr.wait_for_text_to_equal(
 "#b", "", timeout=1
 )

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Add show_undo_redo parameter to Dash for R by rpkyle · Pull Request #194 · plotly/dashR · GitHub
Skip to content
Add show_undo_redo parameter to Dash for R#194

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

rpkyle
merged 4 commits into

from

Apr 27, 2020
 Merged


Add show_undo_redo parameter to Dash for R
#194
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
f976757

:rotating_light: initial test

Apr 27, 2020
7d6bc60

update :books:

Apr 27, 2020
1952be7

:necktie: add CRLF

Apr 27, 2020
8fce87c

:necktie: :hocho: EOL whitespace

Apr 27, 2020

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 1 addition & 1 deletion
NAMESPACE

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,4 +27,4 @@ importFrom(routr,RouteStack)
importFrom(routr,ressource_route)
importFrom(stats,setNames)
importFrom(tools,file_ext)
importFrom(utils,getFromNamespace)
importFrom(utils,getFromNamespace)

27 changes: 16 additions & 11 deletions
R/dash.R

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,7 +18,8 @@
#' requests_pathname_prefix = NULL,
#' external_scripts = NULL,
#' external_stylesheets = NULL,
#' suppress_callback_exceptions = FALSE
#' suppress_callback_exceptions = FALSE,
#' show_undo_redo = FALSE
#' )
#'
#' @section Arguments:
Expand DownExpand Up@@ -53,7 +54,9 @@
#' `external_stylesheets` \tab \tab List. An optional list of valid URLs from which
#' to serve CSS for rendered pages.\cr
#' `suppress_callback_exceptions` \tab \tab Logical. Whether to relay warnings about
#' possible layout mis-specifications when registering a callback.
#' possible layout mis-specifications when registering a callback.\cr
#' `show_undo_redo` \tab \tab Logical. Set to `TRUE` to enable undo and redo buttons for
#' stepping through the history of the app state.
#' }
#'
#' @section Fields:
Expand DownExpand Up@@ -130,6 +133,7 @@
#' \describe{
#' \item{path}{Character. A path string prefixed with a leading `/` which directs at a path or asset directory.}
#' \item{requests_pathname_prefix}{Character. The pathname prefix for the app on a deployed application. Defaults to the environment variable set by the server, or `""` if run locally.}
#' }
#' }
#' \item{`strip_relative_path(path, requests_pathname_prefix)`}{
#' The `strip_relative_path` method simplifies the handling of URLs and pathnames for apps
Expand All@@ -140,7 +144,8 @@
#' \describe{
#' \item{path}{Character. A path string prefixed with a leading `/` and `requests_pathname_prefix` which directs at a path or asset directory.}
#' \item{requests_pathname_prefix}{Character. The pathname prefix for the app on a deployed application. Defaults to the environment variable set by the server, or `""` if run locally.}
#' }
#' }
#' }
#' \item{`index_string(string)`}{
#' The `index_string` method allows the specification of a custom index by changing
#' the default `HTML` template that is generated by the Dash UI. Meta tags, CSS, Javascript,
Expand DownExpand Up@@ -271,7 +276,8 @@ Dash <- R6::R6Class(
 external_scripts = NULL,
 external_stylesheets = NULL,
 compress = TRUE,
 suppress_callback_exceptions = FALSE) {
 suppress_callback_exceptions = FALSE,
 show_undo_redo = FALSE) {

 # argument type checking
 assertthat::assert_that(inherits(server, "Fire"))
Expand DownExpand Up@@ -305,6 +311,7 @@ Dash <- R6::R6Class(
 self$config$requests_pathname_prefix <- resolvePrefix(requests_pathname_prefix, "DASH_REQUESTS_PATHNAME_PREFIX", url_base_pathname)
 self$config$external_scripts <- external_scripts
 self$config$external_stylesheets <- external_stylesheets
 self$config$show_undo_redo <- show_undo_redo
@alexcjohnsonalexcjohnsonApr 27, 2020

Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah ok - you're calling to_JSON(self$config) for the _dash-config section of the index, so putting this into self$config is enough to get it included in the index. That probably means there's too much stuff being shoved in there. Doesn't have to be addressed now, feel free to make a new issue for it, but on the Py side we explicitly set what makes its way to the front end here

 # ------------------------------------------------------------
 # Initialize a route stack and register a static resource route
Expand DownExpand Up@@ -352,8 +359,6 @@ Dash <- R6::R6Class(
 response$status <- 200L
 response$type <- 'json'



 TRUE
 })

Expand DownExpand Up@@ -560,27 +565,27 @@ Dash <- R6::R6Class(
 # if debug mode is not active
 dep_path <- system.file(dep_pkg$rpkg_path,
 package = dep_pkg$rpkg_name)

 response$type <- get_mimetype(filename)

 if (grepl("text|javascript", response$type)) {
 response$body <- readLines(dep_path,
 warn = FALSE,
 encoding = "UTF-8")

 if (private$compress && length(response$body) > 0) {
 response <- tryCompress(request, response)
 }
 } else {
 file_handle <- file(dep_path, "rb")
 file_size <- file.size(dep_path)

 response$body <- readBin(dep_path,
 raw(),
 file_size)
 close(file_handle)
 }
 }

 if (!private$debug && has_fingerprint) {
 response$status <- 200L
 response$set_header('Cache-Control',
Expand Down

4 changes: 2 additions & 2 deletions
R/utils.R

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -506,7 +506,7 @@ get_package_mapping <- function(script_name, url_package, dependencies) {
 dep_path <- file.path(x$src$file, x$stylesheet)
 else if (!is.null(x$other))
 dep_path <- file.path(x$src$file, x$other)

 # remove n>1 slashes and replace with / if present;
 # htmltools seems to permit // in pathnames, but
 # this complicates string matching unless they're
Expand DownExpand Up@@ -542,7 +542,7 @@ get_mimetype <- function(filename) {
 else if (filename_ext %in% c('js.map', 'map'))
 return('application/json')
 else
 return(mime::guess_type(filename,
 return(mime::guess_type(filename,
 empty = "application/octet-stream"))
}

Expand Down

13 changes: 8 additions & 5 deletions
man/Dash.Rd

View file


Open in desktop


Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.


2 changes: 1 addition & 1 deletion
man/clientsideFunction.Rd

View file


Open in desktop


Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.


62 changes: 62 additions & 0 deletions
tests/integration/test_render.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
def click_undo(self):
 undo_selector = "._dash-undo-redo span:first-child div:last-child"
 undo = self.wait_for_element_by_css_selector(undo_selector)
 self.wait_for_text_to_equal(undo_selector, "undo")
 undo.click()


def click_redo(self):
 redo_selector = "._dash-undo-redo span:last-child div:last-child"
 self.wait_for_text_to_equal(redo_selector, "redo")
 redo = self.wait_for_element_by_css_selector(redo_selector)
 redo.click()


app = ''' 
library(dash)
library(dashHtmlComponents)
library(dashCoreComponents)
app <- Dash$new(show_undo_redo=TRUE)

app$layout(htmlDiv(list(dccInput(id="a"), htmlDiv(id="b"))))

app$callback(
 output("b", "children"),
 list(input("a", "value")),
 function(a) {
 return(a)
 }
)

app$run_server()
'''


def test_rstr001r_undo_redo(dashr):
 dashr.start_server(app)
 dashr.wait_for_element_by_css_selector(
 "#a"
 ) 
 input1 = dashr.find_element("#a")
 input1.send_keys("xyz")
 dashr.wait_for_text_to_equal(
 "#b", "xyz", timeout=1
 )
 click_undo(dashr)
 dashr.wait_for_text_to_equal(
 "#b", "xy", timeout=1
 )
 click_undo(dashr)
 dashr.wait_for_text_to_equal(
 "#b", "x", timeout=1
 )
 click_redo(dashr)
 dashr.wait_for_text_to_equal(
 "#b", "xy", timeout=1
 )
 dashr.percy_snapshot(name="undo-redo")
 click_undo(dashr)
 click_undo(dashr)
 dashr.wait_for_text_to_equal(
 "#b", "", timeout=1
 )

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Add show_undo_redo parameter to Dash for R by rpkyle · Pull Request #194 · plotly/dashR · GitHub
Skip to content
Add show_undo_redo parameter to Dash for R#194

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

rpkyle
merged 4 commits into

from

Apr 27, 2020
 Merged


Add show_undo_redo parameter to Dash for R
#194
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
f976757

:rotating_light: initial test

Apr 27, 2020
7d6bc60

update :books:

Apr 27, 2020
1952be7

:necktie: add CRLF

Apr 27, 2020
8fce87c

:necktie: :hocho: EOL whitespace

Apr 27, 2020

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 1 addition & 1 deletion
NAMESPACE

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,4 +27,4 @@ importFrom(routr,RouteStack)
importFrom(routr,ressource_route)
importFrom(stats,setNames)
importFrom(tools,file_ext)
importFrom(utils,getFromNamespace)
importFrom(utils,getFromNamespace)

27 changes: 16 additions & 11 deletions
R/dash.R

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,7 +18,8 @@
#' requests_pathname_prefix = NULL,
#' external_scripts = NULL,
#' external_stylesheets = NULL,
#' suppress_callback_exceptions = FALSE
#' suppress_callback_exceptions = FALSE,
#' show_undo_redo = FALSE
#' )
#'
#' @section Arguments:
Expand DownExpand Up@@ -53,7 +54,9 @@
#' `external_stylesheets` \tab \tab List. An optional list of valid URLs from which
#' to serve CSS for rendered pages.\cr
#' `suppress_callback_exceptions` \tab \tab Logical. Whether to relay warnings about
#' possible layout mis-specifications when registering a callback.
#' possible layout mis-specifications when registering a callback.\cr
#' `show_undo_redo` \tab \tab Logical. Set to `TRUE` to enable undo and redo buttons for
#' stepping through the history of the app state.
#' }
#'
#' @section Fields:
Expand DownExpand Up@@ -130,6 +133,7 @@
#' \describe{
#' \item{path}{Character. A path string prefixed with a leading `/` which directs at a path or asset directory.}
#' \item{requests_pathname_prefix}{Character. The pathname prefix for the app on a deployed application. Defaults to the environment variable set by the server, or `""` if run locally.}
#' }
#' }
#' \item{`strip_relative_path(path, requests_pathname_prefix)`}{
#' The `strip_relative_path` method simplifies the handling of URLs and pathnames for apps
Expand All@@ -140,7 +144,8 @@
#' \describe{
#' \item{path}{Character. A path string prefixed with a leading `/` and `requests_pathname_prefix` which directs at a path or asset directory.}
#' \item{requests_pathname_prefix}{Character. The pathname prefix for the app on a deployed application. Defaults to the environment variable set by the server, or `""` if run locally.}
#' }
#' }
#' }
#' \item{`index_string(string)`}{
#' The `index_string` method allows the specification of a custom index by changing
#' the default `HTML` template that is generated by the Dash UI. Meta tags, CSS, Javascript,
Expand DownExpand Up@@ -271,7 +276,8 @@ Dash <- R6::R6Class(
 external_scripts = NULL,
 external_stylesheets = NULL,
 compress = TRUE,
 suppress_callback_exceptions = FALSE) {
 suppress_callback_exceptions = FALSE,
 show_undo_redo = FALSE) {

 # argument type checking
 assertthat::assert_that(inherits(server, "Fire"))
Expand DownExpand Up@@ -305,6 +311,7 @@ Dash <- R6::R6Class(
 self$config$requests_pathname_prefix <- resolvePrefix(requests_pathname_prefix, "DASH_REQUESTS_PATHNAME_PREFIX", url_base_pathname)
 self$config$external_scripts <- external_scripts
 self$config$external_stylesheets <- external_stylesheets
 self$config$show_undo_redo <- show_undo_redo
@alexcjohnsonalexcjohnsonApr 27, 2020

Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah ok - you're calling to_JSON(self$config) for the _dash-config section of the index, so putting this into self$config is enough to get it included in the index. That probably means there's too much stuff being shoved in there. Doesn't have to be addressed now, feel free to make a new issue for it, but on the Py side we explicitly set what makes its way to the front end here

 # ------------------------------------------------------------
 # Initialize a route stack and register a static resource route
Expand DownExpand Up@@ -352,8 +359,6 @@ Dash <- R6::R6Class(
 response$status <- 200L
 response$type <- 'json'



 TRUE
 })

Expand DownExpand Up@@ -560,27 +565,27 @@ Dash <- R6::R6Class(
 # if debug mode is not active
 dep_path <- system.file(dep_pkg$rpkg_path,
 package = dep_pkg$rpkg_name)

 response$type <- get_mimetype(filename)

 if (grepl("text|javascript", response$type)) {
 response$body <- readLines(dep_path,
 warn = FALSE,
 encoding = "UTF-8")

 if (private$compress && length(response$body) > 0) {
 response <- tryCompress(request, response)
 }
 } else {
 file_handle <- file(dep_path, "rb")
 file_size <- file.size(dep_path)

 response$body <- readBin(dep_path,
 raw(),
 file_size)
 close(file_handle)
 }
 }

 if (!private$debug && has_fingerprint) {
 response$status <- 200L
 response$set_header('Cache-Control',
Expand Down

4 changes: 2 additions & 2 deletions
R/utils.R

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -506,7 +506,7 @@ get_package_mapping <- function(script_name, url_package, dependencies) {
 dep_path <- file.path(x$src$file, x$stylesheet)
 else if (!is.null(x$other))
 dep_path <- file.path(x$src$file, x$other)

 # remove n>1 slashes and replace with / if present;
 # htmltools seems to permit // in pathnames, but
 # this complicates string matching unless they're
Expand DownExpand Up@@ -542,7 +542,7 @@ get_mimetype <- function(filename) {
 else if (filename_ext %in% c('js.map', 'map'))
 return('application/json')
 else
 return(mime::guess_type(filename,
 return(mime::guess_type(filename,
 empty = "application/octet-stream"))
}

Expand Down

13 changes: 8 additions & 5 deletions
man/Dash.Rd

View file


Open in desktop


Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.


2 changes: 1 addition & 1 deletion
man/clientsideFunction.Rd

View file


Open in desktop


Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.


62 changes: 62 additions & 0 deletions
tests/integration/test_render.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
def click_undo(self):
 undo_selector = "._dash-undo-redo span:first-child div:last-child"
 undo = self.wait_for_element_by_css_selector(undo_selector)
 self.wait_for_text_to_equal(undo_selector, "undo")
 undo.click()


def click_redo(self):
 redo_selector = "._dash-undo-redo span:last-child div:last-child"
 self.wait_for_text_to_equal(redo_selector, "redo")
 redo = self.wait_for_element_by_css_selector(redo_selector)
 redo.click()


app = ''' 
library(dash)
library(dashHtmlComponents)
library(dashCoreComponents)
app <- Dash$new(show_undo_redo=TRUE)

app$layout(htmlDiv(list(dccInput(id="a"), htmlDiv(id="b"))))

app$callback(
 output("b", "children"),
 list(input("a", "value")),
 function(a) {
 return(a)
 }
)

app$run_server()
'''


def test_rstr001r_undo_redo(dashr):
 dashr.start_server(app)
 dashr.wait_for_element_by_css_selector(
 "#a"
 ) 
 input1 = dashr.find_element("#a")
 input1.send_keys("xyz")
 dashr.wait_for_text_to_equal(
 "#b", "xyz", timeout=1
 )
 click_undo(dashr)
 dashr.wait_for_text_to_equal(
 "#b", "xy", timeout=1
 )
 click_undo(dashr)
 dashr.wait_for_text_to_equal(
 "#b", "x", timeout=1
 )
 click_redo(dashr)
 dashr.wait_for_text_to_equal(
 "#b", "xy", timeout=1
 )
 dashr.percy_snapshot(name="undo-redo")
 click_undo(dashr)
 click_undo(dashr)
 dashr.wait_for_text_to_equal(
 "#b", "", timeout=1
 )

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Universal Dark Mode - works on any site
(function() {
var enabled = true;
function applyDarkMode() {
if (!enabled) return;
// Create style element if it doesn't exist
var style = document.getElementById('universal-dark-mode-style');
if (!style) {
style = document.createElement('style');
style.id = 'universal-dark-mode-style';
document.head.appendChild(style);
}
// Dark mode CSS - inverts colors but preserves images/video
style.textContent = '
/* Invert everything except media */
html {
filter: invert(1) hue-rotate(180deg) !important;
background: #1a1a2e !important;
}
/* Restore images, videos, iframes, canvas */
img, video, iframe, canvas, svg, picture, [style*="background-image"] {
filter: invert(1) hue-rotate(180deg) !important;
}
/* Preserve specific elements that should not be inverted */
.no-dark-mode, .no-dark-mode *,
[data-theme="light"], [data-theme="light"],
.ace_editor, .ace_editor *,
.CodeMirror, .CodeMirror *,
.monaco-editor, .monaco-editor *,
.markdown-body pre, .markdown-body pre *,
.highlight, .highlight *,
pre code, pre code * {
filter: none !important;
}
/* Fix common UI elements */
.modal, .popup, .dropdown-menu, .tooltip, .popover {
filter: invert(1) hue-rotate(180deg) !important;
background: #2d2d44 !important;
border-color: #444 !important;
}
/* Scrollbars */
::-webkit-scrollbar { background: #1a1a2e !important; }
::-webkit-scrollbar-thumb { background: #444 !important; }
::-webkit-scrollbar-thumb:hover { background: #555 !important; }
/* Selection */
::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
';
}
function removeDarkMode() {
var style = document.getElementById('universal-dark-mode-style');
if (style) style.remove();
}
// Toggle with Alt+Shift+D
document.addEventListener('keydown', function(e) {
if (e.altKey && e.shiftKey && e.key === 'D') {
e.preventDefault();
enabled = !enabled;
if (enabled) {
applyDarkMode();
console.log('[Universal Dark Mode] Enabled');
} else {
removeDarkMode();
console.log('[Universal Dark Mode] Disabled');
}
}
});
// Apply on load
applyDarkMode();
// Re-apply on dynamic content
var observer = new MutationObserver(function(mutations) {
if (enabled && !document.getElementById('universal-dark-mode-style')) {
applyDarkMode();
}
});
observer.observe(document.head, { childList: true });
console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');
})();
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();
Add show_undo_redo parameter to Dash for R by rpkyle · Pull Request #194 · plotly/dashR · GitHub
Skip to content
Add show_undo_redo parameter to Dash for R#194

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

rpkyle
merged 4 commits into

from

Apr 27, 2020
 Merged


Add show_undo_redo parameter to Dash for R
#194
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
f976757

:rotating_light: initial test

Apr 27, 2020
7d6bc60

update :books:

Apr 27, 2020
1952be7

:necktie: add CRLF

Apr 27, 2020
8fce87c

:necktie: :hocho: EOL whitespace

Apr 27, 2020

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 1 addition & 1 deletion
NAMESPACE

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,4 +27,4 @@ importFrom(routr,RouteStack)
importFrom(routr,ressource_route)
importFrom(stats,setNames)
importFrom(tools,file_ext)
importFrom(utils,getFromNamespace)
importFrom(utils,getFromNamespace)

27 changes: 16 additions & 11 deletions
R/dash.R

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,7 +18,8 @@
#' requests_pathname_prefix = NULL,
#' external_scripts = NULL,
#' external_stylesheets = NULL,
#' suppress_callback_exceptions = FALSE
#' suppress_callback_exceptions = FALSE,
#' show_undo_redo = FALSE
#' )
#'
#' @section Arguments:
Expand DownExpand Up@@ -53,7 +54,9 @@
#' `external_stylesheets` \tab \tab List. An optional list of valid URLs from which
#' to serve CSS for rendered pages.\cr
#' `suppress_callback_exceptions` \tab \tab Logical. Whether to relay warnings about
#' possible layout mis-specifications when registering a callback.
#' possible layout mis-specifications when registering a callback.\cr
#' `show_undo_redo` \tab \tab Logical. Set to `TRUE` to enable undo and redo buttons for
#' stepping through the history of the app state.
#' }
#'
#' @section Fields:
Expand DownExpand Up@@ -130,6 +133,7 @@
#' \describe{
#' \item{path}{Character. A path string prefixed with a leading `/` which directs at a path or asset directory.}
#' \item{requests_pathname_prefix}{Character. The pathname prefix for the app on a deployed application. Defaults to the environment variable set by the server, or `""` if run locally.}
#' }
#' }
#' \item{`strip_relative_path(path, requests_pathname_prefix)`}{
#' The `strip_relative_path` method simplifies the handling of URLs and pathnames for apps
Expand All@@ -140,7 +144,8 @@
#' \describe{
#' \item{path}{Character. A path string prefixed with a leading `/` and `requests_pathname_prefix` which directs at a path or asset directory.}
#' \item{requests_pathname_prefix}{Character. The pathname prefix for the app on a deployed application. Defaults to the environment variable set by the server, or `""` if run locally.}
#' }
#' }
#' }
#' \item{`index_string(string)`}{
#' The `index_string` method allows the specification of a custom index by changing
#' the default `HTML` template that is generated by the Dash UI. Meta tags, CSS, Javascript,
Expand DownExpand Up@@ -271,7 +276,8 @@ Dash <- R6::R6Class(
 external_scripts = NULL,
 external_stylesheets = NULL,
 compress = TRUE,
 suppress_callback_exceptions = FALSE) {
 suppress_callback_exceptions = FALSE,
 show_undo_redo = FALSE) {

 # argument type checking
 assertthat::assert_that(inherits(server, "Fire"))
Expand DownExpand Up@@ -305,6 +311,7 @@ Dash <- R6::R6Class(
 self$config$requests_pathname_prefix <- resolvePrefix(requests_pathname_prefix, "DASH_REQUESTS_PATHNAME_PREFIX", url_base_pathname)
 self$config$external_scripts <- external_scripts
 self$config$external_stylesheets <- external_stylesheets
 self$config$show_undo_redo <- show_undo_redo
@alexcjohnsonalexcjohnsonApr 27, 2020

Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah ok - you're calling to_JSON(self$config) for the _dash-config section of the index, so putting this into self$config is enough to get it included in the index. That probably means there's too much stuff being shoved in there. Doesn't have to be addressed now, feel free to make a new issue for it, but on the Py side we explicitly set what makes its way to the front end here

 # ------------------------------------------------------------
 # Initialize a route stack and register a static resource route
Expand DownExpand Up@@ -352,8 +359,6 @@ Dash <- R6::R6Class(
 response$status <- 200L
 response$type <- 'json'



 TRUE
 })

Expand DownExpand Up@@ -560,27 +565,27 @@ Dash <- R6::R6Class(
 # if debug mode is not active
 dep_path <- system.file(dep_pkg$rpkg_path,
 package = dep_pkg$rpkg_name)

 response$type <- get_mimetype(filename)

 if (grepl("text|javascript", response$type)) {
 response$body <- readLines(dep_path,
 warn = FALSE,
 encoding = "UTF-8")

 if (private$compress && length(response$body) > 0) {
 response <- tryCompress(request, response)
 }
 } else {
 file_handle <- file(dep_path, "rb")
 file_size <- file.size(dep_path)

 response$body <- readBin(dep_path,
 raw(),
 file_size)
 close(file_handle)
 }
 }

 if (!private$debug && has_fingerprint) {
 response$status <- 200L
 response$set_header('Cache-Control',
Expand Down

4 changes: 2 additions & 2 deletions
R/utils.R

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -506,7 +506,7 @@ get_package_mapping <- function(script_name, url_package, dependencies) {
 dep_path <- file.path(x$src$file, x$stylesheet)
 else if (!is.null(x$other))
 dep_path <- file.path(x$src$file, x$other)

 # remove n>1 slashes and replace with / if present;
 # htmltools seems to permit // in pathnames, but
 # this complicates string matching unless they're
Expand DownExpand Up@@ -542,7 +542,7 @@ get_mimetype <- function(filename) {
 else if (filename_ext %in% c('js.map', 'map'))
 return('application/json')
 else
 return(mime::guess_type(filename,
 return(mime::guess_type(filename,
 empty = "application/octet-stream"))
}

Expand Down

13 changes: 8 additions & 5 deletions
man/Dash.Rd

View file


Open in desktop


Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.


2 changes: 1 addition & 1 deletion
man/clientsideFunction.Rd

View file


Open in desktop


Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.


62 changes: 62 additions & 0 deletions
tests/integration/test_render.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
def click_undo(self):
 undo_selector = "._dash-undo-redo span:first-child div:last-child"
 undo = self.wait_for_element_by_css_selector(undo_selector)
 self.wait_for_text_to_equal(undo_selector, "undo")
 undo.click()


def click_redo(self):
 redo_selector = "._dash-undo-redo span:last-child div:last-child"
 self.wait_for_text_to_equal(redo_selector, "redo")
 redo = self.wait_for_element_by_css_selector(redo_selector)
 redo.click()


app = ''' 
library(dash)
library(dashHtmlComponents)
library(dashCoreComponents)
app <- Dash$new(show_undo_redo=TRUE)

app$layout(htmlDiv(list(dccInput(id="a"), htmlDiv(id="b"))))

app$callback(
 output("b", "children"),
 list(input("a", "value")),
 function(a) {
 return(a)
 }
)

app$run_server()
'''


def test_rstr001r_undo_redo(dashr):
 dashr.start_server(app)
 dashr.wait_for_element_by_css_selector(
 "#a"
 ) 
 input1 = dashr.find_element("#a")
 input1.send_keys("xyz")
 dashr.wait_for_text_to_equal(
 "#b", "xyz", timeout=1
 )
 click_undo(dashr)
 dashr.wait_for_text_to_equal(
 "#b", "xy", timeout=1
 )
 click_undo(dashr)
 dashr.wait_for_text_to_equal(
 "#b", "x", timeout=1
 )
 click_redo(dashr)
 dashr.wait_for_text_to_equal(
 "#b", "xy", timeout=1
 )
 dashr.percy_snapshot(name="undo-redo")
 click_undo(dashr)
 click_undo(dashr)
 dashr.wait_for_text_to_equal(
 "#b", "", timeout=1
 )