@sumup-oss/circuit-ui

A React component library designed to help developers build inclusive, performant, and trusted user interfaces.

Installation

Depending on your preference, run one of the following in your terminal:

# With npm
npm install --save @sumup-oss/circuit-ui
# With yarn v1
yarn add @sumup-oss/circuit-ui

@sumup-oss/circuit-ui has a number of required peer dependencies. If your project doesn't have them already, you can install them by running:

# With npm
npm install --save react react-dom @sumup-oss/design-tokens @sumup-oss/icons @sumup-oss/intl
# With yarn v1
yarn add react react-dom @sumup-oss/design-tokens @sumup-oss/icons @sumup-oss/intl

Usage

Here are a few helpful links for getting started with Circuit UI:

• Documentation - Learn how to use Circuit UI and view the components in Storybook.
• Getting started - Set up a new app with Circuit UI or add it to an existing project.
• Theming - Learn about our foundations such as colors, spacing, and typography.
• Contribute - File a bug report, suggest a change, or open a pull request.