README

The Mention plugin allows you to easily mention users in your Filament application using the Filament RichText editor. It supports extracting specific fields from the mentioned user, such as their username, and id. The plugin offers both static search (preloaded data) and dynamic search (real-time database queries) for mentions.

Features

Mention users in the Filament RichText editor.
Extract specific fields from the mentioned user (e.g. username, id).
Static search: Preload and search from a dataset.
Dynamic search: Fetch data from the database in real-time.
Customizable user model and fields: Use your own User model and define which fields to display.
Multiple trigger characters: Use different characters like @, #, % to trigger different types of mentions.
Global object search: Search across all properties of an object without requiring a specific lookup key.
Prefix and suffix support: Add custom text before and after mentions (e.g., %VARIABLE%).
Customizable title and hint fields: Configure which fields to use for display in the dropdown menu.
Customizable suggestion limits: Control the number of suggestions displayed and the minimum text length to trigger the search.
Avatar and URL support: Display user avatars and link to their profiles.

Requirements

Filament 3.2 or higher

Installation

Install the package via Composer:
```
composer require asmit/filament-mention
```
After installation and update please run the following command to publish the assets:
```
php artisan filament:assets
```

Publish the configuration file:

php artisan vendor:publish --provider="Asmit\FilamentMention\FilamentMentionServiceProvider" --tag="asmit-filament-mention-config"

This will create a filament-mention.php file in your config directory. You can customize the configuration according to your needs.

Upgrading from 1.x to 2.x

If you are upgrading from version 1.x to 2.x, please note these changes:

The configuration key search_key is now search_column.
The HasMentionable trait is now HasMentionableForm.
The mentionsItems method is now mentionableItems.

