1.4.2 • Published 2 years ago

@icon-park/svg v1.4.2

Weekly downloads
45
License
Apache-2.0
Repository
github
Last release
2 years ago

IconPark Icons

Pure SVG Icons for IconPark

Introduction

Features

  • Provide more than 2000 icons
  • Provide 4 themes:
    • outline
    • filled
    • two-tone
    • multi-color

More

Please visit IconPark Website

  • Copy SVG
  • Copy React Icon component
  • Copy Vue Icon component
  • Download PNG
  • Download SVG

Getting Started

Install

npm install @icon-park/svg --save

Include Component

Import an icon from @icon-park/svg and then call it:

import {Home} from '@icon-park/svg';

// examples

const svg = Home({theme: 'outline'});

console.log(svg);

Global Config

You can use the static methods setConfig in @icon-park/svg to set the default config globally:

import {setConfig} from '@icon-park/svg'

setConfig({
    theme: 'outline',
    size: '1em',
    strokeWidth: 4,
    strokeLinecap: 'round',
    strokeLinejoin: 'round',
    outStrokeColor: '#000',
    outFillColor: '#2F88FF',
    innerStrokeColor: '#FFF',
    innerFillColor: '#43CCF8'
})

Import on Demand

You can use babel-plugin-import to import icons on demand.

Set config like this:

{
    "plugins": [
        [
            "import",
            {
                "libraryName": "@icon-park/svg",
                 "libraryDirectory": "es/icons",
                 "camel2DashComponentName": false 
            }
        ]
    ]
}

Embed IconPark in your project

If you need to use additional information such as icon name, author, category, label and creation time, you can use the icons.json file located in the root directory of each NPM.

Props

propdescriptiontypedefaultnote
themeTheme of the icons.'outline' | 'filled' | 'two-tone' | 'multi-color''outline'
sizeThe width/height of the iconnumber | string'1em'
spinRotate icon with animationbooleanfalse
fillColors of themestring | string[]'currentColor'
strokeLinecapthe stroke-linecap prop of svg element'butt' | 'round' | 'square''round'
strokeLinejointhe stroke-linejoin prop of svg element'miter' | 'round' | 'bevel''round'
strokeWidththe stroke-width prop of svg elementnumber4