Rename addRenderHook to onRender

MAgojam · Dec 1, 2015 · e8ae75a · e8ae75a
1 parent 6be861f
commit e8ae75a
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 7 deletions.
diff --git a/NAMESPACE b/NAMESPACE
@@ -4,9 +4,9 @@ S3method(as.tags,htmlwidget)
 S3method(print,htmlwidget)
 S3method(print,suppress_viewer)
 export(JS)
-export(addRenderHook)
 export(appendContent)
 export(createWidget)
+export(onRender)
 export(onStaticRenderComplete)
 export(prependContent)
 export(saveWidget)

diff --git a/R/htmlwidgets.R b/R/htmlwidgets.R
@@ -94,7 +94,7 @@ appendContent <- function(x, ...) {
 #' library(leaflet)
 #'
 #' leaflet() %>% addTiles() %>%
-#'   addRenderHook("
+#'   onRender("
 #'     function(el, x) {
 #'       // Navigate the map to the user's location
 #'       this.locate({setView: true});
@@ -103,7 +103,7 @@ appendContent <- function(x, ...) {
 #' }
 #'
 #' @export
-addRenderHook <- function(x, jsCode) {
+onRender <- function(x, jsCode) {
   addHook(x, "render", jsCode)
 }
 

diff --git a/man/addRenderHook.Rd → man/onRender.Rd b/man/addRenderHook.Rd → man/onRender.Rd
@@ -1,10 +1,10 @@
 % Generated by roxygen2 (4.1.1): do not edit by hand
 % Please edit documentation in R/htmlwidgets.R
-\name{addRenderHook}
-\alias{addRenderHook}
+\name{onRender}
+\alias{onRender}
 \title{Execute custom JavaScript code after rendering}
 \usage{
-addRenderHook(x, jsCode)
+onRender(x, jsCode)
 }
 \arguments{
 \item{x}{An HTML Widget object}
@@ -33,7 +33,7 @@ The \code{jsCode} parameter must be a valid JavaScript expression
 library(leaflet)
 
 leaflet() \%>\% addTiles() \%>\%
-  addRenderHook("
+  onRender("
     function(el, x) {
       // Navigate the map to the user's location
       this.locate({setView: true});