# @snack-uikit/icon-predefined

> `npm i @snack-uikit/icon-predefined`

Latest version **1.0.1** (published 2026-09-21) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install @snack-uikit/icon-predefined
pnpm add @snack-uikit/icon-predefined
yarn add @snack-uikit/icon-predefined
bun add @snack-uikit/icon-predefined
```

## Health

**Score 65/100 (B)** — status: active.

Positive: has types; esm support; no vulnerabilities; recently updated; high maintenance score.

Warnings: low downloads.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2026-09-21 |
| First published | 2023-12-05 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 2 |
| Unpacked size | 48.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Сергей Хлупин |
| Maintainers | yetihead, agrigorii, cloud-ru-tech |

## Links

- npm: https://www.npmjs.com/package/@snack-uikit/icon-predefined
- Repository: https://github.com/cloud-ru-tech/snack-uikit
- Homepage: https://github.com/cloud-ru-tech/snack-uikit/tree/master/packages/icon-predefined
- Issues: https://github.com/cloud-ru-tech/snack-uikit/issues
- npm.io page: https://npm.io/package/@snack-uikit/icon-predefined

## Dependencies (2)

- [classnames](https://npm.io/package/classnames.md) ^2.5.1
- [@snack-uikit/utils](https://npm.io/package/@snack-uikit/utils.md) ^5.0.0

## Recent versions

- 1.0.1 (latest) — 2026-09-21
- 1.0.1-preview-acb79d0b.0 (preview) — 2026-09-21
- 1.0.1-preview-b2e4ed46.0 — 2026-09-21
- 1.0.1-preview-27969f64.0 — 2026-09-21
- 1.0.1-preview-fe85442f.0 — 2026-09-18
- 0.7.13-preview-fc6b5b87.0 — 2026-08-20
- 0.7.12 — 2026-05-18
- 0.7.11 — 2026-01-19
- 0.7.10 — 2025-09-01
- 0.7.10-preview-2ce82c96.0 — 2025-09-01
- 0.7.10-preview-dbf3f886.0 — 2025-08-27
- 0.7.10-preview-af47d898.0 — 2025-08-27
- 0.7.10-preview-05f26bf6.0 — 2025-08-27
- 0.7.10-preview-23549ae9.0 — 2025-08-25
- 0.7.9 — 2025-07-16
- … 61 more at https://npm.io/package/@snack-uikit/icon-predefined/versions

## README

# Icon Predefined

## Installation
`npm i @snack-uikit/icon-predefined`

[Changelog](./CHANGELOG.md)

## Description

- Компонент `IconPredefined` оборачивает SVG-иконки из пакета `@snack-uikit/icons` и применяет к ним предустановленное стилевое оформление.
- Позволяет отображать иконки с единообразным внешним видом: задаёт цвет иконки через проп `appearance` (primary, neutral, red, orange, yellow, green, blue, violet, pink), размер через `size` (s, m, l) и форму контейнера через `shape` (round, square).
- Поддерживает опциональную цветную подложку (`decor`), которая создаёт визуальный акцент и улучшает читаемость иконки на фоне.
- Компонент автоматически передаёт необходимые атрибуты (размер, внешний вид) во вложенную иконку для корректного отображения.
- Figma: [`Icon Predefined`](https://www.figma.com/file/jtGxAPvFJOMir7V0eQFukN/Snack-UI-Kit-1.1.0?node-id=41%3A20598&mode=design).

## Example

```tsx
import { HeartSVG } from '@snack-uikit/icons';
import { IconPredefined } from '@snack-uikit/icon-predefined';

function Example() {
  return (
    <IconPredefined
      appearance="red"
      size="l"
      icon={HeartSVG}
      decor
      shape="round"
    />
  );
}
```

[//]: DOCUMENTATION_SECTION_START
[//]: THIS_SECTION_IS_AUTOGENERATED_PLEASE_DONT_EDIT_IT
## IconPredefined
### Props
| name | type | default value | description |
|------|------|---------------|-------------|
| icon* | `JSXElementConstructor<{ size?: number; className?: string; }>` | - | JSX иконки |
| className | `string` | - | CSS-класс |
| appearance | enum Appearance: `"primary"`, `"neutral"`, `"red"`, `"orange"`, `"yellow"`, `"green"`, `"blue"`, `"violet"`, `"pink"` | primary | Внешний вид |
| decor | `boolean` | true | Наличие цветной подложки |
| size | enum Size: `"s"`, `"m"`, `"l"` | m | Размер |
| shape | "round" \| "square" | round | Форма: круглая или квадратная |


[//]: DOCUMENTATION_SECTION_END

---
_Source: https://npm.io/package/@snack-uikit/icon-predefined · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._