nhsuk-react-components
v5.0.0
Published
This repository contains the code for NHS.UK React components - a port of the [NHS.UK Frontend components](https://github.com/nhsuk/nhsuk-frontend).
Downloads
17,764
Keywords
Readme
NHS.UK React components
This repository contains the code for NHS.UK React components - a port of the NHS.UK Frontend components.
Documentation and examples
View documentation and examples
Installation
You can install this package using either yarn
or npm
.
npm install --save nhsuk-react-components
# Or
yarn add nhsuk-react-components
Usage
import React, { PureComponent } from 'react';
// You can import components from the global module
import { Button } from 'nhsuk-react-components';
// Or you can import components directly
import Button from 'nhsuk-react-components/lib/components/button';
class GetStartedButton extends PureComponent {
render() {
return <Button>Click Me!</Button>;
}
}
Upgrading
Maintainers
We’re currently looking for new maintainers If you have knowledge of React and would be willing to help maintain this library, you can email me (Thomas Judd-Cooper).
- Thomas Judd-Cooper (GitHub)
- Sam Brown (GitHub)
- Luke Pearson (GitHub)
- Kevin Kuszyk (GitHub)
- Kai Spencer (GitHub)
- Ed Horsford (GitHub)
Preparing releases
Releases run in CI using github actions.
To prepare a release create a new release TAG in github with your release version.
NPM_TOKEN
should be stored in the repositories secrets in GitHub
- Create a new release with a tag like
major.minor.patch
against main. - If the change is a
beta
then selectpre-release
as true, this will make thetag
point atbeta
. Otherwise the tag will belatest
.
Thanks
Thanks to Chromatic for providing the visual testing platform that helps us review UI changes and catch visual regressions.