Icon Predefined
Installation
npm i @snack-uikit/icon-predefined
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.
Example
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"
/>
);
}
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 | Форма: круглая или квадратная |