React Design System

A collection of reusable React components following GOV.UK design patterns.

Table of Contents

* Installation
* Usage
* Development
* Build
* Playground

Installation

``bash
npm install @uktrade/react-component-library
`

Peer Dependencies:

* react >= 19
* react-dom >= 19

Usage

Import components from the package:

`tsx
import { SummaryList, SummaryItem } from "@uktrade/react-component-library";
`

You can use them directly in your React applications.

Development

$3

`bash
git clone https://github.com/uktrade/react-component-library.git
cd react-component-library
nvm use
npm ci
npm run build
`

Copies TypeScript output and .css files into dist/.

$3

`bash
npm run build
npm run docs:build
npm run docs:start
``

This opens a Vite dev server with the playground for testing components.