0.0.1 • Published 12 months ago

@benwatsonuk/fca-frontend v0.0.1

Weekly downloads
-
License
MIT
Repository
-
Last release
12 months ago

fca Frontend

Build Status

JavaScript Style Guide

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

It is built on top of the amazing GOV.UK Frontend System. The aim of the project is to follow conventions set out in GOV.UK Frontend and incorporate updates and releases in that project.

This documentation should be updated soon - at time of writing (v0.0.1) only basic files are present and are being used to validate a number of assumptions.

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

TBC

Quick start

The set-up process should mirror that of GOV.UK Frontend exactly: 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.

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

TBC