GOV.UK Frontend ·

Warning

We’re currently implementing extensive changes to our code for our next major version.

While we're making changes, only fork this repository if necessary. This is to limit how often you will need to update your fork to keep up to date.

If you're fixing a bug in our previous releases, branch off the latest 4.x tag instead.

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:

• recommended browsers and Internet Explorer 11
• recommended assistive technologies
• Internet Explorer 8, 9 and 10, although components may not look perfect
• your users overriding colours in Windows, Firefox and Chrome

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:

• the JavaScript from GOV.UK Frontend
• a separate stylesheet if you support Internet Explorer 8

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:

• watch the govuk-frontend Github repository
• join the #govuk-design-system channel on cross-government Slack

Find out how to update with npm.

Security

GDS is an advocate of responsible vulnerability disclosure. If you’ve found a vulnerability, we would like to know so we can fix it.

For full details on how to tell us about vulnerabilities, see our security policy.

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.

Contributing

To learn how to help us build GOV.UK Frontend, see our contribution guidelines.

The govuk-frontend repository is public and we welcome contributions from anyone.

Contributors to alphagov repositories are expected to follow the Contributor Covenant Code of Conduct. Contributors working within government are also expected to follow the Civil Service code.

We're unable to monitor activity on this repository outside of our office hours (10am to 4pm, UK time). To get a faster response at other times, you can report abuse or spam to GitHub.