filament-right-click - GitLite

KO | EN

gitlite — search

#vue #anthropic #nodejs #large-language-models #data-science #proxy #ui #tensorflow #dotnet #csharp

filament-right-click

(★ 39)

Right-click table row menus for Filament panels that trigger native Filament actions.

File Explorer

ZIP Download

- - code-style.yml
  - run-tests.yml
- dependabot.yml
- cover.jpg
- screenshot.png
- - filament-right-click.css
- - filament-right-click.css
  - filament-right-click.js
- - filament-right-click.js
- - ContextMenuEntry.php
- - RegisterMacros.php
- - ContextMenuItem.php
  - ContextMenuSection.php
  - ContextMenuSeparator.php
  - ContextMenuSubmenu.php
- FilamentRightClickPlugin.php
- FilamentRightClickServiceProvider.php
- - FakeTableComponent.php
- ContextMenuTest.php
- FlowforgeContextMenuTest.php
- Pest.php
- PluginTest.php
- TestCase.php
.gitattributes
.gitignore
composer.json
LICENSE
package-lock.json
package.json
phpunit.xml
pint.json
README.md
SECURITY.md
vite.config.js

# Use via CDN

jsDelivr

jsDelivr serves any public GitHub repository as a CDN with zero setup. Pick a version and a file to get a ready-to-paste link and snippet.

Version

File

Link

Example

Command Glossary

Commands referenced in this DOCs, explained below.

🔍

`composer`

View Details ▼

A package-based dependency manager for PHP projects.

composer init

Interactively create a `composer.json` file:

composer require {{user/package}}

Add a package as a dependency for this project, adding an entry to `composer.json`:

composer install

Install all the dependencies in this project's `composer.json` and create `composer.lock`:

🔍

`php artisan`

View Details ▼

Laravel's Artisan command-line interface.

php artisan serve

Start PHP's built-in web server for the current Laravel application:

php artisan tinker

Start an interactive PHP command-line interface:

php artisan make:model {{ModelName}} --all

Generate a new Eloquent model class with a migration, factory, and resource controller:

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

Right-click table row and Flowforge card menus for Filament panels.

This package adds a static right-click menu to Filament table records and, when Flowforge is installed, Kanban board cards. Menu items trigger native Filament actions, so action modals, confirmation, authorization, validation, notifications, redirects, and server-side disabled/hidden checks remain owned by Filament.

## Installation

```bash
composer require leek/filament-right-click
php artisan filament:assets
```

Register the plugin on the panels that should support right-click menus:

```php
use Leek\FilamentRightClick\FilamentRightClickPlugin;

$panel
    ->plugin(FilamentRightClickPlugin::make());
```

## Usage

Use `contextMenuActions()` for single-record row menu items and `contextMenuBulkActions()` for selected-record menu items:

```php
use Filament\Actions\Action;
use Filament\Actions\BulkAction;
use Filament\Actions\DeleteAction;
use Filament\Support\Icons\Heroicon;
use Filament\Tables\Table;
use Leek\FilamentRightClick\Menu\ContextMenuItem;
use Leek\FilamentRightClick\Menu\ContextMenuSection;
use Leek\FilamentRightClick\Menu\ContextMenuSeparator;

public static function table(Table $table): Table
{
    return $table
        ->columns([
            // ...
        ])
        ->contextMenuActions([
            ContextMenuSection::make([
                ContextMenuItem::for(
                    Action::make('archive')
                        ->requiresConfirmation()
                        ->action(fn ($record) => $record->archive()),
                )
                    ->label('Archive')
                    ->icon(Heroicon::ArchiveBox)
                    ->color('warning'),
            ])->label('Manage'),

ContextMenuSeparator::make(),

ContextMenuItem::for(DeleteAction::make())
                ->label('Delete')
                ->icon(Heroicon::Trash)
                ->color('danger'),
        ])
        ->contextMenuBulkActions([
            ContextMenuItem::forBulkAction(
                BulkAction::make('archiveSelected')
                    ->label('Archive Selected')
                    ->requiresConfirmation()
                    ->action(fn ($records) => $records->each->archive()),
            )
                ->icon(Heroicon::ArchiveBox)
                ->color('warning'),
        ]);
}
```

