A Filament plugin that adds an app overview widget to your admin panel.
You can install the package via composer:
composer require awcodes/overlookAdd 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.
use Awcodes\Overlook\OverlookPlugin;
use Awcodes\Overlook\Widgets\OverlookWidget;
public function panel(Panel $panel): Panel
{
return $panel
->plugins([
OverlookPlugin::make()
->sort(2)
->columns([
'default' => 1,
'sm' => 2,
'md' => 3,
'lg' => 4,
'xl' => 5,
'2xl' => null,
]),
])
->widgets([
OverlookWidget::class,
]);
} 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
use Awcodes\Overlook\OverlookPlugin;
public function panel(Panel $panel): Panel
{
return $panel
->plugins([
OverlookPlugin::make()
->includes([
\App\Filament\Resources\Shop\ProductResource::class,
\App\Filament\Resources\Shop\OrderResource::class,
]),
]);
} use Awcodes\Overlook\OverlookPlugin;
public function panel(Panel $panel): Panel
{
return $panel
->plugins([
OverlookPlugin::make()
->excludes([
\App\Filament\Resources\Shop\ProductResource::class,
\App\Filament\Resources\Shop\OrderResource::class,
]),
]);
} You can disable abbreviated counts by passing false the abbreviateCount method on the plugin.
use Awcodes\Overlook\OverlookPlugin;
public function panel(Panel $panel): Panel
{
return $panel
->plugins([
OverlookPlugin::make()
->abbreviateCount(false),
]);
} 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.
use Awcodes\Overlook\OverlookPlugin;
public function panel(Panel $panel): Panel
{
return $panel
->plugins([
OverlookPlugin::make()
->tooltips(false),
]);
}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.
use Awcodes\Overlook\OverlookPlugin;
public function panel(Panel $panel): Panel
{
return $panel
->plugins([
OverlookPlugin::make()
->alphabetical(),
]);
} If you are using a custom theme with Filament you will want to disable loading the css file and add its styles to your custom theme.
You will also need to install tippy.js and include the styles for tippy.js if you have not already done so.
npm i -D tippy.jsuse Awcodes\Overlook\OverlookPlugin;
public function panel(Panel $panel): Panel
{
return $panel
->plugins([
OverlookPlugin::make()
->disableCss(),
]);
} In your theme's stylesheet add the following:
@import '<path-to-vendor>/awcodes/overlook/resources/dist/overlook.css';
@import '<path-to-node-modules>/tippy.js/dist/tippy.css';Please see CHANGELOG for more information on what has changed recently.
Please see CONTRIBUTING for details.
Please review our security policy on how to report security vulnerabilities.
The MIT License (MIT). Please see License File for more information.