Руководство

Данная библиотека содержит набор оптимизированных SVG-иконок, которые легко интегрируются в проекты. Все иконки тщательно отобраны и стандартизированы для обеспечения визуального единообразия интерфейсов и соответствия принципам дизайна.

Библиотека также поддерживает гибкость в использовании, позволяя настраивать и модифицировать иконки в зависимости от потребностей.

Ссылки

Репозиторий | Хранилище с библиотекой | Confluence

Публикация

Версия поднимается автоматически в ветке main с помощью утилиты standard-version с учетом правил версионирования.

Установка

npm install @web-global/icons --save --registry https://npms.2pp.dev

Подключение

Для работы с иконками необходимо их правильно подключить и инициализировать.

Иконки создаются только при вызове функции createIcons, которая должна быть вызвана внутри жизненного цикла компонента, такого как onMounted в Vue или useEffect в React. Это необходимо, потому что инициализация иконок должна происходить после рендеринга DOM-элементов, к которым они привязываются.

1. Подключение:

// Подключение всех иконок
import { createIcons, icons } from "@web-global/icons";

// Подключение определённой иконки по её имени в camelCase формате
import { createIcons, iconName } from "@web-global/icons";

2. Создание иконок:

// Создание всех иконок
createIcons({
  icons: icons,
});

// Создание определённой иконки
createIcons({
  icons: {
    iconName,
  },
});

3. Использование:

<i data-icon="icon-name" />