Skip to content

Latest commit

 

History

History
117 lines (78 loc) · 3.82 KB

README.md

File metadata and controls

117 lines (78 loc) · 3.82 KB
Raw

Heroicon Nova Field

A Laravel Nova Field for managing icons. Heroicons and free Font Awesome supported out of the box, pro version of Font Awesome can be registered as custom set of icons.

Custom sets of icons can be registered globally for each field or locally for concrete field instanse and used with or instead default sets.

Each icon can be changed via editor.

Icon saved as svg html tag into db.

Installation:

Use composer for installation. Laravel with nova required.

composer require alexazartsev/heroicon

Usage:

Use it as regular nova field:

use AlexAzartsev\Heroicon\Heroicon;

Heroicon::make('Icon');

Default icon sets available:

Name Label Icons
solid Heroicons solid Heroicons solid
outline Heroicons outline Heroicons outline
fa-brands Font Awesome brands Font Awesome brands
fa-solid Font Awesome solid Font Awesome solid
fa-regular Font Awesome regular Font Awesome regular

To use custom or customize existing icon click on Edit button and just edit svg code of selected icon:

To register custom set of icons use global or local configuration discribed below:

Configuration:

Global configuration:

Field can be configured globally in NovaServiceProvider:

namespace App\Providers;

use AlexAzartsev\Heroicon\Heroicon;

class NovaServiceProvider extends NovaApplicationServiceProvider
{
    ...
    public function boot()
    {
        parent::boot();
        
        // to register set of icons globally, just specify folder with svg icons like this:
        // (icons should be located directly in specified folder in .svg format)
        // 'custom' icon set will be available for every Heroicon in your app
        Heroicon::registerGlobalIconSet('custom', 'Custom Icons', resource_path('img/icons'));
        // to pick default icon sets that will be available on field all over app use this:
        // default sets available: 'solid', 'outline', 'fa-brands', 'fa-regular', 'fa-solid'
        Heroicon::defaultIconSets(['solid', 'fa-brands', 'custom']);
        // to make svg editor disabled by default for every field use this:
        Heroicon::defaultEditorEnable(false);

    }

Local configuration:

To disable or enable svg editor of the icon:

use AlexAzartsev\Heroicon\Heroicon;

Heroicon::make('Icon')->disableEditor();
Heroicon::make('Icon')->enableEditor();

To register custom set of icons (icons should be located directly in specified folder in .svg format):

use AlexAzartsev\Heroicon\Heroicon;

Heroicon::make('Icon')->registerIconSet('custom', 'Custom', resource_path('img/icons'));

To allow certain sets of icons:

use AlexAzartsev\Heroicon\Heroicon;

Heroicon::make('Icon')->only(['custom', 'solid']);
//for default sets you can use these methods:
Heroicon::make('Icon')->onlySolid();
Heroicon::make('Icon')->onlyOutline();
Heroicon::make('Icon')->onlyFaBrands();
Heroicon::make('Icon')->onlyFaSolid();
Heroicon::make('Icon')->onlyFaRegular();

Support:

[email protected]

License:

The MIT License (MIT). Please see License File for more information.