Package Exports

@realtby/icons
@realtby/icons/dist/icons.esm.js
@realtby/icons/dist/icons.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@realtby/icons) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

@realtby/icons

realt.by icons library

install

npm i -S @realtby/icons

usage

import icons.css to your project, for example:

import '@realtby/icons/dist/icons.css';

import icons from lib root:

import { SuccessIcon } from '@realtby/icons';

render icon, pass props:

<SuccessIcon size={20} className="text-success-500" />

development

make install
make dev # run storybook
make lint
make build
make release # to push new version & generate changelog
make prerelease # then select pre- version, only push new version to npm, for testing
make build-size # reset cache, build & run size-limit
make size-limit-generate # generate icon size limit

How add svg to the library

Copy the raw svg (for example: login.svg) and put it in the desired folder in src/icons (for example: admin):

  src/
      icons/
            ...
            admin/
                  ...
                  login.svg

Run svg:processing script for the admin folder:

  $ npm run svg:processing src/icons/admin

Check result:

  src/
      icons/
            ...
            admin/
                  ...
                  login.optimized.svg
                  login.tsx
                  index.tsx

Note: Processing performs an average optimization. For the best result, optimize the icon manually in the SVGOMG service, save it to a file with the extension .optimized.svg and run svg:processing again.

Generate icon size-limit:

$ make build
$ make size-limit-generate