Download the PHP package eightynine/filament-reports without Composer
On this page you can find all versions of the php package eightynine/filament-reports. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download eightynine/filament-reports
More information about eightynine/filament-reports
Files in eightynine/filament-reports
Package filament-reports
Short Description Elegant reports in your filament application
License MIT
Homepage https://github.com/eightynine/filament-reports
Informations about the package filament-reports
Elegant reports in your filament application
🛠️ Be Part of the Journey
Hi, I'm Eighty Nine. I created reports plugin to solve real problems I faced as a developer. Your sponsorship will allow me to dedicate more time to enhancing these tools and helping more people. Become a sponsor and join me in making a positive impact on the developer community.
Installation
Then you can install the package via composer:
You can publish the configuration using:
Usage
Register the plugin
Add the plugin to your panel service provider, this is for page discovery and adding the reports to the navigation
Create your first report
The package comes packed with a report creation command, this will create a report in the app/Filament/Reports
directory.
The command will create a report class with the following structure: ` The report has the following sections:
- Header
- Body
- Footer
- Filter Form
Header
The header is the top section of the report, it can be used to display a title, subtitle, image and a description. If the section is left empty, nothing will be displayed, but if you have a custom header for your report, this is where you can define it.
The header area has layouts that can be used to arrange items. The layouts are HeaderColumn
and HeaderRow
.
HeaderColumn
is a vertical layout, it will stack the items on top of each other. Items inside theHeaderColumn
can aligned vertically and horizontally, depending on how you wish to align the items.HeaderRow
is a horizontal layout, it will place the items next to each other. Items inside theHeaderRow
can be aligned vertically and horizontally, depending on how you wish to align the items.
The HeaderColumn
and HeaderRow
can be nested inside each other to create more complex layouts.
Apart from the Layouts, the header also has components that can be used to display data. The components are:
Text
- This is used to display text, it can be used to display a title or a subtitle, or with any styling you may prefer.Image
- This is used to display an image, it can be used to display a logo or any other image you may want to display.
Here is an example of the header section: `
Body
The body is the main section of the report, it can be used to display a table, chart or any other data. If the section is left empty, nothing will be displayed.
The body area has layouts that can be used to arrange items. The layouts are BodyColumn
and BodyRow
.
These behave the same as the HeaderColumn
and HeaderRow
but are used for the body section. But they are used specifically
for the body section, because they have different styling.
Apart from the Layouts, the body also has components that can be used to display data. The components are:
Table
- This is used to display a table, it can be used to display a list of data.VerticalSpace
- This is used to add vertical spacing between items.
The Text
and Image
components can also be used in the body section.
Here is an example of the body section:
Footer
The footer is the bottom section of the report, it can be used to display a title, subtitle, image and a description. It has layouts and components that behave the same as the header section.
The footer section has the Text
and Image
components, and the FooterColumn
and FooterRow
layouts.
Filter Form
The filter form is used to filter the data that is displayed in the report. The filter form uses the Filament form builder
so you can use any of the form components that are available in Filament. The form is displayed on the side of the report, and the
filter data will be available in all the tables data()
callback. This will be explained further in the below sections.
Example of a filter form:
Group rows
You can group a column in multiple rows, in order to show related data.
Please note, it is important to order by the column you wish to group the rows by, otherwise, there will be multiple groups
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
- Eighty Nine
- All Contributors
License
The MIT License (MIT). Please see License File for more information.
All versions of filament-reports with dependencies
filament/filament Version ^3.0
spatie/laravel-package-tools Version ^1.15.0
illuminate/contracts Version ^10.0|^11.0