https://github.com/devOpifex/windy
:cyclone: Tailwind for Shiny
https://github.com/devOpifex/windy
Last synced: about 2 months ago
JSON representation
:cyclone: Tailwind for Shiny
- Host: GitHub
- URL: https://github.com/devOpifex/windy
- Owner: devOpifex
- License: other
- Created: 2022-05-28T16:59:16.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2023-07-12T19:06:53.000Z (almost 2 years ago)
- Last Synced: 2024-11-13T17:45:52.444Z (7 months ago)
- Language: JavaScript
- Homepage:
- Size: 86.9 KB
- Stars: 38
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- jimsghstars - devOpifex/windy - :cyclone: Tailwind for Shiny (JavaScript)
- awesome-shiny-extensions - windy - Sets up basic scaffold to use Tailwind CSS within an R package for a Shiny application. (Frameworks / Scaffolding)
README
# windy
[Tailwindcss](https://tailwindcss.com/) for shiny.
Currently it sets up a basic scaffold to use tailwind
within an R package for a shiny application.
All of the heavy lifting is done by tailwind itself.
:heavy_check_mark: now works with R-built UI.
## Note
Tailwind is "a utility-first CSS framework packed with classes [...]",
all styling is done via classes.
This means there are no out-of-the-box compoenents that we can integrate here,
e.g.: no "navbar".
These will have to be built by yourself (they are much easier to build than you
may think).
The package may eventually provide helpers to design those.
## Installation
You can install the development version of windy from
[GitHub](https://github.com/) with:
``` r
# install.packages("remotes")
remotes::install_github("devOpifex/windy")
```
## Usage
1. Create a package
```r
usethis::create_package("mypkg")
```
2. Scaffold
```r
windy::scaffold()
```
3. Run
```r
windy::windy_build()
```
----
Change your CSS then run `windy_build()` to rebuild the output CSS,
or run `windy_watch()` to rebuild at every change.
# Example
You will find a very basic example at [devOpifex/windy.example](https://github.com/devOpifex/windy.example).