PHPackages                             awcodes/overlook - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Admin Panels](/categories/admin)
4. /
5. awcodes/overlook

ActiveLibrary[Admin Panels](/categories/admin)

awcodes/overlook
================

A Filament plugin that adds an app overview widget to your admin panel.

v4.0.0(4mo ago)190190.3k↓30.6%173MITPHPPHP ^8.2CI passing

Since Mar 15Pushed 4w ago2 watchersCompare

[ Source](https://github.com/awcodes/overlook)[ Packagist](https://packagist.org/packages/awcodes/overlook)[ Docs](https://github.com/awcodes/overlook)[ GitHub Sponsors](https://github.com/awcodes)[ RSS](/packages/awcodes-overlook/feed)WikiDiscussions 4.x Synced 1w ago

READMEChangelog (10)Dependencies (9)Versions (30)Used By (3)

Overlook for Filament
=====================

[](#overlook-for-filament)

A Filament plugin that adds an app overview widget to your admin panel.

[![Latest Version](https://camo.githubusercontent.com/ae6a8ecc9f1f14a9f123eef092a725e4c7daa11cbd3d4a8bec5b02de3a2ecb5c/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f72656c656173652f6177636f6465732f6f7665726c6f6f6b2e7376673f7374796c653d666c61742d73717561726526636f6c6f723d626c7565266c6162656c3d52656c65617365)](https://github.com/awcodes/overlook/releases)[![MIT Licensed](https://camo.githubusercontent.com/a7e65aee57b11d28e4caff8b945729a66be0bb663f7f93bd24c5aa65699f148e/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f4c6963656e73652d4d49542d626c75652e7376673f7374796c653d666c61742d737175617265)](LICENSE.md)[![Total Downloads](https://camo.githubusercontent.com/717f7b51e0cfd7e4fdeff769450641179e8cb7c7e3a8834ead1641992fba1043/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f6177636f6465732f6f7665726c6f6f6b2e7376673f7374796c653d666c61742d73717561726526636f6c6f723d626c7565266c6162656c3d446f776e6c6f616473)](https://packagist.org/packages/awcodes/overlook)[![GitHub Repo stars](https://camo.githubusercontent.com/14eb67abbaccfe34d0349f422d31785a9dedc8e1efcda3ca1fff712ae74ecef1/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f73746172732f6177636f6465732f6f7665726c6f6f6b3f7374796c653d666c61742d73717561726526636f6c6f723d626c7565266c6162656c3d5374617273)](https://github.com/awcodes/overlook/stargazers)

Compatibility
-------------

[](#compatibility)

Package VersionFilament Version1.x2.x2.x3.x3.x4.x4.x5.xInstallation
------------

[](#installation)

You can install the package via composer:

```
composer require awcodes/overlook
```

Important

If you have not set up a custom theme and are using Filament Panels follow the instructions in the [Filament Docs](https://filamentphp.com/docs/4.x/styling/overview#creating-a-custom-theme) first.

After setting up a custom theme add the plugin's views to your theme css file.

```
@source '../../../../vendor/awcodes/overlook/resources/**/*.blade.php';
```

Usage
-----

[](#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.

```
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,
        ]);
}
```

Including and Excluding 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***

```
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,
                ]),
        ]);
}
```

Abbreviated Counts
------------------

[](#abbreviated-counts)

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),
        ]);
}
```

Tooltips
--------

[](#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.

```
use Awcodes\Overlook\OverlookPlugin;

public function panel(Panel $panel): Panel
{
    return $panel
        ->plugins([
            OverlookPlugin::make()
                ->tooltips(false),
        ]);
}
```

Excluding Soft Deleted Records
------------------------------

[](#excluding-soft-deleted-records)

If your models use soft deletes, you can exclude trashed records from the count with the `withoutTrashed` method on the plugin.

```
use Awcodes\Overlook\OverlookPlugin;

public function panel(Panel $panel): Panel
{
    return $panel
        ->plugins([
            OverlookPlugin::make()
                ->withoutTrashed(),
        ]);
}
```

Sorting the Items
-----------------

[](#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.

```
use Awcodes\Overlook\OverlookPlugin;

public function panel(Panel $panel): Panel
{
    return $panel
        ->plugins([
            OverlookPlugin::make()
                ->alphabetical(),
        ]);
}
```

Customizing the Widget
----------------------

[](#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.

```
use Awcodes\Overlook\Contracts\CustomizeOverlookWidget;
use Awcodes\Overlook\Concerns\HandlesOverlookWidgetCustomization;

class UserResource extends Resource implements CustomizeOverlookWidget
{
    use HandlesOverlookWidgetCustomization;
}
```

### Customize Widget Query

[](#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.

```
use Illuminate\Database\Eloquent\Builder;

public static function getOverlookWidgetQuery(Builder $query): Builder
{
    return $query->where('status','=','PENDING');
}
```

### Customize Widget Title

[](#customize-widget-title)

Override the `getOverlookWidgetTitle()` method to customize the title of the widget

```
public static function getOverlookWidgetTitle(): string
{
    return 'Pending Users';
}
```

### Customize Widget Icon

[](#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.

```
use Awcodes\Overlook\OverlookPlugin;

public function panel(Panel $panel): Panel
{
    return $panel
        ->plugins([
            OverlookPlugin::make()
                ->icons([
                    'heroicon-o-heart' => \App\Filament\Resources\Shop\ProductResource::class,
                    'heroicon-o-newspaper' => \App\Filament\Resources\Shop\OrderResource::class,
                ]),
        ]);
}
```

Changelog
---------

[](#changelog)

Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.

Contributing
------------

[](#contributing)

Please see [CONTRIBUTING](.github/CONTRIBUTING.md) for details.

Security Vulnerabilities
------------------------

[](#security-vulnerabilities)

Please review [our security policy](../../security/policy) on how to report security vulnerabilities.

Credits
-------

[](#credits)

- [Adam Weston](https://github.com/awcodes)
- [All Contributors](../../contributors)

License
-------

[](#license)

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.

###  Health Score

62

—

FairBetter than 99% of packages

Maintenance86

Actively maintained with recent releases

Popularity52

Moderate usage in the ecosystem

Community28

Small or concentrated contributor base

Maturity68

Established project with proven stability

 Bus Factor1

Top contributor holds 51.9% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~39 days

Total

30

Last Release

28d ago

Major Versions

1.x-dev → v2.0.0-alpha12023-07-05

v2.2.3 → v3.0.0-beta.12025-06-16

2.x-dev → v3.0.02025-08-12

3.x-dev → v4.0.02026-01-19

PHP version history (3 changes)v1.0.0PHP ^8.0

v1.0.1PHP ^8.1

v3.0.0-beta.1PHP ^8.2

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/3596800?v=4)[Adam Weston](/maintainers/awcodes)[@awcodes](https://github.com/awcodes)

---

Top Contributors

[![awcodes](https://avatars.githubusercontent.com/u/3596800?v=4)](https://github.com/awcodes "awcodes (68 commits)")[![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4)](https://github.com/dependabot[bot] "dependabot[bot] (22 commits)")[![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?v=4)](https://github.com/github-actions[bot] "github-actions[bot] (14 commits)")[![bmspereira-07](https://avatars.githubusercontent.com/u/9550269?v=4)](https://github.com/bmspereira-07 "bmspereira-07 (12 commits)")[![HassanZahirnia](https://avatars.githubusercontent.com/u/15275787?v=4)](https://github.com/HassanZahirnia "HassanZahirnia (4 commits)")[![abishekrsrikaanth](https://avatars.githubusercontent.com/u/1639302?v=4)](https://github.com/abishekrsrikaanth "abishekrsrikaanth (2 commits)")[![grafst](https://avatars.githubusercontent.com/u/8471055?v=4)](https://github.com/grafst "grafst (2 commits)")[![Saifallak](https://avatars.githubusercontent.com/u/6053156?v=4)](https://github.com/Saifallak "Saifallak (2 commits)")[![lamberttraccard](https://avatars.githubusercontent.com/u/4272598?v=4)](https://github.com/lamberttraccard "lamberttraccard (1 commits)")[![maaz1n](https://avatars.githubusercontent.com/u/46790922?v=4)](https://github.com/maaz1n "maaz1n (1 commits)")[![zvizvi](https://avatars.githubusercontent.com/u/4354421?v=4)](https://github.com/zvizvi "zvizvi (1 commits)")[![slizhva](https://avatars.githubusercontent.com/u/29979800?v=4)](https://github.com/slizhva "slizhva (1 commits)")[![imliam](https://avatars.githubusercontent.com/u/4326337?v=4)](https://github.com/imliam "imliam (1 commits)")

---

Tags

filamentfilament-pluginpluginlaravelfilamentawcodesoverlook

###  Code Quality

TestsPest

Static AnalysisRector

Code StyleLaravel Pint

### Embed Badge

![Health badge](/badges/awcodes-overlook/health.svg)

```
[![Health](https://phpackages.com/badges/awcodes-overlook/health.svg)](https://phpackages.com/packages/awcodes-overlook)
```

###  Alternatives

[awcodes/filament-quick-create

Plugin for Filament Admin that adds a dropdown menu to the header to quickly create new items.

249203.6k11](/packages/awcodes-filament-quick-create)[awcodes/filament-curator

A media picker plugin for FilamentPHP.

436333.6k24](/packages/awcodes-filament-curator)[rawilk/profile-filament-plugin

Profile & MFA starter kit for filament.

3913.7k](/packages/rawilk-profile-filament-plugin)[mradder/filament-logger

Audit logging, activity tracking, exports, alerts, and dashboards for Filament admin panels.

2210.5k](/packages/mradder-filament-logger)[stephenjude/filament-jetstream

A Laravel starter kit built with Filament inspired by Jetstream.

17758.9k2](/packages/stephenjude-filament-jetstream)[stephenjude/filament-two-factor-authentication

Filament Two Factor Authentication: Google 2FA + Passkey Authentication

84192.9k7](/packages/stephenjude-filament-two-factor-authentication)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)