Download the PHP package mortalkiller/filament-page-header without Composer
On this page you can find all versions of the php package mortalkiller/filament-page-header. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download mortalkiller/filament-page-header
More information about mortalkiller/filament-page-header
Files in mortalkiller/filament-page-header
Package filament-page-header
Short Description Opt-in, schema-based Filament page headers with responsive sticky and compact modes.
License MIT
Homepage https://github.com/mortalkiller/filament-page-header
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package filament-page-header
Filament Page Header
Build informative, responsive page headers with native Filament 4 and 5 schemas. Combine identity, status, metadata and page actions, then choose what stays visible while scrolling.
Enable headers only on the panels and pages you choose. No custom theme build, application-specific models or required icon library.
Documentation
Full documentation, guides and API reference:
https://docs.pedromonteiro.dev/filament-page-header/
- Getting started
- Configuration guide
- Native action control
- API reference
Contents
- Documentation
- Features
- Screenshots
- Version compatibility
- Installation
- Generator
- Your first header
- Configuration
- Native page actions
- Header navigation
- Sticky and compact modes
- Migration from v1
- Troubleshooting
- Testing and contributing
- Changelog
- Roadmap
- Security
- Support this project
- Credits and license
Features
- Headings, descriptions, badges, avatars, initials and product images.
- Native schema fields for metadata and summary metrics, with responsive separators.
- Field icons before or after the complete label/value, with configurable size.
- Native page actions with Start, End and Below positions and a full-width mobile layout.
- Breadcrumb positioning and optional native page/record sub-navigation inside the header.
- Normal, sticky and compact layouts, with configurable responsive thresholds.
- Typed compact configuration: keep entire blocks, select fields, or include/exclude native actions by name.
- Native light/dark colors, keyboard focus handling and reduced-motion support.
- Shared resource schemas, with individual page overrides.
- Artisan generator for conventional header schemas and Resource page setup.
Screenshots
Real captures of the package's product demo: a product image, two actions and three information fields. The example uses fictional product data, English labels and a native indigo/gray palette. The product image and banner are illustrative assets; the header itself is rendered by Filament. Native action colors follow your panel configuration.
| Layout | Light | Dark |
|---|---|---|
| Desktop | ||
| Compact after scrolling | ||
| Mobile |
Run the demo locally to explore the layouts and native actions.
Version compatibility
This README documents 2.x. Package major versions identify this package's API; they do not correspond to Filament major versions.
| Package version | Filament requirement | PHP requirement | Laravel | API |
|---|---|---|---|---|
^2.0 |
^4.12.6 \|\| ^5.8.1 |
^8.3 |
12 or 13 | Header, MetadataEntry, typed compact configuration |
^1.0 |
^5.8.1 |
^8.3 |
12 or 13 | Previous HeaderLayout API |
Version 2 runs its PHP suite against the minimum secure Filament 4 release (4.12.6), the latest release resolved by ^4.12.6, the minimum Filament 5 release (5.8.1) and the latest release resolved by ^5.8.1, across Laravel 12 and 13, including PHP 8.5 on the latest dependency boundaries. The Chromium suite runs on the minimum supported Filament 4 release and the latest release resolved by ^5.8.1. Versions before 4.12.6 are outside the declared requirement; Composer specifically blocks 4.0.0 and 4.12.0–4.12.5 because of known security advisories. Filament 5.0–5.8.0 is also outside the declared requirement and has not been validated. Other Filament majors are outside these releases' requirements. PHP must also satisfy your selected Laravel version's requirements.
See the 1.x README for the previous API and the security policy.
Installation
1. Install the package
2. Publish Filament assets
The service provider is discovered automatically. There are no package migrations to run and no custom theme build is required.
3. Register the plugin
Add the plugin to the intended panel's existing configuration:
Register it separately for each panel that needs custom headers, then add the page trait as shown below. Installation alone does not replace existing headers.
Generator
For an existing Filament Resource, generate the conventional header schema and choose which standard Resource pages should use it:
For explicit or non-interactive usage:
Use --no-pages to generate only the schema and --force to deliberately replace an existing generated schema. Repeated runs do not duplicate HasPageHeader imports or trait declarations.
See the generator guide for page selection, multi-panel applications, existing schemas and supported page types.
Your first header
For an existing CustomerResource, add HasPageHeader and headerSchema() to its Edit page. This example assumes the model has name and email attributes; retain your page's existing methods and actions.
The trait also works with Create, View, List and custom pages. Use nullable record closures where no record exists. Header::make() inherits the page heading and subheading by default and does not change the browser tab title. By default, the header schema uses the page's current Resource record; override getPageHeaderRecord() for tenant, parent, singleton, custom-model or array-backed contexts.
Configuration
Use native Filament entries for content and keep business logic in your application. The package handles layout, images, spacing and light/dark appearance.
| Configure | API | Guide |
|---|---|---|
| Identity | heading(), description(), avatar(), image(), initials(), icon(), initialsBgColor(), initialsTextColor(), iconBgColor(), iconColor() |
Images and icons |
| Badges and details | badges(), metadata(), summary() |
Layout slots |
| Native actions | actionsPosition(), compact actions() / hideActions() |
Native action control |
| Field icons | fieldIcon(), fieldIconPosition(), fieldIconSize() |
Metadata fields |
| Product identity | image() and descriptionSchema() |
Product example |
| Reusable resource headers | Convention discovery or schemaFor() |
Shared configuration |
| Record/context | getPageHeaderRecord() |
Custom record contexts |
| Custom composition | headingSchema(), leading(), schema() |
Layout slots |
Native getHeaderActions() continues to define the page actions. They render once, at the logical end on desktop by default and after the details on mobile. Native button groups, modals, form targets and authorization remain in place. Breadcrumbs sit outside the card and scroll with the page by default. Configure their position and native sub-navigation when needed.
Color an initials fallback with a panel color alias or a native Filament palette. The text color is chosen for contrast unless you override it:
See Images and icons for imports, closures and fallback behavior.
For a resilient identity, configure image, initials and an icon together. The header renders one visual in this order: custom leading() content, a resolved avatar/image, initials, then icon().
Native page actions
Position the action block and choose which native action names remain in compact mode:
The example assumes those actions already exist in the page's getHeaderActions(). Positions are Start, End (default), and Below. Mobile keeps the existing full-width action area.
Use hideActions(['delete', 'duplicate']) instead for exclusion. The last selection call wins. actions([]) hides all native actions in compact mode, while hideActions([]) keeps all. Without action configuration, existing headers retain every action allowed by Filament.
Selection preserves native order and nested groups, removes empty compact groups, and keeps render hooks and active interactions intact. It does not replace server-side authorization or filter normal/sticky presentation. Read the complete action guide, including teleported dropdowns, forms and focus handling.
Header navigation
Keep Filament's breadcrumbs outside the card (the default), place them inside, or hide them:
Move existing native Page/Resource sub-navigation into the header with subNavigation(). Desktop uses Filament's horizontal tabs; mobile uses its dropdown. URLs, authorization, active state and SPA navigation stay native. No navigation is created if the page has none.
Inside breadcrumbs and sub-navigation hide when compact unless explicitly retained. Retained outside breadcrumbs remain outside the card but join the pinned header; otherwise they scroll with the page as before. Navigation supports show(), not only() field selection. Hidden and panel-level breadcrumb disabling remain authoritative.
subNavigation() integrates route navigation such as getRecordSubNavigation() and ManageRelatedRecords pages. Relation Manager tabs remain in the page content, including combined content tabs and their Before/After ordering. Without subNavigation(), Filament keeps its original Start/End/Top layout.
See Navigation configuration for details.
Sticky and compact modes
Set a default on the panel plugin:
You can also call normal(), sticky() or compact() on an individual Header. Call compactBelow() after selecting the base mode; its threshold is exclusive.
By default, compact mode keeps the heading, image/avatar, badges and native page actions. Choose optional content explicitly with enums:
Use this on a header whose metadata includes reference. Each whenCompact() callback starts with no optional blocks selected. The heading always remains; native page actions remain unless you configure actions() or hideActions(). Native visibility and authorization still apply. Scrolling does not duplicate actions or send Livewire requests.
Full compact configuration, offsets and responsive rules.
Migration from v1
Version 2 replaces HeaderLayout with Header and introduces a new composition API. Update consuming schemas and publish the assets again when upgrading.
Follow the local path and symlink workflow; keep your application's global stability unchanged.
Troubleshooting
| Symptom | Check |
|---|---|
| The native header still appears | Register the plugin on the active panel, add HasPageHeader to the page and return a non-empty schema. A page's own getHeader() method takes precedence. |
| Styling or scrolling behavior is outdated | Run php artisan filament:assets in the consuming application after updating the package, then reload. A Composer symlink does not refresh published assets. |
| The header does not stick | Enable sticky() or compact(). Check the real scroll container, short parent wrappers and ancestor overflow. Pinning is temporarily disabled when the header cannot fit the viewport. |
whenCompact() has no visible effect |
Enable compact() on the header or plugin, then scroll to the sticky edge. The callback selects content; it does not activate compaction. |
| A selected compact field disappears | Match its entry name or layout key, and check native visibility conditions. Selection covers direct fields, not nested descendants. |
| A selected compact action is missing | Use its native action name, not its label. Check native visibility and authorization; selection never overrides them. |
Advanced layout and offset configuration.
Testing and contributing
See CONTRIBUTING for branch conventions, checks and pull requests. The package has an independent workbench and does not require a consuming application's database.
Changelog
See GitHub Releases for published versions and release notes.
Roadmap
See the project roadmap for planned improvements, along with the package's scope and design principles.
Security
Please report vulnerabilities privately using the process in SECURITY.md. Use GitHub Issues for ordinary bugs and feature requests.
Heading and description text are escaped by default. Enable html: true only for trusted markup prepared by your application. Native visibility is not an authorization boundary; keep permission checks on the server.
The Plumb badges display the latest external assessment, which may lag behind repository changes. They are not a security audit or a guarantee that the package has no vulnerabilities.
Support this project
If this package saves you time, consider supporting its development. Your support helps maintain the package and improve its documentation.
Credits and license
- Pedro Monteiro (MortalKiller)
- All contributors
- Inspired by Vitis Studio's Filament Header Schema.
- Built on Filament. See third-party notices.
Licensed under the MIT license.
All versions of filament-page-header with dependencies
filament/filament Version ^4.12.6 || ^5.8.1
illuminate/support Version ^12.0 || ^13.0