max-zu / nova-tags-field

A tags field to use in your Nova apps

A tags field for Nova apps

This package contains a Nova field to add tags to resources. Under the hood it uses the spatie/laravel-tags package.

Support us

We invest a lot of resources into creating best in class open source packages. You can support us by buying one of our paid products.

We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on our contact page. We publish all received postcards on our virtual postcard wall.

Requirements

This Nova field requires MySQL 5.7.8 or higher.

Installation

First you must install spatie/laravel-tags into your Laravel app. Here are the installation instructions for that package.

Next, you can install this package in to a Laravel app that uses Nova via composer:

composer require spatie/nova-tags-field

Usage

To make an Eloquent model taggable just add the \Spatie\Tags\HasTags trait to it:

class BlogPost extends \Illuminate\Database\Eloquent\Model
{
    use \Spatie\Tags\HasTags;
    
    ...
}

Next you can use the Spatie\TagsField\Tags field in your Nova resource:

namespace App\Nova;

use Spatie\TagsField\Tags;

class BlogPost extends Resource
{
    // ...
    
    public function fields(Request $request)
    {
        return [
            // ...
            
            Tags::make('Tags'),

            // ...
        ];
    }
}

Now you can view and add tags on the blog posts screen in your Nova app. All tags will be saved in the tags table.

Limiting suggestions

By default a tags field will display a maximum of 5 suggestions when typing into it. If you don't want to display any suggestions, tag on withoutSuggestions().

Tags::make('Tags')->withoutSuggestions(),

You can change the number of suggestions with limitSuggestions().

Tags::make('Tags')->limitSuggestions($maxNumberOfSuggestions),

Limiting tags

By default a tags field will let you add unlimited tags. You can limit tags with limit().

Tags::make('Tags')->limit($maxNumberOfTags),

Using types

The underlying tags package has support for tag types. To make your tags field save tags of a certain type just tack on the name of type when adding the field to your Nova resource.

// in your Nova resource

public function fields(Request $request)
{
    return [
        // ...
        
        Tags::make('Tags')->type('my-special-type'),

        // ...
    ];
}

Allowing only one tag

If the user is only allowed to select one tag for your resource you can call the single method.

// in your Nova resource

public function fields(Request $request)
{
    return [
        // ...
        
        Tags::make('Tags')->single(),

        // ...
    ];
}

The field will be rendered as a select form element. It will be populated by the names of the tags already saved.

If you want to be able to deselect a tag, you can call the canBeDeselected method.

// in your Nova resource

public function fields(Request $request)
{
    return [
        // ...
        
        Tags::make('Tags')->single()->canBeDeselected(),

        // ...
    ];
}

Use a different placeholder

You can use the withMeta method documented here to change the placeholder from the default, which is __('Add tags...').

// in your Nova resource

public function fields(Request $request)
{
    return [
        // ...
        
        Tags::make('Categories', 'tags')->withMeta(['placeholder' => 'Add categories...']),

        // ...
    ];
}

Working with tags

For more info on how to work with the saved tags, head over to the docs of spatie/laravel-tags.

Administering tags in Nova

If you want to perform crud actions on the save tags, just create a Nova resource for it. Here's an example.

namespace App\Nova;

use Illuminate\Http\Request;
use Laravel\Nova\Fields\Text;
use Spatie\Tags\Tag as TagModel;

class Tag extends Resource
{
    public static $model = TagModel::class;

    public static $title = 'name';

    public static $search = [
        'name',
    ];

    public function fields(Request $request)
    {
        return [
            Text::make('Name')->sortable(),
        ];
    }
}

Show tags with a link to a Nova resource

When creating the field, you can use the withLinkToTagResource method.
Example:

Tags::make('Tags')->withLinkToTagResource() // The resource App\Nova\Tag will be used
Tags::make('Tags')->withLinkToTagResource(\Custom\CustomTag::class) // The resource \Custom\CustomTag will be used

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security

If you've found a bug regarding security please mail [e-mail] instead of using the issue tracker.

Credits

• Freek Van der Herten

The Vue components that render the tags are based upon the tag Vue components created by Adam Wathan as shown in his excellent Advanced Vue Component Design course.

License

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