Product Decisions This Supports
- Accelerating admin panel usability: Delivers a Spotlight-style command palette (⌘K/Ctrl+K) to reduce navigation friction in Filament panels, directly addressing user pain points in complex workflows (e.g., SaaS dashboards, internal portals). Aligns with product goals to minimize cognitive load for power users.
- Justifying Filament adoption: Provides a pre-built, high-impact feature that differentiates Filament-based admin panels from custom-built alternatives. Reduces dev time for "nice-to-have" UX upgrades.
- Custom workflows without custom dev: Enables product-specific shortcuts (e.g., "Create Invoice," "Impersonate User") via the
SpotlightAction API, eliminating the need for bespoke frontend development.
- Build vs. buy tradeoff: Avoids reinventing a search UX wheel; leverages a maintained, battle-tested package (3 stars, active releases) to deliver a polished feature in hours vs. weeks.
- Roadmap prioritization: Serves as a low-risk, high-reward UX upgrade for Filament panels, with minimal dependencies and no breaking changes. Ideal for A/B testing or gradual rollout.
When to Consider This Package
-
Adopt if:
- Your Filament panel has ≥5 resources/pages and users report navigation inefficiencies (e.g., "It takes too long to find records").
- You prioritize keyboard-driven workflows (e.g., for accessibility, power-user efficiency, or CLI-like interactions).
- Your team lacks frontend resources to build a custom search overlay but wants a Spotlight/VS Code-like experience.
- You’re using Filament v3+ and already have
GlobalSearchProvider implemented (records auto-populate).
- You need client-side persistence (recent/pinned items) without server-side complexity.
- Your stakeholders value quick wins with minimal dev effort (installation + optional config).
-
Look elsewhere if:
- Your panel is simple (e.g., <3 resources) and the default top-bar search suffices.
- You need server-side analytics on search queries (this package tracks nothing).
- Your team requires deep customization (e.g., multi-column layouts, advanced filtering) beyond the provided API.
- You’re using Filament v2 or a non-Tailwind theme (compatibility risks).
- You need multi-language support beyond English/Central Kurdish (translations are minimal).
- Your users prefer mouse-driven navigation (this package is keyboard-first).
How to Pitch It (Stakeholders)
For Executives/Stakeholders:
*"This package lets us supercharge navigation in our admin panels with a Spotlight-style search—just like macOS or VS Code—in under an hour. For users managing [X] resources or [Y] pages, it’ll cut their search time from 30 seconds to 2 seconds by letting them type ⌘K and jump directly to records, pages, or actions.
Why now?
- Zero dev overhead: Plugs into our existing Filament setup with one line of code.
- Proven UX: Mimics tools users already love (e.g., GitHub’s command palette).
- Scalable: Works today for [Panel A] and can roll out to all Filament panels later.
Ask: ‘Would you prioritize this as a UX upgrade for [target user group], given the minimal effort?’"
For Engineering Teams:
*"This is a Filament plugin that adds a full-screen, keyboard-driven search overlay (⌘K) with these key benefits:
- Zero backend work: Uses Filament’s
GlobalSearchProvider for records; no DB changes.
- Customizable: Toggle categories (records, resources, pages, actions), exclude resources, or add custom actions (e.g., ‘Clear Cache’) via a fluent API.
- Lightweight: ~500 LOC, client-side persistence (localStorage), and Tailwind-compatible.
- Extensible: Hook into the
SpotlightAction registry or build custom categories (e.g., for settings or reports).
Tradeoffs:
- Tailwind users must update their CSS scan config (1 line).
- No server-side analytics (but we can log client-side events separately if needed).
Proposal:
- Install in [Panel X] to test with [target user group].
- If adoption is high, enable it globally for all Filament panels.
Effort: 1 day (install + config).
Ask: ‘Should we scope this for [specific panel] first, or enable it globally from day one?’"*
For Design/UX Teams:
*"This package replaces the clunky top-bar search with a modern, discoverable command palette—think of it as Google Search for our admin tools. Key UX wins:
- Keyboard-first: ⌘K/Ctrl+K opens a full-screen overlay (like VS Code).
- Preview pane: Hover to see record details without leaving the search.
- Recent/pinned: Users can save frequent destinations (client-side, no DB).
- Customizable: Add icons, keywords, or groups to match our design system.
Ask: ‘Does this align with our [design system] or [accessibility] goals? Should we customize the placeholder/text?’"*