The wrapped actions are registered as table actions, but they are not rendered in the normal row action column. On click, the package calls Filament's table action mounting path for the row record key.

Bulk actions are registered as table bulk actions without rendering in the normal bulk action dropdown. When the right-clicked row is already selected, the bulk menu uses the current Filament selection, including select-all-across-pages state. When the right-clicked row is not selected, the single-record menu opens instead.

### Flowforge cards

If `relaticle/flowforge` is installed, the plugin also registers a `contextMenuCardActions()` macro on Flowforge boards:

```php
use Filament\Actions\Action;
use Filament\Support\Icons\Heroicon;
use Leek\FilamentRightClick\Menu\ContextMenuItem;
use Relaticle\Flowforge\Board;

public function board(Board $board): Board
{
    return $board
        ->query(Task::query())
        ->columns([
            // ...
        ])
        ->recordActions([
            // Visible card actions...
        ])
        ->contextMenuCardActions([
            ContextMenuItem::for(
                Action::make('viewTask')
                    ->label('View Task')
                    ->action(fn ($record) => $this->viewTask($record)),
            )
                ->icon(Heroicon::Eye),

ContextMenuItem::for(
                Action::make('archiveTask')
                    ->requiresConfirmation()
                    ->action(fn ($record) => $record->archive()),
            )
                ->label('Archive')
                ->icon(Heroicon::ArchiveBox)
                ->color('warning'),
        ]);
}
```

Flowforge card context actions are registered with Filament's action cache, but they are not added to Flowforge's visible card action group. On click, the package calls Flowforge's native card action mounting path with the card's `recordKey`.

### Nested submenus

Use `ContextMenuSubmenu` for Linear-style flyouts. The parent row is **not** an action — it only opens a child menu. Nested leaf items still mount the same Filament action paths as top-level items. Submenus may nest further submenus, sections, separators, and items.

```php
use Filament\Actions\Action;
use Filament\Support\Icons\Heroicon;
use Leek\FilamentRightClick\Menu\ContextMenuItem;
use Leek\FilamentRightClick\Menu\ContextMenuSeparator;
use Leek\FilamentRightClick\Menu\ContextMenuSubmenu;

->contextMenuCardActions([
    ContextMenuSubmenu::make([
        ContextMenuItem::for(Action::make('setStatusTodo')->action(...))
            ->label('Todo')
            ->icon(Heroicon::CircleStack),
        ContextMenuItem::for(Action::make('setStatusDone')->action(...))
            ->label('Done')
            ->icon(Heroicon::CheckCircle),
    ])
        ->label('Status')
        ->icon(Heroicon::Flag),

ContextMenuSubmenu::make([
        ContextMenuItem::for(Action::make('setPriorityHigh')->action(...))
            ->label('High')
            ->color('warning'),
        ContextMenuItem::for(Action::make('setPriorityLow')->action(...))
            ->label('Low'),
    ])
        ->label('Priority')
        ->icon(Heroicon::Signal),

ContextMenuSeparator::make(),

ContextMenuItem::for(Action::make('assign')->action(...))
        ->label('Assign')
        ->icon(Heroicon::UserPlus),
]);
```

Keyboard: `ArrowRight` / `Enter` opens a submenu, `ArrowLeft` / `Escape` closes it, arrow keys move within the active panel. Pointer: hover or click the parent row to open the flyout; leaving parent + flyout closes it.

`ContextMenuSection` remains an **inline** labeled group (children render in the same panel). Prefer `ContextMenuSubmenu` when the option list should stay off the root menu until requested.

### Trigger a workflow (Filament Workflow Engine)

