Skip to content

Commit

Permalink
add notes about masking S4 show and removeClass functions; fixes #81
Browse files Browse the repository at this point in the history
  • Loading branch information
daattali committed Nov 12, 2017
1 parent 3eeed0c commit 81c69ce
Show file tree
Hide file tree
Showing 4 changed files with 20 additions and 0 deletions.
5 changes: 5 additions & 0 deletions R/jsFunc-classFuncs.R
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,11 @@
#' displayed (position, colour, size, etc.). You can learn the basics
#' at \href{http://www.w3schools.com/css/}{W3Schools}.
#'
#' @note If you use S4 classes, you should be aware of the fact that both S4 and
#' \code{shinyjs} use the \code{removeClass()} function. This means that when using S4,
#' it is recommended to use \code{removeCssClass()} from \code{shinyjs}, and to
#' use \code{methods::removeClass()} for S4 object.
#'
#' @param id The id of the element/Shiny tag
#' @param class The CSS class to add/remove
#' @param condition An optional argument to \code{toggleClass}, see 'Details' below.
Expand Down
5 changes: 5 additions & 0 deletions R/jsFunc-visibilityFuncs.R
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,11 @@
#' If you want to hide/show an element in a few seconds rather than immediately,
#' you can use the \code{\link[shinyjs]{delay}} function.
#'
#' @note If you use S4 classes, you should be aware of the fact that both S4 and
#' \code{shinyjs} use the \code{show()} function. This means that when using S4,
#' it is recommended to use \code{showElement()} from \code{shinyjs}, and to
#' use \code{methods::show()} for S4 object.
#'
#' @param id The id of the element/Shiny tag
#' @param anim If \code{TRUE} then animate the behaviour (default: \code{FALSE})
#' @param animType The type of animation to use, either \code{"slide"} or \code{"fade"}
Expand Down
5 changes: 5 additions & 0 deletions man/classFuncs.Rd

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

5 changes: 5 additions & 0 deletions man/visibilityFuncs.Rd

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

0 comments on commit 81c69ce

Please sign in to comment.