open-index/open-npm huggingface dataset:
npm package: @sumup-oss/circuit-ui
Description: SumUp's React UI component library
Latest version: 10.16.0

<div align="center">

# @sumup-oss/circuit-ui

[![Stars](https://img.shields.io/github/stars/sumup-oss/circuit-ui?style=social)](https://github.com/sumup-oss/circuit-ui/) [![Version](https://img.shields.io/npm/v/@sumup-oss/circuit-ui)](https://www.npmjs.com/package/@sumup-oss/circuit-ui) [![Coverage](https://img.shields.io/codecov/c/github/sumup-oss/circuit-ui)](https://codecov.io/gh/sumup-oss/circuit-ui) [![License](https://img.shields.io/github/license/sumup-oss/circuit-ui)](https://github.com/sumup-oss/circuit-ui/tree/main/packages/circuit-ui/LICENSE) [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v2.1%20adopted-ff69b4.svg)](https://github.com/sumup-oss/circuit-ui/tree/main/CODE_OF_CONDUCT.md)

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

</div>

## Installation

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

```sh
# 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:

```sh
# 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](https://circuit.sumup.com/) - Learn how to use Circuit UI and view the components in Storybook.
- [Getting started](https://circuit.sumup.com/?path=/docs/introduction-getting-started--docs) - Set up a new app with Circuit UI or add it to an existing project.
- [Theming](https://circuit.sumup.com/?path=/docs/features-theme--docs) - Learn about our foundations such as colors, spacing, and typography.
- [Contribute](https://circuit.sumup.com/?path=/docs/contributing-overview--docs) - File a bug report, suggest a change, or open a pull request.
npm package: @sumup-oss/eslint-plugin-circuit-ui
Description: ESLint rules to lint Circuit UI.
Latest version: 6.1.0

<div align="center">

# @sumup-oss/eslint-plugin-circuit-ui

ESLint rules to help users follow best practices when using Circuit UI.

[![Stars](https://img.shields.io/github/stars/sumup-oss/circuit-ui?style=social)](https://github.com/sumup-oss/circuit-ui/) [![Version](https://img.shields.io/npm/v/@sumup-oss/eslint-plugin-circuit-ui)](https://www.npmjs.com/package/@sumup-oss/eslint-plugin-circuit-ui) [![Coverage](https://img.shields.io/codecov/c/github/sumup-oss/circuit-ui)](https://codecov.io/gh/sumup-oss/circuit-ui) [![License](https://img.shields.io/badge/license--lightgrey.svg)](https://github.com/sumup-oss/circuit-ui/tree/main/packages/eslint-plugin-circuit-ui/LICENSE) [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v2.1%20adopted-ff69b4.svg)](https://github.com/sumup-oss/circuit-ui/tree/main/CODE_OF_CONDUCT.md)

</div>

## Installation

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

```sh
# With npm
npm install --save-dev @sumup-oss/eslint-plugin-circuit-ui

# With yarn v1
yarn add --dev @sumup-oss/eslint-plugin-circuit-ui
```

## Usage

Add the plugin to your [ESLint configuration file](https://eslint.org/docs/latest/use/configure/configuration-files):

```json
{
  "plugins": ["@sumup-oss/circuit-ui"]
}
```

Rules are configured under the rules section:

```json
{
  "rules": {
    "@sumup-oss/circuit-ui/<rule-name>": "error"
  }
}
```

## Supported Rules

- [`component-lifecycle-imports`](https://github.com/sumup-oss/circuit-ui/tree/main/packages/eslint-plugin-circuit-ui/component-lifecycle-imports)
- [`no-invalid-custom-properties`](https://github.com/sumup-oss/circuit-ui/tree/main/packages/eslint-plugin-circuit-ui/no-invalid-custom-properties)
- [`no-deprecated-components`](https://github.com/sumup-oss/circuit-ui/tree/main/packages/eslint-plugin-circuit-ui/no-deprecated-components)
- [`no-deprecated-props`](https://github.com/sumup-oss/circuit-ui/tree/main/packages/eslint-plugin-circuit-ui/no-deprecated-props)
- [`no-renamed-props`](https://github.com/sumup-oss/circuit-ui/tree/main/packages/eslint-plugin-circuit-ui/no-renamed-props)
- [`prefer-custom-properties`](https://github.com/sumup-oss/circuit-ui/tree/main/packages/eslint-plugin-circuit-ui/prefer-custom-properties)
- [`renamed-organization-imports`](https://github.com/sumup-oss/circuit-ui/tree/main/packages/eslint-plugin-circuit-ui/renamed-organization-imports)
- [`no-renamed-components`](https://github.com/sumup-oss/circuit-ui/tree/main/packages/eslint-plugin-circuit-ui/no-renamed-components)
npm package: @sumup/circuit-ui
Description: SumUp's React UI component library
Latest version: 8.15.0
Deprecated: Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.

<div align="center">

# @sumup/circuit-ui

[![Stars](https://img.shields.io/github/stars/sumup-oss/circuit-ui?style=social)](https://github.com/sumup-oss/circuit-ui/) [![Version](https://img.shields.io/npm/v/@sumup/circuit-ui)](https://www.npmjs.com/package/@sumup/circuit-ui) [![Coverage](https://img.shields.io/codecov/c/github/sumup-oss/circuit-ui)](https://codecov.io/gh/sumup-oss/circuit-ui) [![License](https://img.shields.io/github/license/sumup-oss/circuit-ui)](https://github.com/sumup-oss/circuit-ui/tree/main/packages/circuit-ui/LICENSE) [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v2.1%20adopted-ff69b4.svg)](https://github.com/sumup-oss/circuit-ui/tree/main/CODE_OF_CONDUCT.md)

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

</div>

## Installation

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

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

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

```sh
# With npm
npm install --save react react-dom @emotion/react @emotion/styled @sumup/design-tokens @sumup/icons @sumup/intl @sumup/collector
# With yarn v1
yarn add react react-dom @emotion/react @emotion/styled @sumup/design-tokens @sumup/icons @sumup/intl @sumup/collector
```

## Usage

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

- [Documentation](https://circuit.sumup.com/) - Learn how to use Circuit UI and view the components in Storybook.
- [Getting started](https://circuit.sumup.com/?path=/docs/introduction-getting-started--docs) - Set up a new app with Circuit UI or add it to an existing project.
- [Theming](https://circuit.sumup.com/?path=/docs/features-theme--docs) - Learn about our foundations such as colors, spacing, and typography.
- [Contribute](https://circuit.sumup.com/?path=/docs/contributing-overview--docs) - File a bug report, suggest a change, or open a pull request.