Skip to content

Commit

Permalink
✏️ 📚 no_update -> dashNoUpdate, docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Ryan Patrick Kyle committed Aug 2, 2019
1 parent bfe9cbb commit b23c248
Show file tree
Hide file tree
Showing 4 changed files with 23 additions and 11 deletions.
1 change: 1 addition & 0 deletions NAMESPACE
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

S3method(print,dash_component)
export(Dash)
export(dashNoUpdate)
export(input)
export(output)
export(state)
Expand Down
10 changes: 0 additions & 10 deletions R/dash.R
Original file line number Diff line number Diff line change
Expand Up @@ -524,16 +524,6 @@ Dash <- R6::R6Class(
private$callback_context_
},

# ------------------------------------------------------------------------
# no_update may be used within a callback to prevent a single output
# from updating; it returns a wrapped NULL of class "no_update"
# ------------------------------------------------------------------------
no_update = function() {
x <- list(NULL)
class(x) <- "no_update"
return(x)
},

# ------------------------------------------------------------------------
# convenient fiery wrappers
# ------------------------------------------------------------------------
Expand Down
14 changes: 13 additions & 1 deletion R/dependencies.R
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,15 @@
#' Use in conjunction with the `callback()` method from the [dash::Dash] class
#' to define the update logic in your application.
#'
#' The `dashNoUpdate()` function permits application developers to prevent a
#' single output from updating the layout. It has no formal arguments, but
#' returns an object of class `no_update`, for which Dash will return a `204`
#' status code and empty response body.
#'
#' @name dependencies
#' @param id a component id
#' @param property the component property to use


#' @rdname dependencies
#' @export
output <- function(id, property) {
Expand Down Expand Up @@ -44,3 +48,11 @@ dependency <- function(id = NULL, property = NULL) {
property = property
)
}

#' @rdname dependencies
#' @export
dashNoUpdate <- function() {
x <- list(NULL)
class(x) <- "no_update"
return(x)
}
9 changes: 9 additions & 0 deletions man/dependencies.Rd

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

0 comments on commit b23c248

Please sign in to comment.