@ukic/react 3.0.0 → 3.2.0

package/README.md

@@ -2,6 +2,7 @@
 
 [![OGL V3 License](https://img.shields.io/badge/license-OGLv3-blue.svg)](https://github.com/mi6/ic-design-system/tree/main/LICENSE)
 [![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/mi6/ic-design-system/tree/main/LICENSE)
+[![npm](https://img.shields.io/npm/v/@ukic/react.svg)](https://npmjs.com/package/@ukic/react)
 
 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.
 
@@ -16,10 +17,10 @@ To install the components:
 In the root of your project:
 
 ```shell
-// using npm
+# using npm
 npm install @ukic/react @ukic/fonts
 
-// using yarn
+# using yarn
 rm package-lock.json
 yarn add @ukic/react @ukic/fonts
 ```
@@ -43,7 +44,7 @@ Add the following into the top level CSS file for your project.
 @import "@ukic/react/dist/core/core.css";
 ```
 
-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/). 
+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/).
 
 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.
 
@@ -57,6 +58,36 @@ The `@ukic/react` package will need to be transformed before you can use these c
 
 Add a `transformIgnorePatterns` field with the value `["/node_modules/(?!@ukic/react)"]` to your Jest config.
 
+## Typescript
+
+If your project is making use of Typescript, you can import the custom types used in the ICDS component library. For details on the types implemented in each component, refer to the Props table on the Code page for each Component on the [Design System Guidance site](https://design.sis.gov.uk/components/select/code)
+
+Types can be imported from the @ukic/web-components package as per the below example. 
+
+> [!NOTE]  
+> You do not have to install this package into your project, it is already installed as a dependency of @ukic/react. 
+
+```ts
+import { IcSelectTypes, IcMenuOption } from '@ukic/web-components';
+
+const selectType: IcSelectTypes = "single";
+
+const options: IcMenuOption[] = [
+  {
+    label: "Americano",
+    value: "ame",
+    description: "Classic black coffee",
+
+  },
+  {
+    label: "Latte",
+    value: "lat",
+    description: "This coffee has milk in, we know that much",
+    disabled: true
+  }
+];
+```
+
 ## Contributing
 
 We have a couple of resources to help you with contributing.
@@ -68,7 +99,7 @@ We have a couple of resources to help you with contributing.
 
 ## Changelog
 
-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. 
+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.
 
 ## Security
 
@@ -76,7 +107,7 @@ If you've found a vulnerability, we want to know so that we can fix it. [Our sec
 
 ## Questions about the departments
 
-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 😢.
+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.
 
 Visit our websites to learn more about:
 
@@ -88,4 +119,4 @@ Visit our websites to learn more about:
 
 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/).
 
-© Crown copyright 2022
+© Crown copyright 2022

package/dist/components.d.ts

@@ -46,6 +46,7 @@ export declare const IcSectionContainer: import("react").ForwardRefExoticCompone
 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>>;
 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>>;
 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>>;
+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>>;
 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>>;
 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>>;
 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>>;

package/dist/components.js

@@ -51,6 +51,7 @@ export var IcSectionContainer = /*@__PURE__*/ createReactComponent('ic-section-c
 export var IcSelect = /*@__PURE__*/ createReactComponent('ic-select');
 export var IcSideNavigation = /*@__PURE__*/ createReactComponent('ic-side-navigation');
 export var IcSkeleton = /*@__PURE__*/ createReactComponent('ic-skeleton');
+export var IcSkipLink = /*@__PURE__*/ createReactComponent('ic-skip-link');
 export var IcStatusTag = /*@__PURE__*/ createReactComponent('ic-status-tag');
 export var IcStep = /*@__PURE__*/ createReactComponent('ic-step');
 export var IcStepper = /*@__PURE__*/ createReactComponent('ic-stepper');