Repository navigation
Releases
v0.6.2
v0.6.1
Fixed
- More space between the Back link and the level title (0.25rem to 0.75rem), and a little more below the header.
- Docs: all screenshots, the journey strip and the banner retaken with the new spacing.
Changed
- CI runs on GitHub-hosted runners (
ubuntu-latest), including pull requests from forks; the workflow token is read-only.
v0.6.0
Documentation and repository
- A real plugin-library layout: a new README (banner, badges, feature table, screenshots, requirements, installation, quick start), a
docs/folder with an index, an FAQ, upgrade notes per release, an API reference generated from the code, and the long README sections moved into focused guides (usage, modern navigation, large menus, render hooks, panels/workers/tenants/languages, the demo, testing). - A support matrix (
docs/support.md): Filament v5 only, with the supported Filament, PHP, Laravel, Livewire and Octane versions. A test keeps it,composer.json, the README and the CI job in step; another keeps the generated API reference current and checks every relative link and image. LICENSE(MIT),CODE_OF_CONDUCT.md,.gitattributes(the Composer dist leaves out the demo, tests, screenshots and CI files), completecomposer.jsonmetadata (keywords, homepage, support links).- The docs no longer use the old "agent" example; code samples use projects, tasks and documents.
- The repository is public from this release.
Changed
- Every read accessor on
NavItemandDrilldownNavPluginis tagged@internal(43 methods): they serve the sidebar view and its Livewire endpoints and may change.docs/api-stability.mdhas the freeze review and the decisions left before 1.0.0-rc1. - The Pinned list moved to the top of the top level (it was below the menu). Recent stays below.
- The open/closed state of inline sections is stored in a
fi-drilldown-opencookie (excluded from cookie encryption, validated when read) instead oflocalStorage, and rendered on the server: a closed section no longer shows open until JavaScript starts. Previously stored states are not carried over.
Fixed
- Content from the sidebar's render hooks was not hidden in the collapsed (icon-only) sidebar, so free text widened the icon rail (to about 250 px in the demo). Hook output is now wrapped in
.fi-drilldown-hookand shown only while a collapsible sidebar is open.
Added
- Record menus with less code:
NavItem::resource(X)->recordPages()builds a record's menu from the resource's own record pages (labels, icons, badges and access from each page, as Filament builds a record's sub-navigation); or implementContracts\HasDrilldownRecordMenuon the resource. Demo: the newautopanel. - Live updates:
DrilldownNavPlugin::pollBadges('30s')re-renders the sidebar on an interval;refresh-sidebarkeeps working. - Search across all levels:
searchable(allLevels: true)also lists matching pages from levels that are not open ("In other menus", with their trail), from an index loaded over Livewire on first use./focuses the search box (shortcut:to change or turn off). DrilldownNavPlugin::flatten()andDrilldownNavPlugin::current(): the whole menu the user may see as a flat list (label, URL, trail, depth), for command palettes or a mobile bottom bar.- Pinned pages in the database:
pinnable(database: true)(optionalmodel:) stores pins per user, panel and tenant in adrilldown_nav_pinstable (publishable migration), renders them on the server and syncs them across devices. URLs are checked to be paths under the panel; at most 20 pins; labels follow renamed pages. DrilldownNavPlugin::accordion(): one inline section open at a time.- Release hygiene:
SECURITY.md,CONTRIBUTING.md, issue and pull request templates, and areleaseworkflow that creates the GitHub release from the tag's changelog section (and fails when there is none;bin/changelog-section.sh). docs/compatibility.md: checked next to Hover Sidebar, Sidebar Resize, Refresh Sidebar, Mobile Bottom Nav and Collapsible Sub-Nav (all work; Hover Sidebar and Sidebar Resize conflict with each other).
v0.5.0
PHPStan level 10, render hooks, a lower Filament minimum, and checks that a real worker under load never mixes up users.
Upgrade notes: the minimum Filament is now 5.7 (it was 5.10; that was a guess from failures that came from the tests, not the plugin). Filament below 5.8.3 has published security advisories: run a patched Filament.
Added
- Render hooks:
DrilldownNavHook::NAV_START,NAV_END,HEADER_BEFORE,HEADER_AFTER,LIST_BEFORE,LIST_AFTER: Filament render hooks around the drill-down menu, scoped to the panel and carryingplugin,panel,depthandtitleas data. Register them the Filament way ($panel->renderHook()/FilamentView::registerRenderHook()). - Locales: Hebrew (
he), Persian (fa) and Urdu (ur), so every right-to-left locale Filament ships with a layout direction for (Arabic, Hebrew, Persian, Urdu) has the plugin's own strings. (Machine-written; a native-speaker review is welcome.) - Pinned pages clean up after themselves: once a day a pinned page that no longer opens (deleted record, lost access: 403/404/410) is dropped, and a renamed page's label is refreshed.
- Concurrency check: the Octane smoke test now also runs against four workers with parallel requests (300 requests from two users across three panels; every response must belong to its user and panel).
Changed
- PHPStan level 10 (was 9), still with no ignores and no baseline.
- Minimum Filament is 5.7 (was 5.10, which was a guess from failures that turned out to come from the tests, not the plugin). Verified on 5.7.0 (all 81 demo tests and the real-server smoke test). Below 5.7 the plugin still renders but Filament's own items lack
aria-current="page"(added in 5.7), and from 5.5 down the top-navigation handling breaks. Note: Filament below 5.8.3 has published security advisories and Composer blocks those versions by default; the supported range is a compatibility range, not a security recommendation: run a patched Filament. - The Back link's collapsed-sidebar tooltip no longer depends on Filament's
filamentSidebarTooltiphelper (it only exists in newer versions); it uses the samex-tooltipdirective Filament's own items use. - The demo's Composer path repository pins a stable version, so
demo/composer.lockno longer goes stale when the Git branch changes.
Fixed
- Demo tests that made several requests in one app instance depended on Filament resetting its per-request state (newer versions do, 5.9 and older do not); every test request now starts like a real worker's.
Verified
- Filament clusters next to the plugin: a cluster shows up in the menu through
fromFilamentNavigation(), its pages render Filament's own sub-navigation beside the content, and its menu item stays current (4 tests).
v0.4.0
Fixes and 1.0-readiness work. Upgrade notes: requires Filament 5.10 or newer; run php artisan filament:assets (or filament:upgrade) so the new stylesheet is published.
Added
NavItem::activeWhen(fn () => …): marks an item current by any condition (route name, query string, React route), for pages the URL cannot place.- Collapsed sidebar fallback: a top-level item without an icon shows its initial instead of nothing.
- CI job on the lowest supported versions (
--prefer-lowest): package and demo. - Own header for a level:
NavItem::recordHeader(fn ($record) => view(...))for a record's menu and->header(...)for any item that opens a level replace the default Back link and title (a view renders as HTML, a string as text; the header gets the focus the title would). Demo: one task's menu. - Extra active URLs:
NavItem::activeOn([...])keeps an item current on pages under other URLs (matched like its own: by prefix, exact only for the panel root and ancestor URLs), e.g. a list at/agents/5/sourceswhose records open at/agents/5/knowledge/{id}.
Changed
- Filament's navigation stays intact outside the sidebar. The plugin used to empty the panel's navigation, which also emptied
->topNavigation()menus, breadcrumbs built from navigation, and anything else callingFilament::getNavigation(). Now only the sidebar's own list is hidden, via the plugin's sidebar componentDrilldownSidebar(or theHidesNativeNavigationtrait on your own). - Stylesheet is a Filament asset (
php artisan filament:assets) instead of an inline<style>block andstyle=""attributes: works with a strict Content-Security-Policy and can be overridden by a theme. - Requires Filament 5.10+ (was
^5.0): 5.9 and older fail the demo tests; 5.10 is the oldest version tested in CI. - Recent and pinned pages are stored per tenant too, and only entries under the current panel/tenant URL are shown (stored entries are also checked to be same-site paths).
->recent()and->pinnable()are marked experimental indocs/api-stability.md.
v0.3.0
New features, all opt-in: nothing changes unless you enable them.
Added
- Menu search:
->searchable(minItems: …): a filter box over what is on screen (current level and inline sections). A section stays visible when a child matches; headings hide while searching;Escclears. - Recent and pinned pages:
->recent($n),->pinnable(): lists at the top level plus a "Pin this page" toggle on every level, stored per browser, panel and user. - Long menus:
NavItem::limit($max, $moreUrl): first N children plus "View all (N)"; all children still take part in URL matching and the child containing the current page is never hidden. - Translations of the new strings in all 8 shipped languages.
CHANGELOG.md,docs/api-stability.md(public API, versioning policy, the 1.0 checklist),docs/vs-filament-native.md.
Changed
RequestState,ActivePathResolverandNativeNavigationare marked@internal.
Limits
Search covers only what is on screen; limit() shortens the display only (keep your query small); pinned/recent are per browser; how Filament clusters behave alongside the plugin is untested. See docs/api-stability.md for what 1.0 still needs.
v0.2.2
Translations and CI only; no change to the plugin's behaviour since v0.2.1.
- Arabic (
ar) translations of the plugin's strings; right-to-left layout checked in a browser (mirrored chevrons, Back arrow and slide animation). - Real Octane check in CI:
demo/bin/octane-smoke.shstarts a real one-worker server and runs 21 checks (two users, three panels, a record renamed between requests). CI runs it on RoadRunner, Swoole and FrankenPHP. - Docs updated (README, how-it-works, AGENTS, SKILLS).
Known limits: only one worker was tested (no load test); Arabic is the only RTL locale with shipped plugin strings; items without an icon show nothing in the collapsed sidebar.
v0.2.1
Demo and docs release; no package code changes since v0.2.0.
- The demo is now a realistic agency client portal: ~3,000 seeded rows (clients, projects, tasks, invoices, time entries), four roles (admin, manager, member, client), real count badges, and five menu levels (Projects > Project > Tasks > Task > Comments).
- 8 new tests on the seeded data: row counts, badge numbers, every table page, the five-level path, role menus, client data isolation, a query budget per page.
- README and screenshots refreshed; demo credentials per role documented.
Known limits are unchanged from v0.2.0.
v0.2.0
Highlights
Modern navigation
->inline()expands an item's children in place (chevron, guide lines, nesting, remembered state);->drilldown()keeps the signature behaviour;childDisplay(ChildDisplay::Inline)sets the panel default.NavItem::heading(),->divider(),->defaultExpanded(),->activeIcon().- Collapsed (icon-only) sidebar,
aria-expandedtoggles, focus moves to the level title, reduced-motion support.
Multi-panel, Octane, tenants, languages
- Per-request state (scoped binding): no stale record data or duplicated sidebars on long-lived workers.
- Panel-scoped hook: several panels with their own trees; panels without the plugin are untouched.
- Tenant, domain and sub-directory aware Home/Back URLs.
- Translations: en, zh_CN, zh_TW, zh_HK, ja, ko, es.
Fixed
- Stale record titles/children across requests on a reused worker.
- Sidebar rendered twice on a worker's second request.
- Crash on a panel without the plugin after another panel was served.
Quality
Pest (34), demo feature tests (38), Pint, PHPStan level 9 (no ignores). Worker reuse also checked with a real RoadRunner/Octane worker (by hand, not in CI).
Known limits
Items without an icon show nothing in the collapsed sidebar; RTL is CSS-only and untested; only RoadRunner tried for Octane. Not on Packagist (private repository).
v0.1.0
First release: drill-down sidebar navigation for Filament v5 (PHP 8.3+, Laravel 13).
Highlights
- One left sidebar, one level at a time, with a Back link and the section title; any depth.
- Menu per record:
NavItem::resource(XResource::class)->record(fn ($record) => [...]), including nested sub menus and nested resources. - Reuse Filament navigation:
NavItem::fromFilamentNavigation()imports$navigationGroup,$navigationParentItem, sort, badges andcanAccess(). NavItem::page()/NavItem::resource()/NavItem::make()->url()(any URL, e.g. React pages), badges, visibility, URL-less groups.- The level is computed from the URL on every request (no JS state); slide animation, dark mode and the mobile drawer work.
Quality
Pest (24), demo feature tests (12), Pint, PHPStan level 9 with no ignores; CI on a self-hosted runner.
Docs
README, docs/how-it-works.md (diagrams), AGENTS.md, SKILLS.md.
Known limits
Collapsed (icon-only) sidebar mode is not specially handled. Not on Packagist yet: install from the VCS repository (see README).
Install: composer config repositories.drilldown vcs https://github.com/solutionforest/filament-drilldown-nav && composer require solutionforest/filament-drilldown-nav:^0.1