# @justeattakeaway/pie-icons-configs

> Shared config and utility functions for building pie-icons as importable components

Latest version **4.5.1** (published 2024-01-19) · 0 weekly downloads

## Install

```sh
npm install @justeattakeaway/pie-icons-configs
pnpm add @justeattakeaway/pie-icons-configs
yarn add @justeattakeaway/pie-icons-configs
bun add @justeattakeaway/pie-icons-configs
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 4.5.1 |
| Published | 2024-01-19 |
| First published | 2024-01-19 |
| Weekly downloads | 0 |
| TypeScript types | bundled |
| Module format | ESM |
| Dependencies | 0 |
| Unpacked size | 27.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | phatpt8, anastasiia.horban, mmakwe-onyeka, gregory.palaci, roberto.santana, siggerzz, lizzie.turney, jamieomaguire, davidpn.11, mwh1989, ashleynolan, fozzie-bot |

## Links

- npm: https://www.npmjs.com/package/@justeattakeaway/pie-icons-configs
- npm.io page: https://npm.io/package/@justeattakeaway/pie-icons-configs

## Recent versions

- 4.5.1 (latest) — 2024-01-19
- 0.0.0-snapshot-release-20240119141012 (snapshot-release) — 2024-01-19

## README

# pie-icons-configs

This package provides shared configurations and utility functions used to be the single source of truth for the icon packages' behavior (`pie-icons-react` and `pie-icons-vue`).

It helps to determine which classes are assigned to different component sizes and ensure consistent sizing according to the pre-determined shared rules.

`pie-icons-configs` is an internal package, therefore it's not intended for end-consumer usage.

## Usage

Install the package:

`yarn add --dev @justeattakeaway/pie-icons-configs`

Import the desired config or function from the common config file:

`import { sizeToValueMap } from '@justeattakeaway/pie-icons-configs'`

If you are using a framework, use the dedicated export for it, described below.

### React

`import { getReactSvgProps } from '@justeattakeaway/pie-icons-configs/configs-react'`

### Vue

`import { updateContextData } from '@justeattakeaway/pie-icons-configs/configs-vue'`


## API Reference

Check the JSDocs attached to each of the utility functions if you want to know more about them.

## Testing

The tests were added to ensure the utility functions behavior consistency.

You can run the tests with `yarn test --filter=pie-icons-configs`.


## Contributing

Before starting please read our [contributing guide](https://pie.design/engineers/contributing/)

---
_Source: https://npm.io/package/@justeattakeaway/pie-icons-configs · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
