README.md
1# Crosstalk
2
3<!-- badges: start -->
4[](https://CRAN.R-project.org/package=crosstalk)
5[](https://github.com/rstudio/crosstalk/actions)
6<!-- badges: end -->
7
8Crosstalk is a package for R that enhances the [htmlwidgets](http://www.htmlwidgets.org) package. It extends htmlwidgets with a set of classes, functions, and conventions for implementing cross-widget interactions (currently, linked brushing and filtering).
9
10Find out more at the documentation website: http://rstudio.github.io/crosstalk/
11
12## Building JavaScript assets
13
14(This section is only for developers who intend to modify the JavaScript source code in Crosstalk itself.)
15
16The JavaScript source code in this package lives under `javascript/`, however the copy that is actually loaded and used during runtime is in minified form at `inst/www/js/`. Anytime you make changes to `javascript/` source files, you must rebuild the minified JS.
17
18To set up your repo for building the minified JS:
19
201. First install [nvm](https://github.com/nvm-sh/nvm) if you don't have it already.
212. In the crosstalk repo's root directory, run `nvm install`; this will install the version of Node.js we need.
223. Run `nvm use` to switch to our version of Node.js.
234. Run `npm install` to install all Node.js dependencies.
24
25To actually build the minified JS:
26
271. Run `nvm use` (only needed once per terminal session).
282. Run `node node_modules/.bin/grunt` (or if you have installed `grunt-cli` globally, you can just run `grunt`).
29
30This will run unit tests, lint, and build the JavaScript dist bundle. When making changes to the JavaScript code, you must always do this first, and then build the R package as normal.
31
){kind=link}