nhsuk/frontend-library

⚠️This repository has been deprecated. Please use https://github.com/nhsuk/nhsuk-frontend

DEPRECATED - Alpha frontend library

⚠️ This repository has been deprecated and is now read only. Please use https://github.com/nhsuk/nhsuk-frontend

Version 2 of the frontend library, application non-specific.

This repo has two main purposes:

• Generate shareable css and js assets for use by others
• Provide a development environment for reviewing changes to those assets

In order to achieve these objectives the repo is built on Brunch. Additional information about the decision to use Brunch can be found in the ADR record.

The demo site is available as a GitHub Pages site https://nhsuk.github.io/frontend-library/. The site is updated automatically by Travis CI via GitHub Pages Deployment. The deployment happens when a change is made to master. master is a protected branch and changes are only able to be applied via a reviewed Pull Request. The deployment to the GitHub Pages site uploads all artefacts in ./public to the gh-pages branch. This is configured in .travis.yml.

Installation

• Clone the repo: git clone https://github.com/nhsuk/frontend-library.git
• Install dependencies: cd frontend-library && ./scripts/bootstrap

Usage

• Start the server in development mode: ./scripts/start
• View the site in a browser: open http://localhost:3333

Using the scss directly

If you would prefer to use the raw scss rather than the compiled css and build it within your own application there are a couple of ways of doing this.

1. Include this repo within your own as a submodule and add the path to the scss files to the includePaths option for your sass compiler.
2. Download the raw scss assets for this repo, from the releases in GitHub. The folder to download is sccs-<release_number>.zip

NHS icons

There are three NHS Icons available

Architecture Decision Records

This repo uses Architecture Decision Records to record architectural decisions for this project. They are stored in doc/adr.

Contributing

Please see contributing.md if you wish to contribute to the library.

frontend-library's Issues

test

• Operating system e.g. Windows 10
• Browser and version e.g. Google Chrome 59.0.3071.109

What did you expect to see?

What did you see?

What steps are required to reproduce the issue?

If possible, include all steps required to recreate the issue whilst using an incognito/private browsing window.
This will help to rule out any differences introduced via user installed extensions.

An in-range update of eslint-plugin-import is breaking the build 🚨

The devDependency eslint-plugin-import was updated from 2.17.2 to 2.17.3.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

eslint-plugin-import is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Status Details

• ❌ continuous-integration/travis-ci/push: The Travis CI build could not complete due to an error (Details).

---

Commits

The new version differs by 25 commits.

• cf5573b Bump to v2.17.3
• caae65c [Tests] eslint 2 does not have linter.version
• 557a3e2 [Deps] update resolve
• 17beb33 Merge pull request #1356 from christophercurrie/typescript-declare
• c8ac7ff [Docs] Document env option for eslint-import-resolver-webpack
• c09c0ce Issue #1258 (docs)
• 753c9db [refactor] fix eslint 6 compat by fixing imports
• b52bf3e PR feedback
• 7aa13d1 PR feedback
• f66e064 Remove log messages
• d1e4455 Verbose variable names
• 67b1e95 Support older typescript parsers
• 288cedf Make groups non-capturing.
• aa290bb Improve support for Typescript declare structures
• 1edbbd0 [Fix] no-common-js: Also throw an error when assigning

There are 25 commits in total.

See the full diff

FAQ and help

There is a collection of frequently asked questions. If those don’t help, you can always ask the humans behind Greenkeeper.

---

Your Greenkeeper Bot 🌴

Update eslint to version 4

Remove the ignore for greenkeeper from within package.json too.

That we are using the BEM styling convention is not documented

That we have decided to use the BEM styling convention when introducing new features has not been documented. It should be mentioned in the CONTRIBUTING.md document.

Update eslint-plugin-jsx-a11y to version 6

Remove the ignore for greenkeeper from within package.json too.

404 error when clicking on link in CONTRIBUTING.md

What is the issue?

Clicking on the link to the PULL_REQUEST_TEMPLATE in the Getting Started section on https://github.com/nhsuk/frontend-library/blob/master/CONTRIBUTING.md results in a 404

What did you expect to happen?

I expected it to open the PULL_REQUEST_TEMPLATE at https://github.com/nhsuk/frontend-library/blob/master/.github/PULL_REQUEST_TEMPLATE.md

What did actually happen?

I got a 404 error

What steps are required to reproduce the issue?

Go to https://github.com/nhsuk/frontend-library/blob/master/CONTRIBUTING.md
Click on the link to the PULL_REQUEST_TEMPLATE in the Getting Started section
results in a 404

## What was the environment where this issue occurred?

• Device: Windows Surface Pro 4
• Operating System: Windows 10
• Browser: Google Chrome
• Browser version: 62.0.3202.94 (Official Build) (64-bit)

Is there anything else you think would be useful in recreating the issue?