The form data structure after pluck is change.

 [
     'note' => [
         'state' => 'your comment message'
         'mentioned_YOUR-PLUCK-KEY' => [
             0 => 1,
             1 => 2,
             2 => 3,
         ]
 ]```

The FetchMentionEditor is deprecated. You can use dynamic search with getMentionableItemsUsing method in the RichMentionEditor field.

Configuration

The configuration file (config/filament-mention.php) allows you to customize the plugin behavior. Here's an example configuration:

return [
    'mentionable' => [
        'model' => \App\Models\User::class, // The model to use for mentions
        'column' => [
            'id' => 'id', // Unique identifier for the user
            'display_name' => 'name', // Display name for the mention
            'username' => 'username', // Username for the mention
            'avatar' => 'profile', // Avatar field (e.g. profile picture URL)
        ],
        'url' => 'admin/users/{id}', // this will be used to generate the url for the mention item
        'lookup_key' => 'username', // Used for static search (key in the dataset)
        'search_column' => 'username', // this will be used on dynamic search 
    'default' => [
        'trigger_with' => ['@', '#', '%'], // Characters to trigger mentions
        'trigger_configs' => [
            '@' => [
                'prefix' => '',
                'suffix' => '',
                'title_field' => 'name',
                'hint_field' => null,
            ],
            '#' => [
                'prefix' => '',
                'suffix' => '',
                'title_field' => 'name',
                'hint_field' => null,
            ],
            '%' => [
                'prefix' => '%',
                'suffix' => '%',
                'title_field' => 'title',
                'hint_field' => null,
            ],
        ],
        'menu_show_min_length' => 0, // Minimum characters to type before showing suggestions
        'menu_item_limit' => 10, // Maximum number of suggestions to display
        'prefix' => '', // Default prefix for all mentions
        'suffix' => '', // Default suffix for all mentions
        'title_field' => 'title', // Default field to use for title display
        'hint_field' => null, // Default field to use for hint display
    ],
];

Key Configuration Options:

mentionable.model: The Eloquent model to use for mentions (e.g. User).
mentionable.column: Map the fields to use for mentions (e.g. id, name, etc.).
mentionable.url: URL pattern for the mention item (e.g. admin/users/{id}).
mentionable.lookup_key: Used for static search (key in the dataset).
mentionable.search_column: Used for dynamic search (database column).
default.trigger_with: Character to trigger mentions (e.g. @).
default.menu_show_min_length: Minimum characters to type before showing suggestions.
default.menu_item_limit: Maximum number of suggestions to display.
mentionable.model: The Eloquent model to use for mentions (e.g. User).
mentionable.column: Map the fields to use for mentions (e.g. id, name, etc.).
mentionable.url: URL pattern for the mention item (e.g. admin/users/{id}).
mentionable.lookup_key: Used for static search (key in the dataset).
mentionable.search_key: Used for dynamic search (database column).
default.trigger_with: Character(s) to trigger mentions (e.g. @, #, %). Can be a string or an array.
default.trigger_configs: Configuration for specific trigger characters.
default.menu_show_min_length: Minimum characters to type before showing suggestions.
default.menu_item_limit: Maximum number of suggestions to display.
default.prefix: Default prefix to add before mentions.
default.suffix: Default suffix to add after mentions.
default.title_field: Default field to use for title display in dropdown.
default.hint_field: Default field to use for hint display in dropdown.

Recommendations:

Use cache to store the mentionable data for static search.
Add indexes to the columns used for dynamic search.
If you are use mention editor inside the modal, please disable grammarly extension by disableGrammarly().

Usage

1. Static Search

Static search preloads all mentionable data and searches within that dataset. For static search you can you RichMentionEditor field.

The RichMentionEditor fetch all the mentionable data first and then search the mention item from the fetched data.

use Asmit\Mention\Forms\Components\RichMentionEditor;

RichMentionEditor::make('bio')
    ->columnSpanFull(),

You can also change the data by pass the closure function mentionableItems in the RichMentionEditor field.

example:

use Asmit\FilamentMention\Forms\Components\RichMentionEditor;
use Asmit\FilamentMention\Dtos\MentionItem;

RichMentionEditor::make('comments')
    ->key(fn () => rand())
    ->disableGrammarly()
    ->lookupKey('username')
    ->mentionableItems(function () {
        return User::all()->map(function ($user) {
            return (new MentionItem(
                id: $user->id,
                username: $user->username,
                displayName: $user->name,
                avatar: $user->profile,
                url: '/users/admin'.$user->id,
            ));
        })->toArray();
    }),

Key Points

The mentionableItems method should return an array of mentionable items.
The most convenient way to use the mentionableItems method is to use the MentionItem DTO.
Use the lookup_key to search the mentionable item. You can change the lookup_key with chaining the method lookupKey in the RichMentionEditor field.

NOTE: If you not use mentionableItems then it will use the configuration from config file.

2. Dynamic Search

To enable this feature you need to use the HasMentionableForm in to your livewire page.

use \Asmit\FilamentMention\Concerns\HasMentionableForm

class FilamentPage {
    use HasMentionableForm;
    // ...
}

Next, you can search the mentionable data from the database using the getMentionableItemsUsing method in the RichMentionEditor field.

use Asmit\FilamentMention\Forms\Components\RichMentionEditor;
use Asmit\FilamentMention\Dtos\MentionItem;

RichMentionEditor::make('comments')
    ->key(fn () => rand())
    ->lookupKey('username')
    ->disableGrammarly()
    ->placeholder('Write your comment here...')
    ->getMentionableItemsUsing(function ($query) {
        return User::search($query)
            ->get()
            ->map(function ($user) {
                return new MentionItem(
                    id: $user->id,
                    username: $user->username,
                    displayName: $user->name,
                    avatar: $user->profile,
                    url: '#');
            })->toArray();
    })

Pluck

The plugin allows you to extract specific fields from the mentioned user. You can use the pluck method to extract the fields. This feature helps you to customize the mention output according to your needs.

use \Asmit\FilamentMention\Forms\Components\RichMentionEditor;

RichMentionEditor::make('note')
    ->pluck('id')
    ->getMentionableItemsUsing(function ($query) {
        return User::search($query)
                ->get()
                ->map(function ($user) {
                    return new MentionItem(
                        id: $user->id,
                        username: $user->username,
                        displayName: $user->name,
                        avatar: $user->profile,
                        url: '#');
                })->toArray();
        })

The pluck method accepts the key to extract the field from the mentioned user. The key should be id or username. It extracts the data from the MentionItem and return the data in the array format.

It will add the new data attribute named mentioned_[YOUR PLUCK LEY]. If you inspect the data it will return like

    [
        'note' => [
            'state' => 'your comment message'
            'mentioned_id' => [
                0 => 1,
                1 => 2,
                2 => 3,
            ]
    ]

Advanced Features

Multiple Trigger Characters

You can use different characters to trigger different types of mentions. This is useful when you want to mention different types of entities (e.g., users, tags, variables).

RichMentionEditor::make('content')
    ->triggerWith(['@', '#', '%'])

You can also configure each trigger character separately:

RichMentionEditor::make('content')
    ->triggerWith(['@', '#', '%'])
    ->triggerConfigs([
        '@' => [
            'lookupKey' => 'username',
            'prefix' => '',
            'suffix' => '',
            'title_field' => 'name',
            'hint_field' => 'email',
        ],
        '#' => [
            'lookupKey' => 'tag',
            'prefix' => '#',
            'suffix' => '',
            'title_field' => 'name',
            'hint_field' => null,
        ],
        '%' => [
            'lookupKey' => 'name',
            'prefix' => '%',
            'suffix' => '%',
            'title_field' => 'title',
            'hint_field' => null,
        ],
    ])

Global Object Search

The plugin now supports searching across all properties of an object without requiring a specific lookup key. This makes it easier to find matches regardless of which field contains the search text.

RichMentionEditor::make('content')
    ->menuShowMinLength(0) // Show all items immediately

Prefix and Suffix

You can add custom text before and after mentions. This is particularly useful for variables or special formatting.

RichMentionEditor::make('content')
    ->prefix('%')
    ->suffix('%')

You can also configure prefix and suffix for specific trigger characters:

RichMentionEditor::make('content')
    ->triggerWith(['@', '%'])
    ->triggerConfigs([
        '@' => [
            'prefix' => '',
            'suffix' => '',
        ],
        '%' => [
            'prefix' => '%',
            'suffix' => '%',
        ],
    ])

Customizable Title and Hint Fields

You can configure which fields to use for the title and hint in the dropdown menu:

RichMentionEditor::make('content')
    ->titleField('name')
    ->hintField('email')

Or for specific trigger characters:

RichMentionEditor::make('content')
    ->triggerWith(['@', '%'])
    ->triggerConfigs([
        '@' => [
            'title_field' => 'name',
            'hint_field' => 'email',
        ],
        '%' => [
            'title_field' => 'title',
            'hint_field' => null,
        ],
    ])

Example: Variables with Prefix and Suffix

Here's an example of using the plugin to insert variables with % prefix and suffix:

RichMentionEditor::make('content')
    ->triggerWith('%')
    ->prefix('%')
    ->suffix('%')
    ->menuShowMinLength(0)
    ->mentionsItems([
        [
            'id' => 1,
            'title' => 'SALUTATION',
            'value' => 'salutation',
        ],
        [
            'id' => 2,
            'title' => 'FIRST_NAME',
            'value' => 'firstName',
        ],
        // More variables...
    ])

Credits

Asmit Nepal
Kishan Sunar
Jordan Humphreys (Creator of TributeJs)

Security

If you discover a security vulnerability within this package, please send an e-mail to asmitnepali99@gmail.com, All security vulnerabilities will be promptly addressed.

🤝 Contributing

Please see CONTRIBUTING for details.

📄 License

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

Made with love by Asmit Nepali

asmit / filament-mention

Maintainers

Details