eleventy-plugin-phosphoricons

An Eleventy shortcode, allows Phosphor icons to be embedded as inline svg or render as an image in your Eleventy project.

Demo: https://eleventy-plugin-phosphoricons.netlify.app/

Requirements

• Eleventy 2.0 or higher (CJS) / Eleventy 3.0 or higher (ESM)

Installation

Install the plugin from npm:

npm install eleventy-plugin-phosphoricons --save-dev

Configuration

• class - The class attribute to be added to the svg element. Default: phicon
• style - The style attribute to be added to the svg element. Default: undefined
• size - The width and height attribute to be added to the svg element. Default: 256
• fill - The fill attribute to be added to the svg element. Default: currentColor
• width - The width attribute to be added to the img element. Default: taken from the size attribute
• height - The height attribute to be added to the img element. Default: taken from the size attribute
• render - The render method allows you to render icon as inline svg or image. Default: svg, other options: image or img
• transformClass - A CSS class that you want to map using a callback function transformFill. Default: false
• transformFill - A callback function to transform the fill attribute, based on transformClass attribute. Default: undefined

If render is set to image or img, the following attributes can be used:

• alt - The alt attribute to be added to the img element. Default: altPrefix + iconName
• altPrefix - The alt attribute prefix to be added to the img element. Default: icon
• loading - The loading attribute to be added to the img element. Default: lazy
• decoding - The decoding attribute to be added to the img element. Default: async
• eleventyIgnore - The eleventyIgnore attribute to be added to the img element to prevent @11ty/eleventy-img plugin from processing the image. Default: true

Usage

Add it to your Eleventy Config file:

ESM (Eleventy 3.x):

import eleventyPluginPhosphoricons from 'eleventy-plugin-phosphoricons';

export default function (eleventyConfig) {
    eleventyConfig.addPlugin(eleventyPluginPhosphoricons);
};

CommonJS (Eleventy 2.x):

const eleventyPluginPhosphoricons = require('eleventy-plugin-phosphoricons');

module.exports = function (eleventyConfig) {
    eleventyConfig.addPlugin(eleventyPluginPhosphoricons);
};

Advanced usage:

import eleventyPluginPhosphoricons from 'eleventy-plugin-phosphoricons';

export default function (eleventyConfig) {
    eleventyConfig.addPlugin(eleventyPluginPhosphoricons, {
        class: "phicon",
        style: "vertical-align: middle;",
        size: 32,
        fill: "currentColor"
    });
};

Using transformFill callback function

May be useful if you using a CSS framework like Tailwind CSS, Bootstrap, etc. and you want to map the fill attribute to the text color classes.

TailwindCSS usage example:

import eleventyPluginPhosphoricons from 'eleventy-plugin-phosphoricons';
import resolveConfig from 'tailwindcss/resolveConfig.js';
import tailwindConfig from './tailwind.config.js';

const fullConfig = resolveConfig(tailwindConfig);

export default function (eleventyConfig) {
    eleventyConfig.addPlugin(eleventyPluginPhosphoricons, {
        class: "phicon",
        style: "vertical-align: middle;",
        size: 32,
        fill: "currentColor",
        transformFill: (color) => {
            const [baseColor, shade] = color.replace('text-', '').split('-');
            return shade ? fullConfig.theme.colors[baseColor][shade] : fullConfig.theme.colors[baseColor]['DEFAULT'];
        }
    });
};

What does it do?

The plugin turns 11ty shortcodes like this:

{% phosphor "phosphor-logo" %}

or

{% phicon "phosphor-logo" %}

into HTML code like this:

<svg xmlns="http://www.w3.org/2000/svg"
     viewBox="0 0 256 256"
     fill="currentColor"
     class="phicon"
     style="vertical-align: middle;"
     width="32" height="32">
    <path d="M144,24H64a8,8,0,0,0-8,8V160a80.09..."></path>
</svg>

Template Usage

Nunjucks

With object attributes:

{% phicon "phosphor-logo", "duotone", {
    style: "color:red",
    size: 64,
    class: "phicon bg-blue"
} %}

Render as image:

{% phicon "phosphor-logo", "fill", { render: 'image' } %}

Liquid

With extra CSS classes (string):

{% phicon "star" "fill" "text-yellow-500 hover:scale-110" %}

Basic usage:

{% phicon "phosphor-logo" %}
{% phicon "phosphor-logo" "duotone" %}

Icon Types

Six icon variants are available: regular (default), thin, light, bold, fill, duotone

{% phicon "heart" %}
{% phicon "heart" "thin" %}
{% phicon "heart" "light" %}
{% phicon "heart" "bold" %}
{% phicon "heart" "fill" %}
{% phicon "heart" "duotone" %}

Contributing

If you notice an issue, feel free to open an issue.

1. Fork this repo
2. Clone git clone [email protected]:reatlat/eleventy-plugin-phosphoricons.git
3. Install dependencies npm install
4. Build npm run build
5. Serve locally npm run dev

License

The code is available under the MIT license.