- How do I add Filament Quick Notes to an existing Laravel + Filament project?
- Run `composer require rarq/filament-quick-notes` followed by `php artisan filament-quick-notes:install`. This publishes the config, migrations, and adds the trait to your User model. Ensure your Filament version (3–5) matches the package compatibility table.
- Can I customize the position of the sticky notes panel in Filament?
- Yes, the plugin supports configurable placement via the config file. You can position it in the topbar, search bar, or other Filament panel regions without modifying core logic. Check the `config/filament-quick-notes.php` file after installation.
- Will this package work with Laravel Sanctum or multi-tenancy setups like Breeze or Jetstream?
- Absolutely. The package uses polymorphic relations, so it works seamlessly with custom user models (e.g., `TenantUser`) or auth systems like Sanctum. Just ensure your model includes the `HasFilamentQuickNotes` trait.
- Does Filament Quick Notes support markdown or rich text in note content?
- Currently, notes use plain text input. For markdown or rich text, you’d need to extend the package by overriding the note content field in the plugin’s resources or fork the package to include a custom editor like TinyMCE or CKEditor.
- How does staged editing work, and can I disable it?
- Staged editing lets users preview changes before saving, reducing database writes. It’s enabled by default but can be disabled in the config file under `staged_editing`. Disabling it may increase write operations but simplifies the workflow.
- Are notes shared across users or only visible to the authenticated user?
- Notes are strictly user-specific and tied to the authenticated user via polymorphic relations. There’s no built-in sharing or collaboration feature, but you could extend the package to add role-based or team-based visibility if needed.
- What happens if I upgrade/downgrade Filament versions? Will this break Quick Notes?
- The package supports Filament 3–5, but major version changes (e.g., 3 → 4) may require testing due to Filament’s breaking updates. Always check the compatibility table and test in staging before deploying. Pin your Filament version in `composer.json` if stability is critical.
- Can I use this package in a Laravel Livewire or Inertia.js frontend?
- No, Quick Notes is designed exclusively for FilamentPHP admin panels. Notes are panel-bound and lack an API for external access. If you need sticky notes in a Livewire/Inertia frontend, consider a separate package like `beyondcode/laravel-notes`.
- How do I handle unsaved notes if a user closes the browser or navigates away?
- The plugin includes an unsaved-changes guard that prompts users to confirm before leaving the panel. For full-page navigation, you’ll need to handle this via JavaScript (e.g., `beforeunload` events) or rely on Filament’s built-in dialogs.
- Are there any performance concerns with large numbers of notes per user?
- The package is optimized for lightweight use. Staged editing minimizes database writes, and notes are user-scoped. However, if a user creates thousands of notes, consider adding pagination or archiving old notes via custom queries or a separate table.