Skip to content

Latest commit

 

History

History
60 lines (39 loc) · 2.01 KB

README.md

File metadata and controls

60 lines (39 loc) · 2.01 KB
Raw

shinyNextUI

R-CMD-check

The goal of {shinyNextUI} is to provide a wrapper around the NextUI React library.

The app corresponding to the above screenshot is located here.

Notes

{shinyNextUI} is currently in alpha. Please carefully look at the current issues.

The current roadmap:

  • Provide more aliases to match Shiny's vanilla notations like selectInput, ...
  • Refine the navbar template.
  • Allow to dynamically create themes.

{shinyNextUI} leverages tailwind css and some rules have already been pre-compiled to use in the various examples. If you need custom styles, you can use the {windy} package.

Installation

You can install the development version of {shinyNextUI} from GitHub with:

# install.packages("devtools")
devtools::install_github("RinteRface/shinyNextUI")

Example

To quickly get started with any example:

library(shinyNextUI)
# Get all examples
get_examples()
# Select an example and run the app
run_example("card")

Developer

{shinyNextUI} leverages tailwind for the CSS management and webpack as JS bundler and a mix between {shiny.react} and {reactR} for components and input management.

Within the js folder, run npm install. Then, for each change:

# Update CSS
npx tailwindcss -i ./src/input.css -o ./src/output.css --watch

# Change JS files
yarn webpack