@snack-uikit/icon-predefined

Icon Predefined

Installation

npm i @snack-uikit/icon-predefined

Changelog

Example

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

<IconPredefined
    appearance={IconPredefined.appearances.Red}
    size={IconPredefined.sizes.L}
    className='className'
    icon={HeartSVG}
    decor
/>

Props

icon: JSXElementConstructor

Компонент svg-иконки из пакета @snack-uikit/icons.

className?: string

css-класс контейнера.

appearance?: Appearance - [Appearance.Primary]

Цвет иконки. Возможные варианты:

• IconPredefined.appearances.Primary
• IconPredefined.appearances.Neutral
• IconPredefined.appearances.Red
• IconPredefined.appearances.Orange
• IconPredefined.appearances.Yellow
• IconPredefined.appearances.Green
• IconPredefined.appearances.Blue
• IconPredefined.appearances.Violet
• IconPredefined.appearances.Pink

size?: Size - [Size.S]

Размер компонента. Возможные варианты:

• IconPredefined.sizes.S
• IconPredefined.sizes.M
• IconPredefined.sizes.L

decor?: boolean - [true]

Включает цветную подложку для иконки.

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"	Appearance.Primary	Внешний вид
decor	boolean	true	Наличие цветной подложки
size	enum Size: "s", "m", "l"	Size.M	Размер