Download the PHP package awcodes/overlook without Composer
On this page you can find all versions of the php package awcodes/overlook. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download awcodes/overlook
More information about awcodes/overlook
Files in awcodes/overlook
Package overlook
Short Description A Filament plugin that adds an app overview widget to your admin panel.
License MIT
Homepage https://github.com/awcodes/overlook
Informations about the package overlook
Overlook for Filament
A Filament plugin that adds an app overview widget to your admin panel.
Installation
You can install the package via composer:
In an effort to align with Filament's theming methodology you will need to use a custom theme to use this plugin.
Note If you have not set up a custom theme and are using a Panel follow the instructions in the Filament Docs first.
Add the plugin's views to your tailwind.config.js
file.
Usage
Add the plugin and widget to your panel provider. You may use the sort
and columns
methods on the plugin to change the widget order and number of columns the widget will use to display its items.
Including and Excluding Items
By default, the widget will display all resources registered with Filament. You can use either the includes
or excludes
methods on the plugin to specify which resources to include or exclude.
These methods should not be used together
Abbreviated Counts
You can disable abbreviated counts by passing false
the abbreviateCount
method on the plugin.
Tooltips
When using abbreviated counts a tooltip will show on hover with the non abbreviated count. You can disable them by passing false
the tooltips
method on the plugin.
Sorting the Items
By default, the items will be sorted in the order they are registered with Filament or as provided in the includes
method. You can change this to sort them alphabetically with the alphabetical
method on the plugin.
Customizing the Widget
By default, the overlook widget uses the getEloquentQuery()
method of the Filament Resource, but you can customize the query by implementing the CustomizeOverlookWidget
interface on the Filament Resource. The trait HandlesOverlookWidgetCustomization
predefines existing customization that can be overriden on the resource class.
Customize Widget Query
Override the getOverlookWidgetQuery()
method to customize the query for the Overlook Widget. This method takes in the existing eloquent query as a parameter that can be used to make further customization.
Customize Widget Title
Override the getOverlookWidgetTitle()
method to customize the title of the widget
Customize Widget Icon
By default, the icon will be loaded from the resource but you can override it by passing using the icons
modifier on the plugin and passing it an array of icon names and resource names.
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
- Adam Weston
- All Contributors
License
The MIT License (MIT). Please see License File for more information.
All versions of overlook with dependencies
ext-intl Version *
filament/filament Version ^3.0
spatie/laravel-package-tools Version ^1.15