@skbkontur/icons 2.0.0-beta.21 → 2.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +48 -0
- package/package.json +2 -2
- package/src/types.d.ts +0 -1
package/README.md
ADDED
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
# Библиотека иконок
|
|
2
|
+
|
|
3
|
+
[<img src="https://tech.skbkontur.ru/kontur-ui/favicon.svg" alt="" height="16" /> Шоу-Кейс](https://guides.kontur.ru/re/sources/icons/)
|
|
4
|
+
[<img src="https://static.figma.com/app/icon/1/favicon.svg" alt="" height="16" /> Figma](https://www.figma.com/design/69XYlhg5sQ5i7by1lhzXmP/%E2%9A%A1-Kontur-Icons?node-id=1176-24002&p=f&t=Nlj2vZPZRow4CrXi-0)
|
|
5
|
+
|
|
6
|
+
## ESM-only
|
|
7
|
+
|
|
8
|
+
Начиная с версии 2.0 пакет поставляется только в ESM формате.
|
|
9
|
+
Если у вас возникают сложности, то попробуйте пакет [@skbkontur/ui-cdn-components](https://git.skbkontur.ru/ui/ui-cdn-components). Он имеет dual-build, но грузит иконки с сервера статики.
|
|
10
|
+
|
|
11
|
+
## Установка
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
npm i @skbkontur/icons
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
## Библиотека предоставляет гранулярные иконки
|
|
18
|
+
|
|
19
|
+
Гранулярные иконки (`IconCheckLight16`,`IconXRegular20`) содержат одно конретное начертание, как в макете Фигмы.
|
|
20
|
+
|
|
21
|
+
## Импорт
|
|
22
|
+
|
|
23
|
+
```ts
|
|
24
|
+
import { IconCheckARegular16 } from '@skbkontur/icons/IconCheckARegular16';
|
|
25
|
+
import { IconMathDeltaRegular20 } from '@skbkontur/icons/IconMathDeltaRegular20';
|
|
26
|
+
import { IconMathDeltaLight20 } from '@skbkontur/icons/IconMathDeltaLight20';
|
|
27
|
+
import { IconArchiveBoxSolid24 } from '@skbkontur/icons/IconArchiveBoxSolid24';
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
Из корня можно импортировать некоторые типы:
|
|
31
|
+
|
|
32
|
+
```ts
|
|
33
|
+
import {
|
|
34
|
+
IconSize, // 16 | 20 | 24 | 32 | 64
|
|
35
|
+
IconWeight, // "light" | "regular" | "solid"
|
|
36
|
+
IconComponent, // React.FunctionComponent<IconProps>
|
|
37
|
+
IconProps, // См. ниже
|
|
38
|
+
} from '@skbkontur/icons';
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
|
|
42
|
+
## Пропсы
|
|
43
|
+
|
|
44
|
+
| Name | Description | Default |
|
|
45
|
+
|---------|------------------------------------------------------------------------------------------------------------------------------|---------------------------|
|
|
46
|
+
| `size` | Масштабирование начертания | |
|
|
47
|
+
| `color` | Цвет иконки | Наследуется цвет родителя |
|
|
48
|
+
| `align` | Выравнивание иконки:<br/>`"baseline"` — по базовой линии<br/>`"center"` — по центру контента<br/>`"none"` — без выравнивания | `"center"` |
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@skbkontur/icons",
|
|
3
|
-
"version": "2.0.
|
|
3
|
+
"version": "2.0.1",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"license": "UNLICENSED",
|
|
6
6
|
"files": [
|
|
@@ -5916,4 +5916,4 @@
|
|
|
5916
5916
|
"./IconXSquareSolid32": "./IconXSquareSolid32.js",
|
|
5917
5917
|
"./IconXSquareSolid64": "./IconXSquareSolid64.js"
|
|
5918
5918
|
}
|
|
5919
|
-
}
|
|
5919
|
+
}
|
package/src/types.d.ts
CHANGED
|
@@ -3,7 +3,6 @@ export type IconSize = 16 | 20 | 24 | 32 | 64;
|
|
|
3
3
|
export type IconWeight = "light" | "regular" | "solid";
|
|
4
4
|
export interface IconProps extends SVGAttributes<SVGElement>, Pick<AllHTMLAttributes<SVGElement>, "role" | "title" | "tabIndex">, Pick<AriaAttributes, "aria-label" | "aria-hidden"> {
|
|
5
5
|
size?: number | undefined;
|
|
6
|
-
weight?: IconWeight | undefined;
|
|
7
6
|
color?: string | undefined;
|
|
8
7
|
align?: "center" | "baseline" | "none" | undefined;
|
|
9
8
|
}
|