README

Filament Quick Notes adds user-owned quick notes to your Filament panel. Users can add a note from a floating action anywhere in the panel, then manage their own notes from a lightweight Livewire page.

Installation

You can install the package via composer:

composer require subham/filament-quick-notes

You can publish and run the migrations with:

php artisan vendor:publish --tag="filament-quick-notes-migrations"
php artisan migrate

You can publish the config file with:

php artisan vendor:publish --tag="filament-quick-notes-config"

This is the contents of the published config file:

return [
    'page' => [
        'enabled' => true,
        'slug' => 'quick-notes',
        'navigation_label' => 'Quick Notes',
        'navigation_group' => null,
        'navigation_icon' => 'heroicon-o-pencil-square',
        'navigation_sort' => null,
        'model_label' => 'quick note',
        'plural_model_label' => 'quick notes',
    ],

    'table_name' => 'quick_notes',

    'user' => [
        'foreign_key' => 'user_id',
        'model' => config('auth.providers.users.model', App\Models\User::class),
    ],

    'floating_action' => [
        'enabled' => true,
        'render_hook' => 'body.end',
        'label' => 'Add note',
        'icon' => 'heroicon-o-pencil-square',
    ],

    'dashboard_widget' => [
        'enabled' => false,
        'show' => 'pinned',
        'heading' => 'Quick Notes',
        'view_all_label' => 'View all',
        'view_all_icon' => 'heroicon-m-arrow-top-right-on-square',
        'records_per_page' => 5,
        'sort' => 1,
    ],

    'fields' => [
        'title' => [
            'enabled' => true,
            'required' => false,
            'max_length' => 255,
        ],
        'body' => [
            'required' => true,
            'max_length' => 5000,
            'rows' => 6,
        ],
        'color' => [
            'enabled' => false,
            'options' => [
                'gray' => 'Gray',
                'blue' => 'Blue',
                'green' => 'Green',
                'yellow' => 'Yellow',
                'red' => 'Red',
                'purple' => 'Purple',
            ],
            'default' => 'gray',
        ],
        'pinned' => [
            'enabled' => true,
            'default' => false,
        ],
    ],
];

Usage

Register the plugin in your Filament panel provider:

use Subham\FilamentQuickNotes\FilamentQuickNotesPlugin;

public function panel(Panel $panel): Panel
{
    return $panel
        // ...
        ->plugin(FilamentQuickNotesPlugin::make());
}

After registration, a floating Add note action appears in the panel and a configurable Quick Notes page appears in navigation. Notes are scoped to the current Filament authenticated user through the configured user foreign key.

You can move the quick-add action by changing floating_action.render_hook. Short names like body.end, topbar.end, and user-menu.before are supported, or you may pass a raw Filament render hook string such as panels::body.end.

Notes are listed newest first. The dashboard table widget is opt-in with dashboard_widget.enabled; set dashboard_widget.show to all, pinned, or none. Color is disabled by default because most quick-note flows do not need it, but it can be enabled when users want simple categorization.

Testing

composer test

Changelog

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

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

• Subham Sharma
• All Contributors

License

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