README.md

NHS.UK React Components

NHS.UK Frontend ported to React

Coming from 0.x?

If you're coming from versions of the library prior to 1.0.0, please give this wiki page a brief read, as there a number of changes between 0.x release and the 1.0 release.

Installation

You can install this package using either yarn or npm.

npm install --save nhsuk-react-components@next
# Or
yarn add nhsuk-react-components@next

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>;
  }
}

Storybook

A storybook containing all of the components and their usage can be found here.

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) here.

• Thomas Judd-Cooper (GitHub)
• Sam Brown (GitHub)
• Luke Pearson (GitHub)