@salutejs/plasma-icons
TypeScript icon, indicating that this package has built-in type declarations

1.192.0 • Public • Published

Plasma-icons

Пакет предоставляет самостоятельный набор иконок для совместного использования с plasma-ui.

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

Компоненты реализованы на typescript с помощью react;

Использование данного пакета предполагает использование react & react-dom;

Установка пакета

npm i --save @salutejs/plasma-icons

Использование компонентов

Все иконки доступны из корня пакета Пример:

import { IconApps } from '@salutejs/plasma-icons';

const App = () => {
    return <IconApps />;
};

Также имеется возможность (не рекомендуется) использовать иконки через переиспользуемый компонент. В этом случае все иконки попадут в бандл при сборке (из-за чего может сильно увеличится размер сборки). Пример:

import { Icon } from '@salutejs/plasma-icons';

const App = () => {
    return <Icon icon="iconApps" />;
};

Как добавить новую иконку

  • Добавить иконку в svg формате в нужную папку по размеру(на данный момент только 24) src/scalable/Icon.svg.24 (вручную или через плагин фигмы). Если вручную, то также стоит внести название иконки в соотвествующую категорию в файле src/scalable/Icon.tsx.
  • React-компоненты автоматически создадутся после выполнения npm run build.
  • Для обновления архива с иконками под android необходимо запустить npm run generate:android.

Полезные ссылки:

Витрина с компонентами storybook

Документация о каждом компоненте: https://bit.ly/36MIrA0

Dependencies (0)

    Dev Dependencies (21)

    Package Sidebar

    Install

    npm i @salutejs/plasma-icons

    Weekly Downloads

    2,469

    Version

    1.192.0

    License

    MIT

    Unpacked Size

    9.63 MB

    Total Files

    13143

    Last publish

    Collaborators

    • salute-eva
    • awinogradov
    • turanchoks
    • salute-assistant