@ukic/react 3.0.0-alpha.1 → 3.0.0-alpha.11
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +8 -7
- package/dist/core/core.css +1607 -77
- package/dist/performance-tests/App.d.ts +3 -0
- package/dist/performance-tests/App.js +17 -0
- package/dist/performance-tests/index.d.ts +3 -0
- package/dist/performance-tests/index.js +9 -0
- package/dist/performance-tests/pages/IcButton/index.d.ts +3 -0
- package/dist/performance-tests/pages/IcButton/index.js +8 -0
- package/dist/performance-tests/pages/IcCheckbox/index.d.ts +3 -0
- package/dist/performance-tests/pages/IcCheckbox/index.js +15 -0
- package/dist/performance-tests/pages/MultipleIcButtons/index.d.ts +3 -0
- package/dist/performance-tests/pages/MultipleIcButtons/index.js +18 -0
- package/package.json +40 -17
package/README.md
CHANGED
|
@@ -2,6 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
[](https://github.com/mi6/ic-design-system/tree/main/LICENSE)
|
|
4
4
|
[](https://github.com/mi6/ic-design-system/tree/main/LICENSE)
|
|
5
|
+
[](https://npmjs.com/package/@ukic/react)
|
|
5
6
|
|
|
6
7
|
The [Intelligence Community Design System](https://design.sis.gov.uk) helps the United Kingdom's Intelligence Community (MI6, GCHQ, MI5, and partners) to quickly build powerful capabilities that are accessible and easy to use.
|
|
7
8
|
|
|
@@ -16,12 +17,12 @@ To install the components:
|
|
|
16
17
|
In the root of your project:
|
|
17
18
|
|
|
18
19
|
```shell
|
|
19
|
-
|
|
20
|
-
npm install @ukic/react @ukic/fonts
|
|
20
|
+
# using npm
|
|
21
|
+
npm install @ukic/react@next @ukic/fonts@next @ukic/web-components@next
|
|
21
22
|
|
|
22
|
-
|
|
23
|
+
# using yarn
|
|
23
24
|
rm package-lock.json
|
|
24
|
-
yarn add @ukic/react @ukic/fonts
|
|
25
|
+
yarn add @ukic/react@next @ukic/fonts@next @ukic/web-components@next
|
|
25
26
|
```
|
|
26
27
|
|
|
27
28
|
### Step two
|
|
@@ -43,7 +44,7 @@ Add the following into the top level CSS file for your project.
|
|
|
43
44
|
@import "@ukic/react/dist/core/core.css";
|
|
44
45
|
```
|
|
45
46
|
|
|
46
|
-
In order to be rendered consistently across browsers and in line with modern standards, each of the ICDS components uses styles from a global CSS file based on [Normalize.css](https://necolas.github.io/normalize.css/).
|
|
47
|
+
In order to be rendered consistently across browsers and in line with modern standards, each of the ICDS components uses styles from a global CSS file based on [Normalize.css](https://necolas.github.io/normalize.css/).
|
|
47
48
|
|
|
48
49
|
If you would like to import these styles to apply them to the rest of your project and slotted elements used within any of the ICDS components, add the following into the top level CSS file as well.
|
|
49
50
|
|
|
@@ -68,7 +69,7 @@ We have a couple of resources to help you with contributing.
|
|
|
68
69
|
|
|
69
70
|
## Changelog
|
|
70
71
|
|
|
71
|
-
For a comprehensive changelog of the React components, please read the web components [CHANGELOG](https://github.com/mi6/ic-ui-kit/blob/main/CHANGELOG.md). The released updates made to the web components are reflected on the React components.
|
|
72
|
+
For a comprehensive changelog of the React components, please read the web components [CHANGELOG](https://github.com/mi6/ic-ui-kit/blob/main/CHANGELOG.md). The released updates made to the web components are reflected on the React components.
|
|
72
73
|
|
|
73
74
|
## Security
|
|
74
75
|
|
|
@@ -88,4 +89,4 @@ Visit our websites to learn more about:
|
|
|
88
89
|
|
|
89
90
|
Unless stated otherwise, the codebase is released under the [MIT License](https://opensource.org/licenses/MIT). This covers both the codebase and any sample code in the documentation. The documentation is and available under the terms of the [Open Government License v3.0](https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/).
|
|
90
91
|
|
|
91
|
-
© Crown copyright 2022
|
|
92
|
+
© Crown copyright 2022
|