pepicons
TypeScript icon, indicating that this package has built-in type declarations

3.1.1 • Public • Published

hero

🥤 Pepicons

Total Downloads Latest Stable Version

Pepicons is an icon-set of around five hundred (and counting) retro icons inspired by the 80's. Every icon available in 2 variants: Pop! and Print ❏

Website & icons

pepicons.com

Installation & Usage

npm i pepicons

Import .svg files

If your build tool allows importing direct SVGs, you can do so from via these import paths:

// import what you need
import airplane from 'pepicons/svg/pop/airplane.svg'
// or
import airplane from 'pepicons/svg/print/airplane.svg'

Import SVG as string

Import an SVG as string with Tree-Shaking:

// import what you need
import { popAirplane, printAirplane } from 'pepicons'

console.log(popAirplane)
// prints:
// <svg width="20" height="20" viewBox="0 0 20 20" fill="none" xmlns="http://www.w3.org/2000/svg">
//   <path fill-rule="evenodd" clip-rule="evenodd" d="..." fill="currentColor"/>
// </svg>

You can also import the exact same without the pop/print prefixes like so:

// import what you need
import { airplane } from 'pepicons/pop'
// or
import { airplane } from 'pepicons/print'

console.log(airplane)
// prints:
// <svg width="20" height="20" viewBox="0 0 20 20" fill="none" xmlns="http://www.w3.org/2000/svg">
//   <path fill-rule="evenodd" clip-rule="evenodd" d="..." fill="currentColor"/>
// </svg>

You can also import all icons at once in one big object:

import { pop, print } from 'pepicons'

console.log(pop.airplane)
// prints:
// <svg width="20" height="20" viewBox="0 0 20 20" fill="none" xmlns="http://www.w3.org/2000/svg">
//   <path fill-rule="evenodd" clip-rule="evenodd" d="..." fill="currentColor"/>
// </svg>

TypeScript protection from spelling mistakes

You can import the PepiconName type which is a string literal with all possible Pepicon names:

import { PepiconName, pop } from 'pepicons'

export function getSvg(name: PepiconName): string {
  // PepiconName
  //    ↓
  // 'airplane' | 'angle-down' | ...

  return pop[name]
}

If you need it, there's also an array with all possible pepicon names you can import:

import { pepiconArray } from 'pepicons'

console.log(pepiconArray)
// prints:
// ['airplane', 'angle-down', ...]

@pepicons/vue (Vue 3)

See packages/vue

Motivation

Check out this blog post to understand our motivation for creating Pepicons:

License

This icon set falls under CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE.

You must give appropriate credit, provide a link to the license, and indicate if changes were made. You may do so in any reasonable manner, but not in any way that suggests the licensor endorses you or your use.

See the full LICENSE details at LICENSE.

Readme

Keywords

none

Package Sidebar

Install

npm i pepicons

Weekly Downloads

410

Version

3.1.1

License

CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE

Unpacked Size

46 MB

Total Files

3843

Last publish

Collaborators

  • mesqueeb
  • hunterliu1003