Search by

aristonis / filament-shortcut-keys

mekadalibrahem

Keyboard shortcuts for a Filament panel, assigned automatically from its resources, pages, actions and tables.

Package info

github.com/aristonis/filament-shortcut-keys

Documentation

pkg:composer/aristonis/filament-shortcut-keys

Fund package maintenance!

aristonis

Statistics

Installs: 6

Dependents: 0

Suggesters: 0

Stars: 0

Open Issues: 0

v1.2.0 2026-11-22 16:50 UTC

This package is auto-updated.

Last update: 2026-11-22 16:54:22 UTC


README

Filament Shortcut Keys

Latest Version on Packagist Total Downloads PHP Version Filament Laravel License

tests database js tests phpstan code style Docs

Keyboard shortcuts for a Filament panel, assigned automatically. The plugin walks the panel's registered resources, pages, and actions, gives each one a letter, and injects the resulting keymap into every page. There is no per-resource wiring: add a resource and it gets a shortcut.

Admins can remap or disable their own keys, and a developer you trust can edit the shared map that everyone else starts from.

Status: 1.0. Filament 4 or 5 on Laravel 12 and 13, PHP 8.2 or newer.

Install

composer require aristonis/filament-shortcut-keys
php artisan vendor:publish --tag="filament-shortcut-keys-migrations"
php artisan migrate

The migrations store admins' own keys and shared presets. If you set keys only in the config file ('customization' => 'config'), nothing is stored and you can skip them.

Register the plugin on your panel:

use Aristonis\FilamentShortcutKeys\FilamentShortcutKeysPlugin;

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

Then publish the client script:

php artisan filament:assets

Run it once after registering the plugin, even on an app set up with filament:install: its filament:upgrade hook ran during composer require, before the plugin was on a panel, so it published nothing for it. After that, the hook republishes the script on every composer install or update; without the hook, run php artisan filament:assets after every update. See the Getting started guide.

Documentation — two audiences

  • For developers → documentation site — human guides: getting started, the shortcuts, row actions, customization, custom bindings, configuration, pruning, translations, security, troubleshooting and limitations.
  • For AI agents → Laravel Boost — the package ships Boost guidelines and skills in resources/boost/. Pick the package when the interactive php artisan boost:install asks for third-party packages, or add it to boost.json under packages and run boost:install again; your coding agent then loads the guideline and the filament-shortcut-keys-* skills.

What it does

  • Shortcuts with no wiring. Every registered resource and page gets a G-then-letter navigation key, header actions get bare letters, and every table gets the same fixed keys: / search, J/K row cursor, Space select, Enter edit, Delete delete, arrows to move and page.
  • Keys that stay out of the browser's way. Nothing is held down by default, keys match the physical key on any layout, and nothing fires while you type or while a modal, menu or select has the keyboard.
  • Safe defaults. A header action is keyed only when a stray press is harmless (it opens a page, a modal or a confirmation); hidden and disabled actions get no key.
  • Row actions you name (->rowActions(['approve', 'reject'])) get one stable letter across the panel, including relation manager and table widget tables.
  • Real controls, real permissions. A shortcut clicks the Filament control or follows the route you would have used, so authorization and confirmations stay Filament's.
  • Customization. personal mode lets each admin remap, disable and add their own bindings; locked gives everyone one shared map. A trusted admin, behind a gate you supply, edits the shared presets. config mode takes keys from the config file alone and needs no database.
  • Discoverability and accessibility. A ? cheatsheet, a reference page, key badges with aria-keyshortcuts, and a switch that turns single-key shortcuts off per browser.
  • Maintenance. shortcut-keys:prune removes stored overrides whose target no longer exists.

Testing

composer test   # PHP suite on SQLite; FSK_DB_DRIVER=pgsql|mysql runs it on a real driver
npm test        # browser client, on node alone

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

License

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