@ukic/react 3.0.0 → 3.1.0

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 CHANGED
@@ -2,6 +2,7 @@
2
2
 
3
3
  [![OGL V3 License](https://img.shields.io/badge/license-OGLv3-blue.svg)](https://github.com/mi6/ic-design-system/tree/main/LICENSE)
4
4
  [![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/mi6/ic-design-system/tree/main/LICENSE)
5
+ [![npm](https://img.shields.io/npm/v/@ukic/react.svg)](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,10 +17,10 @@ To install the components:
16
17
  In the root of your project:
17
18
 
18
19
  ```shell
19
- // using npm
20
+ # using npm
20
21
  npm install @ukic/react @ukic/fonts
21
22
 
22
- // using yarn
23
+ # using yarn
23
24
  rm package-lock.json
24
25
  yarn add @ukic/react @ukic/fonts
25
26
  ```
@@ -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
 
@@ -76,7 +77,7 @@ If you've found a vulnerability, we want to know so that we can fix it. [Our sec
76
77
 
77
78
  ## Questions about the departments
78
79
 
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
+ 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
 
81
82
  Visit our websites to learn more about:
82
83
 
@@ -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
@@ -46,6 +46,7 @@ export declare const IcSectionContainer: import("react").ForwardRefExoticCompone
46
46
  export declare const IcSelect: import("react").ForwardRefExoticComponent<JSX.IcSelect & Omit<import("react").HTMLAttributes<HTMLIcSelectElement>, "style"> & import("./react-component-lib/interfaces").StyleReactProps & import("react").RefAttributes<HTMLIcSelectElement>>;
47
47
  export declare const IcSideNavigation: import("react").ForwardRefExoticComponent<JSX.IcSideNavigation & Omit<import("react").HTMLAttributes<HTMLIcSideNavigationElement>, "style"> & import("./react-component-lib/interfaces").StyleReactProps & import("react").RefAttributes<HTMLIcSideNavigationElement>>;
48
48
  export declare const IcSkeleton: import("react").ForwardRefExoticComponent<JSX.IcSkeleton & Omit<import("react").HTMLAttributes<HTMLIcSkeletonElement>, "style"> & import("./react-component-lib/interfaces").StyleReactProps & import("react").RefAttributes<HTMLIcSkeletonElement>>;
49
+ export declare const IcSkipLink: import("react").ForwardRefExoticComponent<JSX.IcSkipLink & Omit<import("react").HTMLAttributes<HTMLIcSkipLinkElement>, "style"> & import("./react-component-lib/interfaces").StyleReactProps & import("react").RefAttributes<HTMLIcSkipLinkElement>>;
49
50
  export declare const IcStatusTag: import("react").ForwardRefExoticComponent<JSX.IcStatusTag & Omit<import("react").HTMLAttributes<HTMLIcStatusTagElement>, "style"> & import("./react-component-lib/interfaces").StyleReactProps & import("react").RefAttributes<HTMLIcStatusTagElement>>;
50
51
  export declare const IcStep: import("react").ForwardRefExoticComponent<JSX.IcStep & Omit<import("react").HTMLAttributes<HTMLIcStepElement>, "style"> & import("./react-component-lib/interfaces").StyleReactProps & import("react").RefAttributes<HTMLIcStepElement>>;
51
52
  export declare const IcStepper: import("react").ForwardRefExoticComponent<JSX.IcStepper & Omit<import("react").HTMLAttributes<HTMLIcStepperElement>, "style"> & import("./react-component-lib/interfaces").StyleReactProps & import("react").RefAttributes<HTMLIcStepperElement>>;
@@ -51,6 +51,7 @@ export var IcSectionContainer = /*@__PURE__*/ createReactComponent('ic-section-c
51
51
  export var IcSelect = /*@__PURE__*/ createReactComponent('ic-select');
52
52
  export var IcSideNavigation = /*@__PURE__*/ createReactComponent('ic-side-navigation');
53
53
  export var IcSkeleton = /*@__PURE__*/ createReactComponent('ic-skeleton');
54
+ export var IcSkipLink = /*@__PURE__*/ createReactComponent('ic-skip-link');
54
55
  export var IcStatusTag = /*@__PURE__*/ createReactComponent('ic-status-tag');
55
56
  export var IcStep = /*@__PURE__*/ createReactComponent('ic-step');
56
57
  export var IcStepper = /*@__PURE__*/ createReactComponent('ic-stepper');