ministryofjustice / moj-frontend

Use the MoJ Design System to design, build, and deliver accessible and consistent services.
https://design-patterns.service.justice.gov.uk/
MIT License
33 stars 20 forks source link
design-system ministry-of-justice moj-design-system pattern-library

semantic-release Commitizen friendly NPM License

GitHub Workflow Status NPM Downloads NPM Downloads

Ministry of Justice Frontend

MOJ Frontend contains the code you need to start building user interfaces for UK Ministry of Justice government services.

See live examples of MOJ Frontend components, and guidance on when to use them in your service, in the MOJ Pattern Library documentation.

Contribution Guidelines

If you want to help us build MOJ Frontend, view our contribution guidelines. This covers all areas from semvar commit messages to release process.

Contact the team

MOJ Frontend is maintained by staff in the Ministry of Justice. If you need support, you can use GitHub discussions or one of our Slack channels:

Quick start

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

Once installed, you will be able to use the code from the examples in the MOJ Pattern Library in your service.

Browser support

MOJ Frontend will allow you to build services that comply with the guidance in the Service Manual.

MOJ Frontend no longer supports Internet Explorer 8. If you need IE8 support, then you must use an old version or provide your own support.

Assistive technology support

MOJ Frontend will allow you to build services that comply with the guidance in the Service Manual.

In addition, we test that all content is accessible with keyboard only.

We aim to support [users who adjust or override the colours of websites they visit][how-users-change-colours-on-websites]. We test this by [changing colours in Firefox][changing-colours-in-firefox], by [enabling 'High Contrast' mode in Windows][enabling-high-contrast-mode-in-windows] and by using the High Contrast plugin for Chrome.

[changing-colours-in-firefox]: https://support.mozilla.org/en-US/kb/change-fonts-and-colors-websites-use

[enabling-high-contrast-mode-in-windows]: https://support.microsoft.com/en-gb/help/13862/windows-use-high-contrast-mode

[how-users-change-colours-on-websites]: https://accessibility.blog.gov.uk/2017/03/27/how-users-change-colours-on-websites/

Further reading