https://github.com/feddelegrand7/Rnightly
An R Wrapper of the JavaScript Library Nightly
https://github.com/feddelegrand7/Rnightly
javascript rstats shiny
Last synced: 5 months ago
JSON representation
An R Wrapper of the JavaScript Library Nightly
- Host: GitHub
- URL: https://github.com/feddelegrand7/Rnightly
- Owner: feddelegrand7
- License: other
- Created: 2020-06-20T23:53:49.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2020-12-12T11:26:22.000Z (over 4 years ago)
- Last Synced: 2024-11-12T23:12:38.468Z (5 months ago)
- Topics: javascript, rstats, shiny
- Language: R
- Homepage:
- Size: 4.65 MB
- Stars: 22
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.Rmd
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-shiny-extensions - Rnightly - An R wrapper of the JavaScript library Nightly. (Theming / Theme Customization)
- jimsghstars - feddelegrand7/Rnightly - An R Wrapper of the JavaScript Library Nightly (R)
README
---
output: github_document
---```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```# Rnightly
[](https://cran.r-project.org/package=Rnightly)
[](https://cran.r-project.org/package=Rnightly)
[](https://cran.r-project.org/package=Rnightly)
[](https://cran.r-project.org/package=Rnightly)
[](https://choosealicense.com/licenses/mit/)
[](https://travis-ci.com/feddelegrand7/Rnightly)
[](https://github.com/feddelegrand7/Rnightly)
The goal of `Rnightly` is to implement a Dark/Light toggle mode in your Shiny and RMarkdown user interface. You can also change the default behavior by specifying other colors.
## Installation
You can install the `Rnightly` package from [CRAN](https://CRAN.R-project.org/package=Rnightly) with:
```{r, eval=FALSE}
install.packages("Rnightly")
```
You can install the development version of `Rnightly` from Github with :
```{r, eval=FALSE}
# install.packages("remotes")remotes::install_github("feddelegrand7/Rnightly")
```
The `Rnightly` package has two functions:
+ `use_nightly()`: set this function anywhere within your ui. It activates the [nightly](https://github.com/Fcmam5/nightly.js?utm_campaign=The%20Stash&utm_medium=email&utm_source=Revue%20newsletter) JavaScript library. The function must be run only once.
+ `nightly()`: activates the dark/light toggle mode. Look below for examples on how to use it.
## Examples
## 1.Shiny
Let's create a basic shiny app that demonstrates the features of `Rnightly`. Here the `trigElement` will determine which shiny element will trigger the Dark/Light mode. Note that it's the only mandatory argument:
```{r, eval=FALSE}
library(shiny)
library(Rnightly)ui <- fluidPage(
use_nightly(), # Activating nightlyjs
h3("Click on the button below to toggle between a Dark/Light mode"),
actionButton(inputId = "btn", label = "Button"),
nightly(trigElement = "btn") # Make sure to provide the same id)
server <- function(input, output){}
shinyApp(ui, server)
```
You can specify any Shiny element to toggle your Dark/Light mode, maybe a plot ?
```{r, eval=FALSE}
library(shiny)
library(Rnightly)ui <- fluidPage(
use_nightly(), # Activating nightlyjs
h3("Click on the Plot to toggle between a Dark/Light mode"),
plotOutput(outputId = "plt"),
nightly(trigElement = "plt"))
server <- function(input, output){
output$plt <- renderPlot({
plot(mtcars)
})
}shinyApp(ui, server)
```
Now the cool part. Instead of Dark, using the `bodyColor` argument you can change the color that will be displayed when toggling:
```{r, eval=FALSE}
library(shiny)
library(Rnightly)ui <- fluidPage(
use_nightly(),
h3("Click on the button below to toggle between a Purple/Light mode"),
actionButton(inputId = "btn", label = "Button"),
nightly(trigElement = "btn", bodyColor = "#6d6875")
)server <- function(input, output){}
shinyApp(ui, server)
```
You can also change the text color when toggling :
```{r, eval=FALSE}
library(shiny)
library(Rnightly)ui <- fluidPage(
use_nightly(),
h3("Click on the button below to toggle between a Purple/Light mode"),
actionButton(inputId = "btn", label = "Button"),
nightly(trigElement = "btn", bodyColor = "#6d6875", txtColor = "#fb5607")
)server <- function(input, output){}
shinyApp(ui, server)
```
Further, you can set the Shiny inputs' text color that will be displayed after toggling :
```{r, eval=FALSE}
library(shiny)
library(Rnightly)ui <- fluidPage(
use_nightly(),
h3("Click on the button below to toggle between a Purple/Light mode"),
actionButton(inputId = "btn", label = "Button"),
br(), br(), br(),
textInput(inputId = "txt1", label = "Type some text here"),
nightly(trigElement = "btn",
bodyColor = "#6d6875",
txtColor = "#fb5607",
inpTxtColor = "lightblue")
)server <- function(input, output){}
shinyApp(ui, server)
```
Finally, you can change the background color of Shiny inputs:
```{r, eval=FALSE}
library(shiny)
library(Rnightly)ui <- fluidPage(
use_nightly(),
h3("Click on the button below to toggle between a Purple/Light mode"),
actionButton(inputId = "btn", label = "Button"),
br(), br(), br(),
textInput(inputId = "txt1", label = "Type some text here"),
nightly(trigElement = "btn",
bodyColor = "#6d6875",
txtColor = "#fb5607",
inpTxtColor = "lightblue",
inpBgColor = "#f07167"))
server <- function(input, output){}
shinyApp(ui, server)
```
2. RMarkdown
Similarly, you can implement `Rnightly` in RMarkdown:
## Code of Conduct
Please note that the Rnightly project is released with a [Contributor Code of Conduct](https://contributor-covenant.org/version/2/0/CODE_OF_CONDUCT.html). By contributing to this project, you agree to abide by its terms.