nerdcel/kirby3-icon-sprite

Kirby3 plugin to manage svg icons.

1.3.0 2024-04-30 08:06 UTC

Requires

• php: >= 8.1 < 8.4
• ext-dom: *
• getkirby/composer-installer: ^1.2.1

Requires (Dev)

• phpstan/phpstan: ^1.10
• roave/security-advisories: dev-latest

MIT

• Marcel Hieke

• kirby
• kirby3
• kirby-plugin
• kirby-cms
• getkirby

README

This plugin provides helper functions which can be used in your template to generate a SVG sprite, to reference SVG icons in your templates and to inject SVG icons directly to the template. It also provides blueprints for the fileupload and a files section for your site.yml to manage the icons. To set custom options, please see the Options section in this README file.

This plugin is completely free and published under the MIT license. However, if you are using it in a commercial project and want to help me keep up with maintenance, please consider making a donation of your choice.

Installation

Download

Download and copy this repository to /site/plugins/icon-sprite.

Git submodule

git submodule add https://github.com/nerdcel/kirby3-icon-sprite.git site/plugins/icon-sprite

Composer

composer require nerdcel/kirby3-icon-sprite

Setup

Template

<?php echo svgSprite();  ?>
<?php echo svgIcon('slug', 'css-classes', [ /** Additional attributes as key => value */]);  ?>
<?php //echo inlineIcon('icon-path or filename', 'css-classes');  ?>

Site.yml

...
sections:
  svgicons: sections/svgsprite
  label: Override
  ...

Options

The following options are available to be set using your site/config/config.php

'nerdcel.icon-sprite' => [
    'withStyles' => true,
    'fill' => '#0a0a0a',
    'width' => '24px',
    'aspectRatio' => '1'
]

License

MIT

Credits

• Marcel Hieke