Because context menu items wrap native Filament actions, any action works — including the `TriggerWorkflowAction` shipped by [Filament Workflow Engine](https://filamentphp.com/plugins/leek-workflow-engine). If `leek/filament-workflows` is installed, drop it into a row menu to let users run a manual workflow against the right-clicked record:

```php
use Filament\Support\Icons\Heroicon;
use Leek\FilamentRightClick\Menu\ContextMenuItem;
use Leek\FilamentWorkflows\Filament\Actions\TriggerWorkflowAction;

->contextMenuActions([
    ContextMenuItem::for(
        TriggerWorkflowAction::make(),
    )
        ->label('Run Workflow')
        ->icon(Heroicon::Play),
]);
```

The action opens Workflow Engine's own modal, filtered to manual workflows configured for that record's model, and queues the run — all authorization, rate limiting, and notifications stay owned by the Workflow Engine. No wiring is required beyond installing both packages.

## Screenshot

<p align="center">
    <img src="art/screenshot.png" alt="Filament Right Click table row context menu screenshot">
</p>

## Behavior

- Right-click opens the menu anywhere on a table row except existing interactive controls.
- The browser context menu is only suppressed for rows in tables with configured right-click actions.
- `ContextMenu` keyboard key and `Shift+F10` open the menu for the focused or last-hovered row.
- `Escape` closes the menu, arrow keys move through items, and `Enter` / `Space` trigger the focused item.
- Touch and long-press gestures are intentionally not included in v1.

## Static menu, server-enforced actions

The menu label, icon, and color are static metadata on `ContextMenuItem`. The underlying Filament action still decides whether the operation can run for the specific record.

If a right-click item points to an action that is hidden, disabled, or unauthorized for a row, Filament will refuse to mount it. The menu closes and no client-side policy decision is made.

## Asset loading

Assets are registered as `loadedOnRequest()` and are requested only by tables that use `contextMenuActions()` or `contextMenuBulkActions()`.

If you publish or bundle assets in your own build pipeline, keep the DOM contract intact:

- table root record menu: `data-filament-right-click-record-config`
- table root bulk menu: `data-filament-right-click-bulk-config`
- legacy table root record menu: `data-filament-right-click-config`
- Flowforge board card menu: `data-filament-right-click-flowforge-card-config`
- row key source: Filament's native row `wire:key`
- Flowforge card key source: `data-card-id`
- record action call: `mountTableAction(actionName, recordKey)`
- Flowforge card action call: `mountAction(actionName, [], { recordKey })`
- bulk action call: synchronize Filament's selected table record properties, then mount the bulk action

## Bulk actions

Use `contextMenuBulkActions()` with `ContextMenuItem::forBulkAction()` or pass a `BulkAction` directly:

```php
use Filament\Actions\BulkAction;
use Leek\FilamentRightClick\Menu\ContextMenuItem;

$table->contextMenuBulkActions([
    ContextMenuItem::forBulkAction(
        BulkAction::make('deleteSelected')
            ->label('Delete Selected')
            ->requiresConfirmation()
            ->action(fn ($records) => $records->each->delete()),
    )
        ->color('danger'),
]);
```

Bulk actions are still server-enforced by Filament. Hidden, disabled, and unauthorized actions will not mount.

## Compatibility

This package targets Filament v4 and v5.

Flowforge support is optional and is registered only when `Relaticle\Flowforge\Board` exists.

Record actions use Filament's table action mounting path. Bulk actions use the newer unified `mountAction()` path when available and fall back to Filament's table bulk action compatibility method.

## More Filament plugins by Leek

**Premium**

- [**Filament UI Plus**](https://filamentphp.com/plugins/leek-ui-plus) — Enhanced UI components: dual sub-navigation, animated sidebar, horizontal-scroll tables, loading bar, and more.
- [**Filament Workflow Engine**](https://filamentphp.com/plugins/leek-workflow-engine) — Automated workflows with a visual builder, triggers/actions, async execution, and audit logging.
- [**Filament Decision Tables**](https://filamentphp.com/plugins/leek-decision-tables) — Business rules engine with spreadsheet-style decision tables.

**Free & open source**

- [**Filament Header Filters**](https://github.com/leek/filament-header-filters) — Inline filters attached to table column headers.
- [**Filament Subtenant Scope**](https://github.com/leek/filament-subtenant-scope) — Second-level tenancy scoping via a topnav dropdown.
- [**Filament DiceBear**](https://github.com/leek/filament-dicebear) — DiceBear avatar provider with 31 styles.