PHPackages                             goldfinch/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. goldfinch/icon-field

ActiveSilverstripe-vendormodule[Utility & Helpers](/categories/utility)

goldfinch/icon-field
====================

Advanced Icon Field for Silverstripe

v2.0.9(1y ago)06021[1 issues](https://github.com/goldfinch/icon-field/issues)1MITPHPPHP >=8.0

Since Jan 18Pushed 1y ago1 watchersCompare

[ Source](https://github.com/goldfinch/icon-field)[ Packagist](https://packagist.org/packages/goldfinch/icon-field)[ RSS](/packages/goldfinch-icon-field/feed)WikiDiscussions main Synced 1mo ago

READMEChangelogDependencies (4)Versions (20)Used By (1)

🦅 Icon Field for Silverstripe
=============================

[](#-icon-field-for-silverstripe)

[![Silverstripe Version](https://camo.githubusercontent.com/a798a57963ddebe0c33c27c757b7722fc95a0a6cc52f7c1839a90238934cafe4/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f53696c7665727374726970652d253545352e312d3030356165312e7376673f6c6162656c436f6c6f723d7768697465266c6f676f436f6c6f723d666666666666266c6f676f3d646174613a696d6167652f7376672b786d6c3b6261736536342c50484e325a79423462577875637a30696148523063446f764c336433647935334d793576636d63764d6a41774d43397a646d636949485a705a58644362336739496a41674d4341784d4445754d446b78494455344c6a55314e5349675a6d6c7362443069497a41774e57466c4d53496765473173626e4d36646a30696148523063484d364c7939325a574e30595335706279397559573576496a3438634746306143426b50534a4e4e5441754d444531494455754f445534624330794d5334794f444d674d5451754f5745324c6a55674e693431494441674d434177494463754e445134494445774c6a59314e4777794d5334794f444d744d5451754f574d344c6a67784d7930324c6a4533494449774c6a6b324c5451754d444934494449334c6a457a494451754e7a6732637a51754d444934494449774c6a6b324c5451754e7a6731494449334c6a457a624330324c6a59354d5341304c6a59334e6d4d314c6a55304d6941354c6a51784f4341784f4334774e7a67674e5334304e5455674d6a4d754e7a637a4c5451754e6a553051544d794c6a513349444d794c6a5133494441674d434177494455774c6a41784e5341314c6a67324d6e70744d5334774e5467674e4459754f444933624449784c6a49344e4330784e433435595459754e5341324c6a55674d434178494441744e7934304e446b744d5441754e6a557a5444517a4c6a59794d7941304d6934774d6a686a4c5467754f44457a494459754d5463744d6a41754f545535494451754d4449354c5449334c6a45794f5330304c6a63344e484d744e4334774d6a6b744d6a41754f545535494451754e7a67304c5449334c6a45794f5777324c6a59354d5330304c6a59334e6b4d794d6934304d79307a4c6a6b334e6941354c6a67354e4330754d44457a494451754d546b34494445774c6a41354e6d457a4d6934304e79417a4d6934304e794177494441674d4341304e6934344e7a55674e4449754e546b7965694976506a777663335a6e50673d3d)](https://packagist.org/packages/goldfinch/icon-field)[![Package Version](https://camo.githubusercontent.com/93ff2ea2bd4cfc348042898133c0bdffdebc8e3621f6ce2b4ca3284476a196b7/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f676f6c6466696e63682f69636f6e2d6669656c642e7376673f6c6162656c436f6c6f723d33333326636f6c6f723d463843363330266c6162656c3d56657273696f6e)](https://packagist.org/packages/goldfinch/icon-field)[![Total Downloads](https://camo.githubusercontent.com/247afbcacc0b0204982d70c6f27b527a4223262459b5b7cedb3ddbde942fec45/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f676f6c6466696e63682f69636f6e2d6669656c642e7376673f6c6162656c436f6c6f723d33333326636f6c6f723d463843363330266c6162656c3d446f776e6c6f616473)](https://packagist.org/packages/goldfinch/icon-field)[![License](https://camo.githubusercontent.com/c45c23fda3b8c8188ca1eeb19166e190c42bebe140c64ba2f7ed91002bc4ef47/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f6c2f676f6c6466696e63682f69636f6e2d6669656c642e7376673f6c6162656c436f6c6f723d33333326636f6c6f723d463843363330266c6162656c3d4c6963656e7365)](https://packagist.org/packages/goldfinch/icon-field)

Advanced Icon Field for Silverstripe. It can handle up to 4 different types of icon sources:

- font icons (css file)
- directory (icons within specific folder)
- upload folder (folder through SilverStripe assets module)
- json (source file)

Install
-------

[](#install)

```
composer require goldfinch/icon-field
```

Available Taz commands
----------------------

[](#available-taz-commands)

If you haven't used [**Taz**](https://github.com/goldfinch/taz)🌪️ before, *taz* file must be presented in your root project folder `cp vendor/goldfinch/taz/taz taz`

---

> Add new icon set

```
php taz iconset
```

> Publish icon templates

```
php taz vendor:icon-field:templates
```

Quick Bootstrap icon set setup
------------------------------

[](#quick-bootstrap-icon-set-setup)

1. Copy json set of all current bootstrap icons

```
cp vendor/goldfinch/icon-field/examples/icon-bootstrap.json app/_schema/icon-bootstrap.json
```

2. Add config for this set

```
Goldfinch\IconField\Forms\IconField:
  icons_sets:
    bootstrap:
      type: font
      source: 'https://cdn.jsdelivr.net/npm/bootstrap-icons@1.11.3/font/bootstrap-icons.min.css'
```

3. Use field with this set

```
use Goldfinch\IconField\Forms\IconField;

IconField::create('bootstrap', 'Icon');
```

Usage
-----

[](#usage)

```
use Goldfinch\IconField\Forms\IconField;

class Page
{
    private static $db = [
        'Icon' => 'Icon',
    ];

    public function getCMSFields()
    {
        $fields = parent::getCMSFields();

        $fields->insertBefore('Content', IconField::create('icon_set_name', 'Icon'));
    }
}
```

```

$Icon
$Icon.Key
$Icon.Size(100).Color(green)
$Icon.URL
$Icon.Title
$Icon.IconSetName
$Icon.IconType
```

Vite support
------------

[](#vite-support)

If you use [Vite](https://github.com/swordfox/vite) as a front-end build tool, you might want to include a dynamic vite link as a source for your icons. Easy, just use prefix `vite:` followed by relative path to the file of your build, as you have it in your `vite.config.js`.

*example:*

```
Goldfinch\IconField\Forms\IconField:
  icons_sets:
    my_icons_set:
      type: font
      source: 'vite:themes/main/src/icons.scss'
```

Previews
--------

[](#previews)

#### Icon (unloaded sets)

[](#icon-unloaded-sets)

[![Icon fields unloaded](screenshots/icon-fields-unloaded.png)](screenshots/icon-fields-unloaded.png)

#### Icon (loaded sets)

[](#icon-loaded-sets)

[![Icon fields](screenshots/icon-fields.png)](screenshots/icon-fields.png)

#### Demo output (all types)

[](#demo-output-all-types)

[![Demo output](screenshots/icon-field-demo-output.png)](screenshots/icon-field-demo-output.png)

Sidenotes
---------

[](#sidenotes)

- If your set contains icons as PNG files, make sure to set property `vector: false` in your set configuration
- When using `dir` set type, direct folder for icons in public (eg: `public/my-icons`) might have access issues due to rules in `.htaccess`. If that's your case, just move your dir with icons to `assets` dir, (eg: `public/assets/my-icons`) and update `source` parameter in config file.

License
-------

[](#license)

The MIT License (MIT)

###  Health Score

31

—

LowBetter than 68% of packages

Maintenance31

Infrequent updates — may be unmaintained

Popularity16

Limited adoption so far

Community10

Small or concentrated contributor base

Maturity55

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% 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 ~6 days

Recently: every ~0 days

Total

19

Last Release

726d ago

Major Versions

v1.0.8 → v2.0.02024-03-07

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/2291826?v=4)[goldfinch](/maintainers/goldfinch)[@goldfinch](https://github.com/goldfinch)

---

Top Contributors

[![goldfinch](https://avatars.githubusercontent.com/u/2291826?v=4)](https://github.com/goldfinch "goldfinch (31 commits)")

---

Tags

silverstripeicon-fieldicons-fieldsilverstripe-icon

### Embed Badge

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

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

###  Alternatives

[silverstripe/subsites

Run multiple sites from a single SilverStripe install.

65392.9k20](/packages/silverstripe-subsites)[symbiote/silverstripe-advancedworkflow

Adds configurable workflow support to the CMS, with a GUI for creating custom workflow definitions.

46295.2k7](/packages/symbiote-silverstripe-advancedworkflow)[silverstripe/taxonomy

Provide extra taxonomy for cataloguing the data.

10481.5k19](/packages/silverstripe-taxonomy)[wedevelopnl/silverstripe-elemental-grid

Elemental grid module

1014.1k2](/packages/wedevelopnl-silverstripe-elemental-grid)

PHPackages © 2026

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