PHPackages                             tobimori/kirby-icon-field - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility & Helpers](/categories/utility)
4. /
5. tobimori/kirby-icon-field

ActiveKirby-plugin[Utility & Helpers](/categories/utility)

tobimori/kirby-icon-field
=========================

A simple Icon field plugin for Kirby CMS

2.3.0(1y ago)5222.7k—0.2%3[5 issues](https://github.com/tobimori/kirby-icon-field/issues)1MITVuePHP >=8.2.0

Since Jun 15Pushed 5mo ago3 watchersCompare

[ Source](https://github.com/tobimori/kirby-icon-field)[ Packagist](https://packagist.org/packages/tobimori/kirby-icon-field)[ GitHub Sponsors](https://github.com/tobimori)[ RSS](/packages/tobimori-kirby-icon-field/feed)WikiDiscussions main Synced 2w ago

READMEChangelog (10)Dependencies (2)Versions (14)Used By (1)

[![Kirby Icon Field Banner](/.github/banner.png)](/.github/banner.png)

Kirby Icon Field
================

[](#kirby-icon-field)

A simple Icon field for Kirby 4+ - throw your Icon pack in a folder, add the field to your blueprints and you're good to go.

If you're using Kirby 3.9+, please try using [v1.0.3](https://github.com/tobimori/kirby-icon-field/releases/tag/1.0.3).

Installation
------------

[](#installation)

#### Recommended: Composer

[](#recommended-composer)

```
composer require tobimori/kirby-icon-field

```

#### Manual installation

[](#manual-installation)

Download and copy this repository to `/site/plugins/kirby-icon-field`, or apply this repository as Git submodule.

Usage
-----

[](#usage)

This plugin relies on having your SVG icons as separate files in a folder for display in the panel - of course you're free to do whatever you want with the field's value in your templates.

Icons will always be displayed in single-color white or black.

#### Add the field to your blueprint:

[](#add-the-field-to-your-blueprint)

```
fields:
  icon:
    label: Icon
    type: icon
    folder: assets/icons # path to your icon folder, relative to the `index` kirby root (you can use the Kirby query language)
    max: 1 # max number of icons to select - 1 will look like a 'select field', none or more like a 'multiselect' field
    sprite: svg-sprite.svg # optional, path to your svg sprite relative to folder option, if you want to use a sprite instead of individual files (you can use the Kirby query language)
    # [more settings...] - same as multi-select field, e.g. disabling search, limiting icons, etc.
```

Note

If you're using a sprite, make sure the file is available for the user to access at the set path. The plugin does not copy or move the file, it only references it. The `#id` reference will be stored without a `.svg` extension unlike the individual files mode.

#### Use the field value in your template

[](#use-the-field-value-in-your-template)

```

```

Options
-------

[](#options)

OptionDefaultDescription`cache``true`Enable cache for reading from icons directory`folder``assets/icons`Default folder for icon field, can also be a function`sprite``null`Default file for SVG sprite file, can also be a functionOptions allow you to fine tune the behaviour of the plugin. You can set them in your `config.php` file:

```
return [
    'tobimori.icon-field' => [
        'cache' => true,
        'folder' => 'assets/icons'
    ],
];
```

Support
-------

[](#support)

Note

This plugin is provided free of charge & published under the permissive MIT License. If you use it in a commercial project, please consider to [sponsor me on GitHub](https://github.com/sponsors/tobimori) to support further development and continued maintenance of Kirby Icon Field.

License
-------

[](#license)

[MIT License](./LICENSE)Copyright © 2023-2024 Tobias Möritz

The icons in the preview image are part of [Chunk Icons](https://www.figma.com/community/file/889863427421594653/Chunk-Icons) by [Noah Jacobus](https://twitter.com/Jabronus). <3

###  Health Score

49

—

FairBetter than 94% of packages

Maintenance58

Moderate activity, may be stable

Popularity40

Moderate usage in the ecosystem

Community20

Small or concentrated contributor base

Maturity65

Established project with proven stability

 Bus Factor1

Top contributor holds 88.6% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~62 days

Recently: every ~111 days

Total

13

Last Release

410d ago

Major Versions

1.0.3 → 2.0.0-rc.12023-09-14

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/29142128?v=4)[Tobias Möritz](/maintainers/tobimori)[@tobimori](https://github.com/tobimori)

---

Top Contributors

[![tobimori](https://avatars.githubusercontent.com/u/29142128?v=4)](https://github.com/tobimori "tobimori (31 commits)")[![timnarr](https://avatars.githubusercontent.com/u/3532570?v=4)](https://github.com/timnarr "timnarr (2 commits)")[![adamkiss](https://avatars.githubusercontent.com/u/481362?v=4)](https://github.com/adamkiss "adamkiss (1 commits)")[![jan-herman](https://avatars.githubusercontent.com/u/12972544?v=4)](https://github.com/jan-herman "jan-herman (1 commits)")

---

Tags

kirbykirby-pluginkirby4kirby5kirbycmskirbykirby-plugin

### Embed Badge

![Health badge](/badges/tobimori-kirby-icon-field/health.svg)

```
[![Health](https://phpackages.com/badges/tobimori-kirby-icon-field/health.svg)](https://phpackages.com/packages/tobimori-kirby-icon-field)
```

###  Alternatives

[medienbaecker/kirby-modules

Easily add modules to your pages

895.6k1](/packages/medienbaecker-kirby-modules)[belugadigital/kirby-navigation

Kirby 5 field for hierarchical menus with drag & drop level indentation.

8615.1k](/packages/belugadigital-kirby-navigation)[bnomei/kirby3-dotenv

Kirby Plugin for environment variables from .env

4151.3k2](/packages/bnomei-kirby3-dotenv)[grommasdietz/kirby-hidden-characters

Kirby CMS plugin for visualising hidden characters in the Panel

462.2k](/packages/grommasdietz-kirby-hidden-characters)[beebmx/kirby-env

Enable env variables to Kirby

2141.2k4](/packages/beebmx-kirby-env)[bnomei/kirby3-recently-modified

Kirby Section to display recently modified content pages

3211.0k](/packages/bnomei-kirby3-recently-modified)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)