shinyGovstyle

Apply Gov styled components and formats in shiny

Overview

This package provides custom widgets to style R Shiny apps using the GOV.UK design system. The components can be previewed in our example showcase app.

To view details and advice on how to use the GOV.UK components please visit https://design-system.service.gov.uk/components/, most components should be available to use through this package.

Installation

You can install the latest stable version from CRAN

install.packages("shinyGovstyle")

If you want to make use of the development version then install directly from GitHub.

remotes::install_github("dfe-analytical-services/shinyGovstyle")

This is also available on conda

conda install r-shinygovstyle

To use error and word count elements you will need to load useShinyjs from shinyjs in your ui.R file

  shinyjs::useShinyjs()

Contributing

Ideas, bug reports, and requests for new components should be raised as GitHub issue. It’s often worth checking the existing issues log incase there is already an existing discussion you can conrtibute to.

More details on contributing can be found in the CONTRIBUTING.md file.

This package is also released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.

Available components

Details of all available components and how to use them can be found in the package documentation.

The package contains an example showcase app you can view or run yourself, showcasing available components. The code for the example app is in the inst/example_app/ folder. You can easily run the app from the console using:

shinyGovstyle::run_example()