icon-packs v0.10.0

icon-packs

Include icons from popular icon projects to your project. Icons are exported as ES2015 exports so only include the icons as you need, which reduces bundle size.

Installation

Icon-packs can by installed using npm or yarn.

npm install icon-packs --save

yarn add icon-packs

Usage

import { accountBookFill } from 'icons-packs/ant';
import { add } from 'icon-packs/blueprint';
import { alarmFill } from 'icon-packs/bootstrap';
import { accessibility1Line } from 'icon-packs/clarity';
import { add } from 'icon-packs/cssgg';
import { android } from 'icon-packs/devicons';
import { _500Px } from 'icon-packs/fa';
import { activity } from 'icon-packs/feather';
import { _3DHammer } from 'icon-packs/game';
import { iosAdd } from 'icon-packs/ionicons';
import { alarmClock } from 'icon-packs/jam';
import { accessibleIcon } from 'icon-packs/la';
import { _3DRotation24 } from 'icon-packs/material';
import { alert } from 'icon-packs/octicons';
import { _4KFill } from 'icon-packs/remix';
import { aboutMe } from 'icon-packs/simple';
import { adjustBrightness } from 'icon-packs/typicons';
import { wiAlien } from 'icon-packs/weather';

// render your icons with preferred framework

Format

Icons are formatted as plain objects and can be used with any framework:

{
  tag: 'svg',
  attrs: {
    xmlns: 'http://www.w3.org/2000/svg',
    viewBox: `0 0 24 24`
  },
  children: [{
    tag: 'desc',
    attrs: {},
    children: 'Icon Description'
  }, {
    tag: 'path',
    attrs: {
      x1: 0,
      y1: 0,
      x2: 23,
      y: 24
    }
  }]
}

API

All packs export:

• VERSION - current version of icon pack
• allIconNames - array of all available icon names in current icon pack

Icons with reserved filenames like delete or export are postfixed with an underscore: delete_ or export_.

Icons starting with a number like 4K are prefixed with an underscore: _4K.

Icon Packs exports all icons as es6 modules to enable tree shaking by default in most bundlers. Some environments only work with CommonJS. Icon Packs also exports icons in CommonJS format in the cjs directory: e.g. import { activity } from 'icon-packs/cjs/feather

Icons

• Ant Design Icons License: MIT License
• Blueprint Icons License: Apache License Version 2.0
• Bootstrap Icons License: MIT License
• Clarity Icons License: MIT License
• css.gg Icons License: MIT License
• Devicons License: MIT License
• Feather Icons License: MIT License
• Font Awesome Free License: CC BY 4.0
• Game Icons License: CC BY 3.0
• GitHub Octicons :License MIT License
• Ionicons License MIT License
• JAM Icons License MIT License
• Line Awesome Icons License MIT License
• Material Icons License Apache License Version 2.0
• Remix Icon License: Apache License Version 2.0
• Simple Icons License CC0 1.0 Universal
• Typicons License CC BY-SA 3.0
• Weather Icons License SIL OFL 1.1

License

The icon-packs package is available with the MIT license. Different icon projects come with different lisences be sure to check the lisence for used icons.