# `@volvo-cars/react-icons`

React components for rendering Volvo Cars Design System icons, branded icons, icon buttons, and the Volvo Cars wordmark. Relies on `@volvo-cars/css` for styling via CSS masks and sprites.

## What's included

**Components**

- `Icon` — Renders a named Design System icon with configurable size and colour
- `BrandedIcon` — Renders a branded (product/feature) icon
- `IconButton` — An accessible button containing a single icon (with optional label for screen readers)
- `Wordmark` — Renders the "Volvo Cars" logotype wordmark

**Types**

- `IconName` — Union type of all valid icon names
- `BrandedIconName` — Union type of all valid branded icon names
- `IconColor` — Union type of supported icon colour values

**Configuration**

- `getIconSrc` — Returns the resolved URL for a given icon asset
- `setBaseUrl` — Configures the base URL for icon sprite assets (useful for custom CDN setups)

## Installation

```sh
yarn add @volvo-cars/react-icons
```

## Documentation

[Read the docs](https://developer.volvocars.com/design-system/web/?path=/docs/components-icon-icon--docs)