Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

postcss-icon

Package Overview
Dependencies
Maintainers
1
Versions
16
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

postcss-icon

PostCSS plugin which allows you to quickly add styles to css icons

  • 8.0.0
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
5
increased by400%
Maintainers
1
Weekly downloads
 
Created
Source

postcss-icon

postcss-icon

npm npm download count postcss-icon AppVeyor Travis

PostCSS plugin that adds css icons from Icon sets

Now you do not need to connect the entire style library for css icons.

Ison sets:

Font icons:

Css only icons:

Install for postcss

# the plugin
npm install --save-dev postcss-icon

# and the icon set you need
npm install --save-dev postcss-icon.material-design
npm install --save-dev postcss-icon.font-awesome-v4
npm install --save-dev postcss-icon.cssicon
npm install --save-dev postcss-icon.icono
npm install --save-dev postcss-icon.rosa
npm install --save-dev postcss-icon.airpwn
npm install --save-dev postcss-icon.stiffi
npm install --save-dev postcss-icon.joshnh

Input:

.icon.bad-name {
  @icon: 404-not-found-name;
}
.icon {
  color: gold;
  @icon: prefix-name;
}

Output:

@font-face {
  /*  */
} /* added if you use font icon set */

.icon.bad-name {
  /* @icon: 404-not-found-name */
}
.icon::after {
  content: "";
  /* ... */
}
/* after  before  i  span */
.icon {
  color: #000;
  width: 20px;
  heigth: 20px;
  /* ... */
  color: gold;
}

Usage (more examples)

const { resolve } = require("path");
const postcss = require("postcss");
const postcssIcon = require("postcss-icon");

const fontSetOptions = {
  inline: ["woff2"],
  path: resolve(__dirname, "./public/assets/fonts/"), // folder to save all font files. Required absolute path!
  formats: ["woff2", "woff" /*, "ttf", "svg", "eot"*/],
  filename: "[css-name]-[set-name].[hash:4].[ext]",
  url({ cssFile, fontName, hash }) {
    // function help fix url resolve
    // const urlWithQueryHash = `../fonts/${fontName}?v=${hash.substr(0, 5)}`;
    // const exmapleResolveUrl = `../fonts/${fontName}`;
    return fontName;
  }
};
// example for all icon Set
postcss(
  postcssIcon({
    "postcss-icon.material-design": {
      ...fontSetOptions,
      prefix: "md-"
    },
    "postcss-icon.font-awesome-v4": {
      ...fontSetOptions,
      prefix: "fa-"
    },
    "postcss-icon.cssicon": { prefix: "cssicon-" },
    "postcss-icon.icono": { prefix: "icono-" },
    "postcss-icon.rosa": { prefix: "rose-" },
    "postcss-icon.airpwn": { prefix: "airpwn-" },
    "postcss-icon.stiffi": { prefix: "stiffi-" },
    "postcss-icon.joshnh": { prefix: "joshnh-" }
  })
);

Options

Formats Support table (2018-1-15):

TypeSupport
woff278.53%
woff94.36%
ttf94.73%
svg25.36%
eot3.41%

Keywords

FAQs

Package last updated on 23 Sep 2018

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc