@ukic/react 2.0.0-alpha.125 → 2.0.1

package/README.md

@@ -0,0 +1,83 @@
+# The UK Intelligence Community React UI Kit
+
+[![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)
+
+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.
+
+This is a joint project led by [MI6](https://www.sis.gov.uk), working with [GCHQ](https://www.gchq.gov.uk) and [MI5](https://www.mi5.gov.uk).
+
+## Installing
+
+To install the components:
+
+### Step one
+
+In the root of your project:
+
+```shell
+// using npm
+npm install @ukic/react @ukic/fonts
+
+// using yarn
+rm package-lock.json
+yarn add @ukic/react @ukic/fonts
+```
+
+### Step two
+
+Import the component(s) in your React files.
+
+```jsx
+import { IcComponent } from "@ukic/react";
+```
+
+### Step three
+
+To get the correct styling with the ICDS components, import the core CSS file.
+
+Add the following into the top level CSS file for your project.
+
+```css
+@import "@ukic/fonts/dist/fonts.css";
+@import "@ukic/react/dist/core/core.css";
+```
+
+### Step four
+
+The `@ukic/react` package will need to be transformed before you can use these components in Jest tests.
+
+Add a `transformIgnorePatterns` field with the value `["/node_modules/(?!@ukic/react)"]` to your Jest config.
+
+## Contributing
+
+We have a couple of resources to help you with contributing.
+
+- 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).
+- Make sure to also read our [coding standards and technical instructions](https://github.com/mi6/ic-ui-kit/blob/main/CONTRIBUTING.md).
+- [IC Design System guidance site repository](https://github.com/mi6/ic-design-system) contains the code and content for the Design System guidance site.
+- [IC UI Kit repository](https://github.com/mi6/ic-ui-kit) contains the code and content for the web components.
+
+## 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. 
+
+## Security
+
+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.
+
+## 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 😢.
+
+Visit our websites to learn more about:
+
+- The [Secret Intelligence Service (MI6)](https://www.sis.gov.uk).
+- The [Government Communications Headquarters (GCHQ)](https://www.gchq.gov.uk).
+- The [Security Service (MI5)](https://www.mi5.gov.uk).
+
+## License
+
+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

package/dist/components.d.ts

@@ -3,7 +3,7 @@ import type { JSX } from '@ukic/web-components';
 export declare const IcAlert: import("react").ForwardRefExoticComponent<JSX.IcAlert & Omit<import("react").HTMLAttributes<HTMLIcAlertElement>, "style"> & import("./react-component-lib/interfaces").StyleReactProps & import("react").RefAttributes<HTMLIcAlertElement>>;
 export declare const IcBackToTop: import("react").ForwardRefExoticComponent<JSX.IcBackToTop & Omit<import("react").HTMLAttributes<HTMLIcBackToTopElement>, "style"> & import("./react-component-lib/interfaces").StyleReactProps & import("react").RefAttributes<HTMLIcBackToTopElement>>;
 export declare const IcBreadcrumb: import("react").ForwardRefExoticComponent<JSX.IcBreadcrumb & Omit<import("react").HTMLAttributes<HTMLIcBreadcrumbElement>, "style"> & import("./react-component-lib/interfaces").StyleReactProps & import("react").RefAttributes<HTMLIcBreadcrumbElement>>;
-export declare const IcBreadcrumbs: import("react").ForwardRefExoticComponent<JSX.IcBreadcrumbs & Omit<import("react").HTMLAttributes<HTMLIcBreadcrumbsElement>, "style"> & import("./react-component-lib/interfaces").StyleReactProps & import("react").RefAttributes<HTMLIcBreadcrumbsElement>>;
+export declare const IcBreadcrumbGroup: import("react").ForwardRefExoticComponent<JSX.IcBreadcrumbGroup & Omit<import("react").HTMLAttributes<HTMLIcBreadcrumbGroupElement>, "style"> & import("./react-component-lib/interfaces").StyleReactProps & import("react").RefAttributes<HTMLIcBreadcrumbGroupElement>>;
 export declare const IcButton: import("react").ForwardRefExoticComponent<JSX.IcButton & Omit<import("react").HTMLAttributes<HTMLIcButtonElement>, "style"> & import("./react-component-lib/interfaces").StyleReactProps & import("react").RefAttributes<HTMLIcButtonElement>>;
 export declare const IcCard: import("react").ForwardRefExoticComponent<JSX.IcCard & Omit<import("react").HTMLAttributes<HTMLIcCardElement>, "style"> & import("./react-component-lib/interfaces").StyleReactProps & import("react").RefAttributes<HTMLIcCardElement>>;
 export declare const IcCheckbox: import("react").ForwardRefExoticComponent<JSX.IcCheckbox & Omit<import("react").HTMLAttributes<HTMLIcCheckboxElement>, "style"> & import("./react-component-lib/interfaces").StyleReactProps & import("react").RefAttributes<HTMLIcCheckboxElement>>;
@@ -41,7 +41,7 @@ export declare const IcStepper: import("react").ForwardRefExoticComponent<JSX.Ic
 export declare const IcSwitch: import("react").ForwardRefExoticComponent<JSX.IcSwitch & Omit<import("react").HTMLAttributes<HTMLIcSwitchElement>, "style"> & import("./react-component-lib/interfaces").StyleReactProps & import("react").RefAttributes<HTMLIcSwitchElement>>;
 export declare const IcTab: import("react").ForwardRefExoticComponent<JSX.IcTab & Omit<import("react").HTMLAttributes<HTMLIcTabElement>, "style"> & import("./react-component-lib/interfaces").StyleReactProps & import("react").RefAttributes<HTMLIcTabElement>>;
 export declare const IcTabContext: import("react").ForwardRefExoticComponent<JSX.IcTabContext & Omit<import("react").HTMLAttributes<HTMLIcTabContextElement>, "style"> & import("./react-component-lib/interfaces").StyleReactProps & import("react").RefAttributes<HTMLIcTabContextElement>>;
-export declare const IcTabList: import("react").ForwardRefExoticComponent<JSX.IcTabList & Omit<import("react").HTMLAttributes<HTMLIcTabListElement>, "style"> & import("./react-component-lib/interfaces").StyleReactProps & import("react").RefAttributes<HTMLIcTabListElement>>;
+export declare const IcTabGroup: import("react").ForwardRefExoticComponent<JSX.IcTabGroup & Omit<import("react").HTMLAttributes<HTMLIcTabGroupElement>, "style"> & import("./react-component-lib/interfaces").StyleReactProps & import("react").RefAttributes<HTMLIcTabGroupElement>>;
 export declare const IcTabPanel: import("react").ForwardRefExoticComponent<JSX.IcTabPanel & Omit<import("react").HTMLAttributes<HTMLIcTabPanelElement>, "style"> & import("./react-component-lib/interfaces").StyleReactProps & import("react").RefAttributes<HTMLIcTabPanelElement>>;
 export declare const IcTextField: import("react").ForwardRefExoticComponent<JSX.IcTextField & Omit<import("react").HTMLAttributes<HTMLIcTextFieldElement>, "style"> & import("./react-component-lib/interfaces").StyleReactProps & import("react").RefAttributes<HTMLIcTextFieldElement>>;
 export declare const IcTheme: import("react").ForwardRefExoticComponent<JSX.IcTheme & Omit<import("react").HTMLAttributes<HTMLIcThemeElement>, "style"> & import("./react-component-lib/interfaces").StyleReactProps & import("react").RefAttributes<HTMLIcThemeElement>>;

package/dist/components.js

@@ -7,7 +7,7 @@ defineCustomElements();
 export const IcAlert = /*@__PURE__*/ createReactComponent('ic-alert');
 export const IcBackToTop = /*@__PURE__*/ createReactComponent('ic-back-to-top');
 export const IcBreadcrumb = /*@__PURE__*/ createReactComponent('ic-breadcrumb');
-export const IcBreadcrumbs = /*@__PURE__*/ createReactComponent('ic-breadcrumbs');
+export const IcBreadcrumbGroup = /*@__PURE__*/ createReactComponent('ic-breadcrumb-group');
 export const IcButton = /*@__PURE__*/ createReactComponent('ic-button');
 export const IcCard = /*@__PURE__*/ createReactComponent('ic-card');
 export const IcCheckbox = /*@__PURE__*/ createReactComponent('ic-checkbox');
@@ -45,7 +45,7 @@ export const IcStepper = /*@__PURE__*/ createReactComponent('ic-stepper');
 export const IcSwitch = /*@__PURE__*/ createReactComponent('ic-switch');
 export const IcTab = /*@__PURE__*/ createReactComponent('ic-tab');
 export const IcTabContext = /*@__PURE__*/ createReactComponent('ic-tab-context');
-export const IcTabList = /*@__PURE__*/ createReactComponent('ic-tab-list');
+export const IcTabGroup = /*@__PURE__*/ createReactComponent('ic-tab-group');
 export const IcTabPanel = /*@__PURE__*/ createReactComponent('ic-tab-panel');
 export const IcTextField = /*@__PURE__*/ createReactComponent('ic-text-field');
 export const IcTheme = /*@__PURE__*/ createReactComponent('ic-theme');

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@ukic/react",
   "sideEffects": false,
-  "version": "2.0.0-alpha.125",
-  "description": "React components compiled using web components and StencilJS",
+  "version": "2.0.1",
+  "description": "React-wrapped web components compiled using StencilJS",
   "scripts": {
     "build": "npm run clean && npm run compile && npm run copy:css",
     "clean": "rm -rf dist",
@@ -21,8 +21,8 @@
     "dist/"
   ],
   "dependencies": {
-    "@ukic/fonts": "^2.0.0-alpha.120",
-    "@ukic/web-components": "^2.0.0-alpha.125"
+    "@ukic/fonts": "^2.0.1",
+    "@ukic/web-components": "^2.0.1"
   },
   "devDependencies": {
     "@babel/core": "^7.16.0",
@@ -60,5 +60,5 @@
       "dist"
     ]
   },
-  "gitHead": "dbf6985a251c4cd436ae536ec15b1df0292b1ea9"
+  "gitHead": "54da08aac4c570eecef01679f9dd1381c2ca3f7b"
 }