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.
Requirements
This Nova field requires a database that supports json fields such as 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;
// ...
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.
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.
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(),
];
}
}
Testing
composer test
Changelog
Please see CHANGELOG for more information on what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Security
If you discover any security related issues, please email freek@spatie.be instead of using the issue tracker.
Postcardware
You're free to use this package, but if it makes it to your production environment we highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using.
Our address is: Spatie, Samberstraat 69D, 2060 Antwerp, Belgium.
We publish all received postcards on our company website.
Credits
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.
Support us
Spatie is a webdesign agency based in Antwerp, Belgium. You'll find an overview of all our open source projects on our website.
Does your business depend on our contributions? Reach out and support us on Patreon. All pledges will be dedicated to allocating workforce on maintenance and new awesome stuff.
License
The MIT License (MIT). Please see License File for more information.