# @mark/icons

> Icon library for the Mark Design System

## Installation

```bash
# npm
npm install @mark/icons

# pnpm
pnpm add @mark/icons

# yarn
yarn add @mark/icons
```

## Usage

### Import All Icons

```javascript
import icons from '@mark/icons';
console.log(icons.cross); // Returns SVG path data
```

### Individual Icons

For better tree-shaking, import individual icons:

```javascript
import { cross, check, warning } from '@mark/icons';
```

## Available Icons

The library includes commonly used UI icons.

For a complete list of icons, see our [Storybook documentation](https://grade.design/?path=/docs/icons-all-icons--docs).

## Development

### Adding New Icons

1. Export SVG files from Figma using for example Frame Export plugin
2. Add SVG files to `src/svg/`
3. Run the build process:

```bash
turbo build
```

The build process:

- Optimizes SVGs using SVGO
- Converts SVGs to JavaScript objects
- Generates TypeScript types
- Updates exports

## Contributing

See our documentation in Figma for icon standards:

- Icon standards
- Optimization process
- Naming conventions
- Review process