The UK Intelligence Community React UI Kit


The Intelligence Community Design System 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, working with GCHQ, MI5 and HMGCC (our national security partner).

Installing

To install the components:

$3

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
`

$3

Import the component(s) in your React files.

`jsx
import { IcComponent } from "@ukic/react";
`

$3

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";
`

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.

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.

`css
@import "@ukic/react/dist/core/normalize.css";
`

$3

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.

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

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.

- 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.
- Make sure to also read our coding standards and technical instructions.
- IC Design System guidance site repository contains the code and content for the Design System guidance site.
- IC UI Kit repository contains the code and content for the web components.

Changelog

For a comprehensive changelog of the React components, please read the web components CHANGELOG. 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 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).
- The Government Communications Headquarters (GCHQ).
- The Security Service (MI5).
- His Majesty's Government Communications Centre (HMGCC)- our national security partner.

License

Unless stated otherwise, the codebase is released under the MIT License. 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.

© Crown copyright 2022