https://github.com/rstudio/miniUI
https://github.com/rstudio/miniUI
Last synced: 23 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/rstudio/miniUI
- Owner: rstudio
- Created: 2015-12-23T20:24:59.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2025-04-17T22:05:33.000Z (about 1 month ago)
- Last Synced: 2025-04-25T19:35:45.305Z (about 1 month ago)
- Language: R
- Size: 150 KB
- Stars: 108
- Watchers: 9
- Forks: 31
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-shiny-extensions - miniUI - Widgets and layouts for Shiny apps working on small screens. Designed for creating Shiny Gadgets. (Theming / Mobile Theming)
- jimsghstars - rstudio/miniUI - (R)
README
# miniUI
Provides UI widget and layout functions for writing Shiny apps that work well on small screens. Designed to work especially well for creating Shiny Gadgets.
Inspired by the lovely [Ratchet](http://goratchet.com/) CSS framework, though currently miniUI doesn't use any of Ratchet's CSS code.
### Installing
```r
devtools::install_github("rstudio/miniUI")
```
### Getting started
Check out the [Designing Gadget UI](https://shiny.posit.co/articles/gadget-ui.html) article on [shiny.posit.co](https://shiny.posit.co/).
### Example
```r
ui <- miniPage(
gadgetTitleBar("Shiny gadget example"),
miniTabstripPanel(
miniTabPanel("Parameters", icon = icon("sliders"),
miniContentPanel(
sliderInput("year", "Year", 1978, 2010, c(2000, 2010), sep = "")
)
),
miniTabPanel("Visualize", icon = icon("area-chart"),
miniContentPanel(
plotOutput("cars", height = "100%")
)
),
miniTabPanel("Map", icon = icon("map-o"),
miniContentPanel(padding = 0,
leafletOutput("map", height = "100%")
),
miniButtonBlock(
actionButton("resetMap", "Reset")
)
),
miniTabPanel("Data", icon = icon("table"),
miniContentPanel(
DT::dataTableOutput("table")
)
)
)
)
```
Full source at: https://github.com/rstudio/miniUI/blob/master/examples/tabs.R
### License
The miniUI package is licensed under the [GPLv3](https://www.gnu.org/licenses/gpl-3.0.en.html).
---
### Compiling [Less](https://lesscss.org/) source to CSS
**You generally don't need to do this.** This build step is only needed if you want to contribute to the development of the package by modifying the built-in CSS styles.
#### One-time setup
**Prerequisite:** You must have Node.js installed.
```sh
# Install the grunt command if necessary
which grunt || sudo npm install -g grunt-cli
# Install dependencies
cd tools
npm install
```
#### Building
```sh
cd tools
grunt
```