Skip to content

Commit c133880

Browse files
update readme to add discussion of inputs
1 parent 5d7fee7 commit c133880

File tree

2 files changed

+19
-15
lines changed

2 files changed

+19
-15
lines changed

README.Rmd

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ knitr::opts_chunk$set(
1919
[![Travis-CI Build Status](https://travis-ci.org/react-R/reactR.svg?branch=master)](https://travis-ci.org/react-R/reactR)
2020

2121

22-
`reactR` provides a set of convenience functions for using [`React`](https://facebook.github.io/react) in `R` with `htmlwidget` constructor templates and local JavaScript dependencies. The `React` ecosystem is rich with components that can enhance `R` web and Shiny apps. `scaffoldReactWidget()` helps build `htmlwidgets` to integrate these `React` components as `R` `htmlwidgets`. The local dependency functions are modeled after the `html_dependency_*` functions from RStudio's [`rmarkdown`](https://github.com/rstudio/rmarkdown) package.
22+
`reactR` provides a set of convenience functions for using [`React`](https://facebook.github.io/react) in `R` with `htmlwidget` constructor templates and local JavaScript dependencies. The `React` ecosystem is rich with components that can enhance `R` web and Shiny apps. `scaffoldReactWidget()` helps build `htmlwidgets` to integrate these `React` components as `R` `htmlwidgets`. `scaffoldReactShinyInput()` does the same for `Shiny` inputs. The local dependency functions are modeled after the `html_dependency_*` functions from RStudio's [`rmarkdown`](https://github.com/rstudio/rmarkdown) package.
2323

2424
## Installation
2525

@@ -34,12 +34,14 @@ devtools::install_github("react-R/reactR")
3434

3535
To wrap a `React` component as an `htmlwidget`, please see the tutorial [htmlwidgets with reactR](https://react-r.github.io/reactR/articles/intro_htmlwidgets.html). Also, there are a variety of examples in the [react-R Github organization](https://github.com/react-R).
3636

37-
## Shiny?
37+
## Shiny Outputs and Inputs
3838

39-
Currently, `htmlwidgets` built with `reactR` work well in Shiny as outputs. In the next version we hope to have a mechanism for input in Shiny contexts.
39+
`htmlwidgets` built with `reactR` work well in Shiny as outputs. In version `0.4.0` Alan Dipert has added the ability to easily create React-based official `Shiny` inputs with helpers and scaffolds. Please see the [tutorial](https://react-r.github.io/reactR/articles/intro_inputs.html) for more details.
4040

4141
## Examples
4242

43+
Below are examples of using `reactR` directly.
44+
4345
```R
4446
library(reactR)
4547
library(htmltools)

README.md

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6,16 +6,17 @@
66
[![CRAN\_Status\_Badge](https://www.r-pkg.org/badges/version/reactR)](https://cran.r-project.org/package=reactR)
77
[![Travis-CI Build
88
Status](https://travis-ci.org/react-R/reactR.svg?branch=master)](https://travis-ci.org/react-R/reactR)
9-
[![Slack Status](https://reactr-slackin.herokuapp.com/badge.svg)](https://reactr-slackin.herokuapp.com/)
109

1110
`reactR` provides a set of convenience functions for using
1211
[`React`](https://facebook.github.io/react) in `R` with `htmlwidget`
1312
constructor templates and local JavaScript dependencies. The `React`
1413
ecosystem is rich with components that can enhance `R` web and Shiny
1514
apps. `scaffoldReactWidget()` helps build `htmlwidgets` to integrate
16-
these `React` components as `R` `htmlwidgets`. The local dependency
17-
functions are modeled after the `html_dependency_*` functions from
18-
RStudio’s [`rmarkdown`](https://github.com/rstudio/rmarkdown) package.
15+
these `React` components as `R` `htmlwidgets`.
16+
`scaffoldReactShinyInput()` does the same for `Shiny` inputs. The local
17+
dependency functions are modeled after the `html_dependency_*` functions
18+
from RStudio’s [`rmarkdown`](https://github.com/rstudio/rmarkdown)
19+
package.
1920

2021
## Installation
2122

@@ -35,14 +36,19 @@ reactR](https://react-r.github.io/reactR/articles/intro_htmlwidgets.html).
3536
Also, there are a variety of examples in the [react-R Github
3637
organization](https://github.com/react-R).
3738

38-
## Shiny?
39+
## Shiny Outputs and Inputs
3940

40-
Currently, `htmlwidgets` built with `reactR` work well in Shiny as
41-
outputs. In the next version we hope to have a mechanism for input in
42-
Shiny contexts.
41+
`htmlwidgets` built with `reactR` work well in Shiny as outputs. In
42+
version `0.4.0` Alan Dipert has added the ability to easily create
43+
React-based official `Shiny` inputs with helpers and scaffolds. Please
44+
see the
45+
[tutorial](https://react-r.github.io/reactR/articles/intro_inputs.html)
46+
for more details.
4347

4448
## Examples
4549

50+
Below are examples of using `reactR` directly.
51+
4652
``` r
4753
library(reactR)
4854
library(htmltools)
@@ -93,7 +99,3 @@ We welcome contributors and would love your participation. Please note
9399
that this project is released with a [Contributor Code of
94100
Conduct](CONDUCT.md). By participating in this project you agree to
95101
abide by the terms.
96-
97-
## Community
98-
99-
We operate a [Slack](https://slack.com) workspace you are [more than welcome to join](http://reactr-slackin.herokuapp.com/).

0 commit comments

Comments
 (0)