[Canary]: The UK Intelligence Community Web Components 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/canary-web-components @ukic/fonts

using yarn

rm package-lock.json
yarn add @ukic/canary-web-components @ukic/fonts
`

$3

Import defineCustomElements in your file. Where you do this will depend on your framework or build tool, but the format is as follows:

`jsx
import { defineCustomElements } from "@ukic/canary-web-components/loader";
`

$3

Call defineCustomElements in your file. Again, the file you edit will depend on your framework or build tool, but the format is as follows:

`jsx
//other code
...
defineCustomElements();
`

$3

In your HTML, you can now declare a component as follows:

`jsx

`

$3

To get the correct styling with the ICDS components, import the core CSS file. Depending on your framework or build tool, this can be included in either a CSS file or Javascript\Typescript file.

Add the following into the top level CSS file for your project.

`css
@import "@ukic/fonts/dist/fonts.css";
/ Include @import "@ukic/web-components/dist/core/core.css if used alongside @ukic/web-components package /
@import "@ukic/canary-web-components/dist/core/core.css";
`

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/canary-web-components package as per the below example.

`ts
import { IcPaginationBarOptions } from '@ukic/canary-web-components';

let paginationConfig: IcPaginationBarOptions = {
itemsPerPageOptions: [
{ label: "5", value: "5" },
{ label: "10", value: "10" },
],
showItemsPerPageControl: true,
selectedItemsPerPage: 5,
}
`

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 in order 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/canary-web-components/dist/core/normalize.css";
`

Webpack example

Webpack is a tool for bundling web applications. This example assumes the following config in webpack.config.js. For more detailed information on Webpack configuration, please refer to the Webpack documentation.

`jsx
const path = require("path");

module.exports = {
entry: "./src/index.js",
output: {
filename: "main.js",
path: path.resolve(__dirname, "dist"),
},
devServer: {
static: "./dist",
},
mode: "development",
module: {
rules: [
{
test: /\.css$/i,
use: ["style-loader", "css-loader"],
},
],
},
};
`

$3

`shell
// using npm
npm install @ukic/canary-web-components @ukic/fonts

// using yarn
rm package-lock.json
yarn add @ukic/canary-web-components @ukic/fonts

`

$3

In the file defined as the entry in the webpack.config.js, add the following:

`jsx
//src/index.js
import "@ukic/fonts/dist/fonts.css";
import "@ukic/canary-web-components/dist/core/core.css";

import { defineCustomElements } from "@ukic/canary-web-components/loader";

defineCustomElements();
`

$3

You can now use any of the ICDS components so long as your HTML page includes the output file defined in your webpack.config.js. For example, including an ic-status-tag below:

`html











``

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.

$3

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.

Known Issues

At the time of writing, there is an issue with importing Stencil components into another Stencil component library for Unit tests.
The current workaround is to initially build and test the canary component within the web components directory and then move across when ready.

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