You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+43-1Lines changed: 43 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,49 @@
2
2
3
3
Extensions to the NHS.UK React Components Library
4
4
5
-
### Storybook
5
+
## Usage
6
+
7
+
### Installation
8
+
9
+
The `nhsuk-react-components-extensions` package is published on NPM, and is installable via:
10
+
11
+
```bash
12
+
yarn add nhsuk-react-components-extensions
13
+
14
+
# Or
15
+
16
+
npm i --save nhsuk-react-components-extensions
17
+
```
18
+
19
+
### Importing Components
20
+
21
+
Components can either be imported from the global package or from the `/lib` directory. The package is tree-shakeable, so you should not see a sizeable difference between the import sizes using either method.
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`.
34
+
35
+
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.
36
+
37
+
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.
0 commit comments