monachilada / craft-svgicons

1.0.3 2019-02-10 11:34 UTC

Requires

• craftcms/cms: ^3.0

MIT

• Mike Pierce

• cms
• Craft
• craftcms
• craft-plugin
• svg icons

Published on Packagist.org on 2019-02-10 11:37 UTC

README

Craft CMS Twig extension to include SVGs from the Feather and Zondicons SVG icon libraries directly in your templates.

Requirements

This plugin requires Craft CMS 3.0.0 or later.

Installation

To install the plugin, follow these instructions.

1. Open your terminal and go to your Craft project:

    cd /path/to/project
   

2. Then tell Composer to load the plugin:

    composer require monachilada/craft-svgicons
   

3. In the Control Panel, go to Settings → Plugins and click the “Install” button for SVG Icons.

Using SVG Icons

Filter style: 'icon-name'|feather (or |zondicons) as well as function style: svgIcon('zondicons', 'icon-name') will work.

For example 'cpu'|feather would result in the following:

While svgIcon('zondicons', 'announcement') would result in:

See Feather and Zondicons to browse icons and for documentation on the keys to reference them.

SVG Icons Roadmap

Some things to do, and ideas for potential features:

• Add more icon sets as requested

Brought to you by Mike Pierce