@ukic/canary-react 2.0.0-canary.1 → 2.0.0-canary.3
Sign up to get free protection for your applications and to get access to all the features.
- package/README.md +8 -31
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# The UK Intelligence Community React UI Kit
|
|
1
|
+
# [Canary]: The UK Intelligence Community React UI Kit
|
|
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)
|
|
@@ -17,11 +17,11 @@ In the root of your project:
|
|
|
17
17
|
|
|
18
18
|
```shell
|
|
19
19
|
// using npm
|
|
20
|
-
npm install @ukic/react @ukic/fonts
|
|
20
|
+
npm install @ukic/canary-react @ukic/fonts
|
|
21
21
|
|
|
22
22
|
// using yarn
|
|
23
23
|
rm package-lock.json
|
|
24
|
-
yarn add @ukic/react @ukic/fonts
|
|
24
|
+
yarn add @ukic/canary-react @ukic/fonts
|
|
25
25
|
```
|
|
26
26
|
|
|
27
27
|
### Step two
|
|
@@ -29,7 +29,7 @@ yarn add @ukic/react @ukic/fonts
|
|
|
29
29
|
Import the component(s) in your React files.
|
|
30
30
|
|
|
31
31
|
```jsx
|
|
32
|
-
import { IcComponent } from "@ukic/react";
|
|
32
|
+
import { IcComponent } from "@ukic/canary-react";
|
|
33
33
|
```
|
|
34
34
|
|
|
35
35
|
### Step three
|
|
@@ -40,7 +40,7 @@ Add the following into the top level CSS file for your project.
|
|
|
40
40
|
|
|
41
41
|
```css
|
|
42
42
|
@import "@ukic/fonts/dist/fonts.css";
|
|
43
|
-
@import "@ukic/react/dist/core/core.css";
|
|
43
|
+
@import "@ukic/canary-react/dist/core/core.css";
|
|
44
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/).
|
|
@@ -48,42 +48,19 @@ In order to be rendered consistently across browsers and in line with modern sta
|
|
|
48
48
|
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
49
|
|
|
50
50
|
```css
|
|
51
|
-
@import "@ukic/react/dist/core/normalize.css";
|
|
51
|
+
@import "@ukic/canary-react/dist/core/normalize.css";
|
|
52
52
|
```
|
|
53
53
|
|
|
54
54
|
### Step four
|
|
55
55
|
|
|
56
|
-
The `@ukic/react` package will need to be transformed before you can use these components in Jest tests.
|
|
56
|
+
The `@ukic/canary-react` package will need to be transformed before you can use these components in Jest tests.
|
|
57
57
|
|
|
58
|
-
Add a `transformIgnorePatterns` field with the value `["/node_modules/(?!@ukic/react)"]` to your Jest config.
|
|
59
|
-
|
|
60
|
-
## Contributing
|
|
61
|
-
|
|
62
|
-
We have a couple of resources to help you with contributing.
|
|
63
|
-
|
|
64
|
-
- To find out more about the different types of contributions, the criteria, raising issues or our release roadmap, read [how to contribute to the Design System and UI Kit](https://design.sis.gov.uk/community/contribute).
|
|
65
|
-
- Make sure to also read our [coding standards and technical instructions](https://github.com/mi6/ic-ui-kit/blob/main/CONTRIBUTING.md).
|
|
66
|
-
- [IC Design System guidance site repository](https://github.com/mi6/ic-design-system) contains the code and content for the Design System guidance site.
|
|
67
|
-
- [IC UI Kit repository](https://github.com/mi6/ic-ui-kit) contains the code and content for the web components.
|
|
68
|
-
|
|
69
|
-
## Changelog
|
|
70
|
-
|
|
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.
|
|
58
|
+
Add a `transformIgnorePatterns` field with the value `["/node_modules/(?!@ukic/canary-react)"]` to your Jest config.
|
|
72
59
|
|
|
73
60
|
## Security
|
|
74
61
|
|
|
75
62
|
If you've found a vulnerability, we want to know so that we can fix it. [Our security policy](https://github.com/mi6/ic-ui-kit/blob/main/SECURITY.md) tells you how to do this.
|
|
76
63
|
|
|
77
|
-
## Questions about the departments
|
|
78
|
-
|
|
79
|
-
The team is only able to talk about the projects we've put on GitHub 🕵️. We unfortunately can't talk about the work of our departments 😢.
|
|
80
|
-
|
|
81
|
-
Visit our websites to learn more about:
|
|
82
|
-
|
|
83
|
-
- The [Secret Intelligence Service (MI6)](https://www.sis.gov.uk).
|
|
84
|
-
- The [Government Communications Headquarters (GCHQ)](https://www.gchq.gov.uk).
|
|
85
|
-
- The [Security Service (MI5)](https://www.mi5.gov.uk).
|
|
86
|
-
|
|
87
64
|
## License
|
|
88
65
|
|
|
89
66
|
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/).
|
package/package.json
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
"sideEffects": [
|
|
4
4
|
"*.css"
|
|
5
5
|
],
|
|
6
|
-
"version": "2.0.0-canary.
|
|
6
|
+
"version": "2.0.0-canary.3",
|
|
7
7
|
"description": "React-wrapped web components compiled using StencilJS",
|
|
8
8
|
"scripts": {
|
|
9
9
|
"build": "npm run clean && npm run compile && npm run copy:core-css && npm run copy:normalize-css",
|
|
@@ -24,7 +24,7 @@
|
|
|
24
24
|
"dist/"
|
|
25
25
|
],
|
|
26
26
|
"dependencies": {
|
|
27
|
-
"@ukic/canary-web-components": "^2.0.0-canary.
|
|
27
|
+
"@ukic/canary-web-components": "^2.0.0-canary.3",
|
|
28
28
|
"@ukic/fonts": "^2.3.0"
|
|
29
29
|
},
|
|
30
30
|
"devDependencies": {
|
|
@@ -72,5 +72,5 @@
|
|
|
72
72
|
]
|
|
73
73
|
},
|
|
74
74
|
"license": "MIT",
|
|
75
|
-
"gitHead": "
|
|
75
|
+
"gitHead": "7b5b2b9ab729be5ec1ebee35a87ab20cf4ac09ba"
|
|
76
76
|
}
|