✏️ 📚 no_update -> dashNoUpdate, docs

Author: Ryan Patrick Kyle

NAMESPACE

@@ -2,6 +2,7 @@
 
 S3method(print,dash_component)
 export(Dash)
+export(dashNoUpdate)
 export(input)
 export(output)
 export(state)

R/dash.R

@@ -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
     # ------------------------------------------------------------------------

R/dependencies.R

@@ -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) {
@@ -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)
+}