https://github.com/nhsdigital/nhsuk-react-components-extensions
Additional components used through NHS Digital that don't fit in the standard NHS.UK Frontend kit
https://github.com/nhsdigital/nhsuk-react-components-extensions
Last synced: 9 months ago
JSON representation
Additional components used through NHS Digital that don't fit in the standard NHS.UK Frontend kit
- Host: GitHub
- URL: https://github.com/nhsdigital/nhsuk-react-components-extensions
- Owner: NHSDigital
- License: mit
- Created: 2020-02-28T16:04:08.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2025-01-14T10:26:25.000Z (about 1 year ago)
- Last Synced: 2025-03-26T08:37:30.452Z (10 months ago)
- Language: TypeScript
- Size: 63 MB
- Stars: 8
- Watchers: 5
- Forks: 9
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# NHS.UK React Components Extensions
Extensions to the NHS.UK React Components Library
## Usage
### Installation
The `nhsuk-react-components-extensions` package is published on NPM, and is installable via:
```bash
yarn add nhsuk-react-components-extensions
# Or
npm i --save nhsuk-react-components-extensions
```
### Importing Components
Components can either be imported from the global package or from the `/dist` directory. The package is tree-shakeable, so you should not see a sizeable difference between the import sizes using either method.
```jsx
// From the global package
import { SubNavigation } from 'nhsuk-react-components-extensions';
// From the dist directory
import SubNavigation from 'nhsuk-react-components/dist/src/components/sub-navigation';
```
### Styles
The package comes with two separate "master" stylesheets. These can be found at `~nhsuk-react-components-extensions/css/all.css` and `~nhsuk-react-components-extensions/css/components.css`.
If you are already using components from `nhsuk-frontend` or the `nhsuk-react-components` packages, it is strongly recommended to use the `components.css` file as this only contains the additional styles required to use the extra components in this library.
If you are not using any of those other packages, or the standard NHS.UK stylesheets, you will require the `all.css` file as this contains all of the core NHS.UK styles as well as the component styles.
```scss
// Core NHS.UK Styles and Components
@import '~nhsuk-react-components-extensions/css/all.css';
// Just Components
@import '~nhsuk-react-components-extensions/css/components.css';
```
## Storybook
A storybook containing all of the components and their usage can be found [here](https://nhsdigital.github.io/nhsuk-react-components-extensions).
## 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](mailto:thomas.judd-cooper1@nhs.net).
If you are thinking about raising a pull request, please read the [Contributing Guide](CONTRIBUTING.md).
- Thomas Judd-Cooper ([GitHub](https://github.com/tomdango))
- Luke Pearson ([GitHub](https://github.com/lukepearson))