Merge pull request #23 from davidruvolo51/dev

Refactored JS methods

Author: davidruvolo51

.Rbuildignore

@@ -21,3 +21,5 @@
 ^config$
 ^postcss\.config\.js$
 ^webpack\.config\.js$
+^src$
+^pkgbump\.config\.json$

.pkgbump.json

@@ -1,6 +1,6 @@
 Package: browsertools
 Title: Running Specific JavaScript functions from R
-Version: 0.1.8
+Version: 0.2.0
 Authors@R: 
     person(
         given = "David",

DESCRIPTION

@@ -1,7 +1,6 @@
 # Generated by roxygen2: do not edit by hand
 
 export(add_css)
-export(alert)
 export(as_js_object)
 export(console_error)
 export(console_log)

NAMESPACE

@@ -1,3 +1,8 @@
+# browsertools 0.2.0
+
+* Refactored Browsertools methods
+* Added new test environment (`dev/prod-app`)
+
 # browsertools 0.1.8
 
 * Switched to Webpack as the application bundler

NEWS.md

@@ -3,8 +3,7 @@
 #' Adds a css class(es) to an element using id or classname.
 #'
 #' @param elem the id or class name of an html element
-#' @param css a string containing the class(es) to add to
-#'            an html element
+#' @param css a string or character array containing css classes
 #'
 #' @return Adds a css class(es) to an element using id or classname.
 #'
@@ -17,7 +16,10 @@
 #'        tags$style(
 #'           ".blue-text {
 #'             color: blue;
-#'           }"
+#'           }",
+#'          ".font-size-lg {
+#'             font-size: 150%;
+#'          }"
 #'        )
 #'     ),
 #'     tags$main(
@@ -37,7 +39,7 @@
 #'      observeEvent(input$addCSS, {
 #'        browsertools::add_css(
 #'          elem = "#my-text-example",
-#'          css = "blue-text"
+#'          css = c("blue-text", "font-size-lg")
 #'        )
 #'      })
 #'   }

R/add_css.R

@@ -28,7 +28,7 @@
 #' }
 #' @references
 #'   \url{https://developer.mozilla.org/en-US/docs/Web/API/Console/error}
-#' @seealso [console_warn()], [console_log()], [console_table()], [alert()]
+#' @seealso [console_warn()], [console_log()], [console_table()]
 #' @keywords browsertools debugging console
 #' @return Sends an error message to the browser's console
 #' @export

R/alert.R

@@ -5,7 +5,6 @@
 #' displaying issues.
 #'
 #' @param message a message to display
-#' @param expand if TRUE arrays/objects will be auto expanded (default: FALSE)
 #'
 #' @examples
 #' if (interactive()) {
@@ -32,24 +31,20 @@
 #' @references
 #'   \url{https://developer.mozilla.org/en-US/docs/Web/API/Console/log}
 #'
-#' @seealso [console_error()], [console_table()], [console_warn()], [alert()]
+#' @seealso [console_error()], [console_table()], [console_warn()]
 #' @keywords browsertools debugging console
 #' @return Outputs an object to the browser's console
 #'
 #' @export
-console_log <- function(message, expand = FALSE) {
+console_log <- function(message) {
 
     # validate
     if (is.null(message)) stop("argument 'message' is undefined")
-    if (!is.logical(expand)) stop("argument 'expand' must be a logical value")
 
     # send
     session <- shiny::getDefaultReactiveDomain()
     session$sendCustomMessage(
         type = "console_log",
-        message= list(
-            message = message,
-            expand = expand
-        )
+        message = message
     )
 }

R/console_error.R

@@ -31,7 +31,7 @@
 #' @references
 #'   \url{https://developer.mozilla.org/en-US/docs/Web/API/Console/table}
 #'
-#' @seealso [as_js_object()], [console_log()], [alert()]
+#' @seealso [as_js_object()], [console_log()]
 #' @keywords browsertools debugging console
 #' @return Outputs an object to the browser's console
 #'

R/console_log.R

@@ -29,7 +29,7 @@
 #' @references
 #'      \url{https://developer.mozilla.org/en-US/docs/Web/API/Console/warn}
 #'
-#' @seealso [console_error()], [console_log()], [console_table()], [alert()]
+#' @seealso [console_error()], [console_log()], [console_table()]
 #' @keywords browsertools console warn
 #' @return Outputs a warning message to the console
 #'

R/console_table.R

@@ -49,6 +49,6 @@ enable_attributes <- function() {
     htmltools::tags$span(
         `data-browsertools-indexible` = "true",
         class = "browsertools-hidden browsertools-attributes",
-        `aria-hidden` = "true"
+        style = "display: none;"
     )
 }

R/console_warn.R

@@ -3,8 +3,7 @@
 #' Removes a css class(es) to an element using id or classname.
 #'
 #' @param elem the id or class name of an html element
-#' @param css a string containing the class(es) to remove from
-#'            an html element
+#' @param css a string or character array containing css classes
 #' @examples
 #' if (interactive()) {
 #'   library(shiny)

R/enable_attributes.R

@@ -3,7 +3,7 @@
 #' Toggles a css state of an html element
 #'
 #' @param elem the id or class name of an html element
-#' @param css a string containing the class to remove from an html element
+#' @param css a string or character array containing css classes
 #'
 #' @examples
 #' if (interactive()) {

R/remove_css.R

@@ -23,7 +23,7 @@
 use_browsertools <- function() {
     htmltools::htmlDependency(
         name = "browsertools",
-        version = "0.1.8",
+        version = "0.2.0",
         src = "browsertools/public/",
         package = "browsertools",
         script = "browsertools.min.js",

R/toggle_css.R

@@ -11,10 +11,10 @@ This package contains a series of functions for running JavaScript functions in
 
 ## Install
 
-You can install `browsertools` in R using the following command.
+You can install the latest release of `browsertools` in R using the following command.
 
 ```r
-devtools::install_github("davidruvolo51/browsertools")
+remotes::install_github("davidruvolo51/browsertools@*release")
 ```
 
 ## Use
@@ -33,36 +33,35 @@ The package offers the following functions.
 
 ### Shiny UI
 
-| function | arguments | description | 
-| :------- | :-------- | :---------- |
-| `use_browsertools` | --- | load `browsertools` dependencies into your shiny app (required).
-| `enable_attributes` | --- | allows you to access the HTML attributes of an element in the shiny server; Element must have an ID 
-| `hidden` | `...` | Hide element(s) by default
+| function            | arguments | description                                          |
+|---------------------|-----------|------------------------------------------------------|
+| `enable_attributes` | ---       | access HTML attributes of an element (`id` required) |
+| `hidden`            | `...`     | Hide element(s) by default                           |
+| `use_browsertools`  | ---       | load `browsertools` into your shiny app (required)   |
 
 ### Shiny Server
 
-| function  | arguments | description | 
-| :-------  | :-------- | :---------- |
-| `add_css` | `elem`, `css` | add a css class to an element
-| `alert` | `message` | displays an alert in the browser
-| `as_js_object` | `x` | a data.frame to convert to javascript object
-| `console_error` | `message` | send an error message to the console
-| `console_log` | `message`, `expand` | log values to the browser console
-| `console_table` | `data` | a json object to display in the console; use `as_js_object` function to convert your data before passing into the function
-| `console_warn` | `message` | send a warning message to the console
-| `debug` | --- | prints JavaScript errors in the R console
-| `hide_elem` | `elem` | hides an element
-| `insert_adjacent_html` | `id`, `html`, `position` | create a new child element(s) to a parent element
-| `inner_html` | `elem`, `string`, `delay` | change the inner html of an element
-| `inner_text` | `elem`, `string`, `delay` | change the inner text of an element
-| `print_elem` | `elem` | print an html element in the R console
-| `refresh_page` |  --- | trigger a page refresh (`history.go(0)`)
-| `remove_css` | `elem`, `css` | remove a css class from an element
-| `remove_element` | `elem` | remove an element from the DOM
-| `remove_element_attribute` | `elem`, `attr` | remove an attribute from an element
-| `set_document_title` | `title`, `append` | change the title of the document
-| `set_element_attribute` | `elem`, `attr`, `value` | update an attribute of an element
-| `scroll_to` | `x`, `y`, `elem` | scroll to a position in a page or element (default: `0, 0` = top of document)
-| `show_elem` | `elem` | show an element
-| `toggle_css` | `elem`, `css` | toggle a css class
-| `toggle_elem` | `elem` | toggle the state of an element (i.e., hide or show)
+| function                   | arguments                 | description                              |
+|----------------------------|---------------------------|------------------------------------------|
+| `add_css`                  | `elem`, `css`             | add css class(es)                        |
+| `as_js_object`             | `x`                       | convert an R object to javascript object |
+| `console_error`            | `message`                 | send an error message to the console     |
+| `console_log`              | `message`, `expand`       | log values to the browser console        |
+| `console_table`            | `data`                    | display R data in the console            |
+| `console_warn`             | `message`                 | send a warning message to the console    |
+| `debug`                    | ---                       | print JS errors in the R console         |
+| `hide_elem`                | `elem`                    | hides an element                         |
+| `inner_html`               | `elem`, `string`, `delay` | set the inner html of an element         |
+| `inner_text`               | `elem`, `string`, `delay` | set the inner text of an element         |
+| `insert_adjacent_html`     | `id`, `html`, `position`  | insert a new child element(s)            |
+| `print_elem`               | `elem`                    | print an html element in the R console   |
+| `refresh_page`             | ---                       | trigger a page refresh                   |
+| `remove_css`               | `elem`, `css`             | remove css class(es)                     |
+| `remove_element_attribute` | `elem`, `attr`            | remove an attribute from an element      |
+| `remove_element`           | `elem`                    | remove an element                        |
+| `scroll_to`                | `x`, `y`, `elem`          | scroll to a point or element             |
+| `set_document_title`       | `title`, `append`         | change the title of the document         |
+| `set_element_attribute`    | `elem`, `attr`, `value`   | update an attribute of an element        |
+| `show_elem`                | `elem`                    | show an element                          |
+| `toggle_css`               | `elem`, `css`             | toggle css class(es)                     |
+| `toggle_elem`              | `elem`                    | toggle the state of an element           |

R/use_browsertools.R

@@ -2,7 +2,7 @@
 // FILE: webpack.common.js
 // AUTHOR: David Ruvolo
 // CREATED: 2020-09-25
-// MODIFIED: 2020-09-25
+// MODIFIED: 2020-11-06
 // PURPOSE: configuration to be used in prod and dev
 // DEPENDENCIES: see below
 // STATUS: working
@@ -11,23 +11,23 @@
 
 // load
 const { CleanWebpackPlugin } = require("clean-webpack-plugin");
-const HtmlWebpackPlugin = require("html-webpack-plugin");
+// const HtmlWebpackPlugin = require("html-webpack-plugin");
 const webpack = require("webpack");
 const path = require("path");
 
 // configuration
 module.exports = {
-    entry: "./inst/browsertools/src/index.js",
+    entry: "./src/index.js",
     output: {
         filename: "browsertools.min.js",
         path: path.join(__dirname, "..", "inst/browsertools/public/"),
     }  ,
     plugins: [
         new webpack.ProgressPlugin(),
         new CleanWebpackPlugin(),
-        new HtmlWebpackPlugin({
-            title: "browsertools"
-        })
+        // new HtmlWebpackPlugin({
+        //     title: "browsertools"
+        // })
     ],
     module: {
         rules: [

README.md

@@ -15,7 +15,7 @@ library(shiny)
 # add resource path
 addResourcePath(
     "browsertools",
-    "~/Github/browsertools/inst/browsertools/public"
+    "~/Github/browsertools/inst/browsertools/public/"
 )
 
 # load package functions
@@ -73,7 +73,7 @@ ui <- tagList(
             tags$div(id = "square")
         )
     ),
-    tags$script(src = "browsertools/browsertools.min.js")
+    tags$script(src = "browsertools/public/browsertools.min.js")
 )