Skip to content

lhokktyn/govuk-frontend

 
 

Repository files navigation

GOV.UK Frontend · Build Status JavaScript Style Guide

GOV.UK Frontend contains the code you need to start building a user interface for government platforms and services.

See live examples of GOV.UK Frontend components, and guidance on when to use them in your service, in the GOV.UK Design System.

Contact the team

GOV.UK Frontend is maintained by a team at Government Digital Service. If you want to know more about GOV.UK Frontend, please email the Design System team or get in touch with them on Slack.

Quick start

There are 2 ways to start using GOV.UK Frontend in your app.

Once installed, you will be able to use the code from the examples in the GOV.UK Design System in your service.

1. Install with npm (recommended)

We recommend installing GOV.UK Frontend using node package manager (npm).

2. Install using compiled files

You can also install GOV.UK Frontend by copying our CSS, JavaScript and asset files into your project.

Browser and assistive technology support

GOV.UK Frontend supports:

Accessibility

The GOV.UK Design System team works hard to ensure that GOV.UK Frontend is accessible.

Using Frontend will help your service meet level AA of WCAG 2.1. But you must still check that your service meets accessibility requirements, especially if you extend or modify components.

You should also use:

Your service will not meet level AA of WCAG 2.1 if you use compatibility mode to use GOV.UK Frontend with old frameworks or the old colour palette.

You can also read the accessibility statement for the GOV.UK Design System.

Accessibility warnings

If you get a warning from a linter or accessibility checker, check our list of issues you should not need to fix.

Getting updates

To be notified when there’s a new release, you can either:

Find out how to update with npm.

Licence

Unless stated otherwise, the codebase is released under the MIT License. This covers both the codebase and any sample code in the documentation. The documentation is © Crown copyright and available under the terms of the Open Government 3.0 licence.

Contribution guidelines

If you want to help us build GOV.UK Frontend, view our contribution guidelines.

About

GOV.UK Frontend contains the code you need to start building a user interface for government platforms and services.

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 50.3%
  • HTML 28.3%
  • SCSS 21.1%
  • Shell 0.3%