open-index/open-npm huggingface dataset:
npm package: @opuscapita/svg-icons
Description: OpusCapita SVG Icons
Latest version: 1.1.5

# OpusCapita svg icons

## Synopsis

Package provide an unified library of [SVG](https://en.wikipedia.org/wiki/Scalable_Vector_Graphics) icons.
Initially based on [Google Material Icons](https://github.com/google/material-design-icons/)

### Motivation for creating this library

Font-based icons like **font-awesome** have a lot of **limitations**:

* *font-based icons* is a **global dependency**
* *font-based icons* are **not extendable**. You have no chance to easilly add a new icon
* Different browser have **different font render engines**

**Related articles on this topic**

* **[Chris Coyier](http://chriscoyier.net/about/)** ([CSS-Tricks](https://css-tricks.com/) and [codepen.io](http://codepen.io/) co-founder):

  [Inline SVG vs Icon Fonts](https://css-tricks.com/icon-fonts-vs-svg/)

* **[Lars Kappert](https://github.com/webpro)** :

  [Why and how I’m using SVG sprites over fonts for icons](https://medium.com/@webprolific/why-and-how-i-m-using-svg-over-fonts-for-icons-7241dab890f0#.5bc934hd5)

### Difference from base [Google Material Icons](https://github.com/google/material-design-icons/) library
* Much reduced resulting package size (~60MB vs ~500KB)
* Icon files paths normalized to `[package-name]/lib/[icon-name]`
* Removed hardcoded color values in a few icons

## Usage

### Installation
`npm install --save -E @opuscapita/svg-icons`

### Import an icon using [webpack](https://webpack.github.io/)

```js
let buildIcon = require('!!raw-loader!@opuscapita/svg-icons/lib/build.svg');
```

In this way you get a raw *.svg* file content.

If `require` not working, ensure [raw-loader](https://www.npmjs.com/package/raw-loader) installed.

## Contributors

| <img src="https://avatars.githubusercontent.com/u/24652543?v=3" width="100px;"/> | [**Kirill Volkovich**](https://github.com/kvolkovich-sc) |
| :---: | :---: |
| <img src="https://avatars.githubusercontent.com/u/24603787?v=3" width="100px;"/> | [**Alexey Sergeev**](https://github.com/asergeev-sc)     |

Your contribution is welcome. We need YOU! :metal:

## License

Apache License, Version 2.0. See [LICENSE](./LICENSE) for the full license text.