https://github.com/rstudio/miniUI

https://github.com/rstudio/miniUI

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/rstudio/miniUI
• Owner: rstudio
• Created: 2015-12-23T20:24:59.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2018-05-18T17:00:27.000Z (over 6 years ago)
• Last Synced: 2024-11-10T21:12:29.908Z (2 months ago)
• Language: R
• Size: 143 KB
• Stars: 107
• Watchers: 10
• Forks: 31
• Open Issues: 5
• 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](http://shiny.rstudio.com/articles/gadget-ui.html) article on [shiny.rstudio.com](http://shiny.rstudio.com/).

### Example

![Screenshot](tools/tabs.gif)

```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](http://www.gnu.org/licenses/gpl-3.0.en.html).

---

### Compiling [Less](http://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

```